| Package | ga.model |
| Interface | public interface ILayoutHost extends IUIComponent , IEventDispatcher , IStyleClient , IFlexDisplayObject , ISimpleStyleClient , IBitmapDrawable , IEventDispatcher |
| Implementors | LayoutTemplate |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | IFlexDisplayObject | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | IFlexDisplayObject | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | IUIComponent | |
| baseReferenceChain : BaseReferenceChain [read-only]
The chain of bindings up the ancestor chain. | ILayoutHost | ||
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | IFlexDisplayObject | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | IFlexDisplayObject | |
| className : String [read-only]
The name of the component class. | IStyleClient | |
| dataProvider : Object
The data provider that is bound to this panel layout. | ILayoutHost | ||
| defaultCaptionWidth : int
The default caption width for each panel item within a panel layout. | ILayoutHost | ||
| document : Object
A reference to the document object associated with this component. | IUIComponent | |
| enabled : Boolean
Whether the component can accept user interaction. | IUIComponent | |
| explicitHeight : Number
The explicitly specified height for the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMaxHeight : Number [read-only]
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMaxWidth : Number [read-only]
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMinHeight : Number [read-only]
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMinWidth : Number [read-only]
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitWidth : Number
The explicitly specified width for the component,
in pixels, as the component's coordinates. | IUIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | IFlexDisplayObject | |
| focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing the focus indicator. | IUIComponent | |
| height : Number
Indicates the height of the display object, in pixels. | IFlexDisplayObject | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | IUIComponent | |
| inheritingStyles : Object
An object containing the inheritable styles for this component. | IStyleClient | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | IUIComponent | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | IFlexDisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | IFlexDisplayObject | |
| maxHeight : Number [read-only]
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| maxWidth : Number [read-only]
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| measuredHeight : Number [read-only]
The measured height of this object. | IFlexDisplayObject | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | IUIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | IUIComponent | |
| measuredWidth : Number [read-only]
The measured width of this object. | IFlexDisplayObject | |
| minHeight : Number [read-only]
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| minWidth : Number [read-only]
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | IFlexDisplayObject | |
| nonInheritingStyles : Object
An object containing the noninheritable styles for this component. | IStyleClient | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | IFlexDisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | IUIComponent | |
| panel : Panel
the parent panel of the layout. | ILayoutHost | ||
| panelItems : Array
An array of panel items that are slotted into the panel layout. | ILayoutHost | ||
| parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | IFlexDisplayObject | |
| percentHeight : Number
Number that specifies the height of a component as a
percentage of its parent's size. | IUIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a
percentage of its parent's size. | IUIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | IFlexDisplayObject | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | IFlexDisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | IFlexDisplayObject | |
| scaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point. | IFlexDisplayObject | |
| scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | IFlexDisplayObject | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | IFlexDisplayObject | |
| sizeState : int
The size state of this panel in the Guide layout. | ILayoutHost | ||
| stage : Stage [read-only]
The Stage of the display object. | IFlexDisplayObject | |
| styleDeclaration : CSSStyleDeclaration
The style declaration that holds the inline styles declared by this
object. | IStyleClient | |
| styleName : Object
The source of this object's style values. | ISimpleStyleClient | |
| supportsDynamicAlignmentAreas : Boolean [read-only]
Indicates that this layout supports a dynamic number of alignment areas. | ILayoutHost | ||
| supportsKeepWithPrevious : Boolean [read-only]
Indicates that this layout supports the keep with previous hint on a panel item. | ILayoutHost | ||
| systemManager : ISystemManager
A reference to the SystemManager object for this component. | IUIComponent | |
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | IFlexDisplayObject | |
| tweeningProperties : Array
Used by EffectManager. | IUIComponent | |
| visible : Boolean
Whether or not the display object is visible. | IFlexDisplayObject | |
| width : Number
Indicates the width of the display object, in pixels. | IFlexDisplayObject | |
| x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | IFlexDisplayObject | |
| y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | IFlexDisplayObject | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | IEventDispatcher | |
|
Deletes a style property from this component instance. | IStyleClient | |
Clone this panel layout. | ILayoutHost | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
Execute all bindings within this panel layout. | ILayoutHost | ||
Returns all display objects on this panel. | ILayoutHost | ||
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | IFlexDisplayObject | |
|
Returns an Array of CSSStyleDeclaration objects for the type selector
that applies to this component, or null if none exist. | IStyleClient | |
|
A convenience method for determining whether to use the
explicit or measured height
| IUIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| IUIComponent | |
Returns the bound visible fields which are referenced in this layout. | ILayoutHost | ||
Returns the first panel item in the panel layout. | ILayoutHost | ||
Get label corresponding to the index in the data provider. | ILayoutHost | ||
Return an array of name areas or groups that this layout supports. | ILayoutHost | ||
getPanelItems(visibleItemsOnly:Boolean = false, container:DisplayObjectContainer = null, itemList:Array = null):Array
Returns the panel items contained in the panel layout. | ILayoutHost | ||
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | IFlexDisplayObject | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | IStyleClient | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | IFlexDisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | IFlexDisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | IFlexDisplayObject | |
|
Initialize the object. | IUIComponent | |
True if this is a panel containing is a document of record. | ILayoutHost | ||
True if this is a panel containing a PDF rendition. | ILayoutHost | ||
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | IFlexDisplayObject | |
|
Moves this object to the specified x and y coordinates. | IFlexDisplayObject | |
|
Propagates style changes to the children of this component. | IStyleClient | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | IUIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | IUIComponent | |
|
Sets up the internal style cache values so that the getStyle()
method functions. | IStyleClient | |
|
Registers the EffectManager as one of the event listeners for each effect event. | IStyleClient | |
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Resets the fields in a container. | ILayoutHost | ||
|
Sets the actual size of this object. | IFlexDisplayObject | |
set the selected panel on this layout. | ILayoutHost | ||
|
Sets a style property on this component instance. | IStyleClient | |
|
Called when the visible property changes. | IUIComponent | |
|
Called when the value of a style property is changed. | ISimpleStyleClient | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Property Detail
baseReferenceChain | property |
baseReferenceChain:BaseReferenceChain [read-only] | 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 chain of bindings up the ancestor chain. Items in the panel will bind relative to a base reference in the ancestor chain. If the item binding is not relative to any base references in the ancestor chain it will be bind using the absolute address.
Implementation
public function get baseReferenceChain():BaseReferenceChaindataProvider | property |
dataProvider:Object| 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 data provider that is bound to this panel layout. Can be a single instance or a collection/instanceManager.
Implementation
public function get dataProvider():Object public function set dataProvider(value:Object):voiddefaultCaptionWidth | property |
defaultCaptionWidth:int| 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 default caption width for each panel item within a panel layout.
Implementation
public function get defaultCaptionWidth():int public function set defaultCaptionWidth(value:int):voidpanel | property |
panel:Panel| 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 parent panel of the layout.
Implementation
public function get panel():Panel public function set panel(value:Panel):voidpanelItems | property |
panelItems:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
An array of panel items that are slotted into the panel layout.
Implementation
public function get panelItems():Array public function set panelItems(value:Array):voidsizeState | property |
sizeState:int| 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 size state of this panel in the Guide layout. This determines whether or not a panel is displayed full screen. 0 - display the panel normal size along with the panel navigator. non-zero - display the panel full screen.
Implementation
public function get sizeState():int public function set sizeState(value:int):voidsupportsDynamicAlignmentAreas | property |
supportsDynamicAlignmentAreas:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Indicates that this layout supports a dynamic number of alignment areas. This is queried by guide builder and is a design time parameter. When dynamic alignment areas are supported the designer will automatically create a new alignment area when the last alignment area is used.
Implementation
public function get supportsDynamicAlignmentAreas():BooleansupportsKeepWithPrevious | property |
supportsKeepWithPrevious:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Indicates that this layout supports the keep with previous hint on a panel item. This is queried by guide builder and is a design time parameter. When keep with previous is supported the layout will position a panel item with keep with previous set to the right of the last panel item added to the layout.
Implementation
public function get supportsKeepWithPrevious():BooleanMethod Detail
clone | () | method |
executeBindings | () | method |
public function executeBindings(recurse:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Execute all bindings within this panel layout.
Parameters
recurse:Boolean (default = false) |
getAllItems | () | method |
public function getAllItems(container:DisplayObjectContainer = null, itemList:Array = null):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Returns all display objects on this panel. Recursively searches through all DisplayObjectContainers inside this panel.
Parameters
container:DisplayObjectContainer (default = null) | |
itemList:Array (default = null) |
Array — the array containing all display objects.
|
getFields | () | method |
public function getFields(visibleFieldsOnly:Boolean = false, container:DisplayObjectContainer = null):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Returns the bound visible fields which are referenced in this layout.
Parameters
visibleFieldsOnly:Boolean (default = false) | |
container:DisplayObjectContainer (default = null) |
Array — The array of fields
|
getFirstPanelItem | () | method |
public function getFirstPanelItem(oContainer:DisplayObjectContainer = null):IPanelItem| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Returns the first panel item in the panel layout.
Parameters
oContainer:DisplayObjectContainer (default = null) |
IPanelItem — the first panel item
|
getLabelAt | () | method |
public function getLabelAt(index:int):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 |
Get label corresponding to the index in the data provider.
Parameters
index:int — - index into the data provider
|
String — the label.
|
getNamedAreas | () | method |
public function getNamedAreas():Array| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Return an array of name areas or groups that this layout supports. This is queried by guide builder and is a design time parameter.
ReturnsArray — array of named areas for this layout
|
getPanelItems | () | method |
public function getPanelItems(visibleItemsOnly:Boolean = false, container:DisplayObjectContainer = null, itemList:Array = null):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Returns the panel items contained in the panel layout. This include all components implementing the IPanelItem interface. which include PanelItem (interactive controls) and PanelText (static text).
Parameters
visibleItemsOnly:Boolean (default = false) | |
container:DisplayObjectContainer (default = null) | |
itemList:Array (default = null) |
Array — The array of panel items.
|
isDocPanel | () | method |
public function isDocPanel():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 |
True if this is a panel containing is a document of record.
ReturnsBoolean — Boolean indicating whether or not this is a document of record panel.
|
isPDFPanel | () | method |
public function isPDFPanel():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 |
True if this is a panel containing a PDF rendition.
ReturnsBoolean — Boolean indicating whether or not this is a PDF panel.
|
resetData | () | method |
public function resetData(container:DisplayObjectContainer = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Resets the fields in a container. This function also resets data in the nested layouts if there are any. This is only used when the submitAll option is false, some customers need the ability to clear the data from a hidden field, as they have legal restructions that data from non-visible fields can never be submitted.
Parameters
container:DisplayObjectContainer (default = null) |
setSelectedPanelItem | () | method |
public function setSelectedPanelItem(item:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
set the selected panel on this layout.
Parameters
item:Object — the selected panel item.
|
Mon Apr 10 2017, 12:28 PM -07:00