ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.guides.control 

IGuideDisplay  - AS3 ADEP Guides

Packagecom.adobe.guides.control
Interfacepublic interface IGuideDisplay

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 10
Runtime Versions: AIR 1.0, Flash Player 10.2

The IGuideDisplay interface provides access to properties which control the visual composition of the guide. "stylePath" overrides the style swf that the guide was designed with. "systemConfig" overrides the configuration mapping. Can be either a path or an xml string. "resizeToContent" when set to true will cause the Guide to pack itself to take a minimal amount of space. When set to false, the Guide will attempt to take as much space as the parent component gives it.



Public Properties
 PropertyDefined By
  resizeToContent : Boolean
When set to true, the Guide will size it self to the content of the Guide.
IGuideDisplay
  stylePath : String
The path to the style asset which will be loaded by the Guide.
IGuideDisplay
  systemConfig : String
The System Configuration which must be a valid xml string defines the systems component mapping.
IGuideDisplay
Property Detail

resizeToContent

property
resizeToContent:Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 10
Runtime Versions: AIR 1.0, Flash Player 10.2

When set to true, the Guide will size it self to the content of the Guide. When false, the Guide will take up 100% width and height.



Implementation
    public function get resizeToContent():Boolean
    public function set resizeToContent(value:Boolean):void

stylePath

property 
stylePath:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 10
Runtime Versions: AIR 1.0, Flash Player 10.2

The path to the style asset which will be loaded by the Guide. The stylePath can be either a local resource or a http based url.



Implementation
    public function get stylePath():String
    public function set stylePath(value:String):void

systemConfig

property 
systemConfig:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 10
Runtime Versions: AIR 1.0, Flash Player 10.2

The System Configuration which must be a valid xml string defines the systems component mapping.



Implementation
    public function get systemConfig():String
    public function set systemConfig(value:String):void