| Package | com.adobe.guides.spark.layouts.components |
| Interface | public interface ILayoutComponent extends ILayoutHost , IUIComponent , IEventDispatcher , IStyleClient , IFlexDisplayObject , ISimpleStyleClient |
| Implementors | LayoutHostBase |
| 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 | |
| nextTabIndex : int [write-only]
Set the next tab index to be used by the tab index generator. | ILayoutComponent | ||
| 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 | |
instantiate the itemFactory and add it to the specified group
| ILayoutComponent | ||
instantiate the itemFactories and add them to the specified group. | ILayoutComponent | ||
addItemsToGroups(groups:Array, itemFactories:Array, startTabIndex:int = -1, tabIncrement:int = 0):int
Add items alternating between the specified groups, incremented the tab indexes. | ILayoutComponent | ||
Aligns each row in a multi-column layout by making each item in each row the same height. | ILayoutComponent | ||
|
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 | |
return the item factories for a specified area index
| ILayoutComponent | ||
|
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 | |
Determine if the factory that was created for design mode and is running inside the guide builder canvas. | ILayoutComponent | ||
|
True if this is a panel containing is a document of record. | ILayoutHost | |
|
True if this is a panel containing a PDF rendition. | ILayoutHost | |
Return the panelItems split into arrays based on how the list has been delimited with panel breaks. | ILayoutComponent | ||
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | IFlexDisplayObject | |
Align each child with same same child index to be the same height. | ILayoutComponent | ||
|
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 | |
Reset the nextTabIndex. | ILayoutComponent | ||
|
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
nextTabIndex | property |
nextTabIndex:int [write-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 |
Set the next tab index to be used by the tab index generator.
Implementation
public function set nextTabIndex(value:int):voidMethod Detail
addItem | () | method |
public function addItem(group:Group, itemFactory:IFactory):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 |
instantiate the itemFactory and add it to the specified group
Parameters
group:Group — the group where the item is added
| |
itemFactory:IFactory — the factory to be instantiated and added
|
IPanelItem — the panel item that was added
|
addItemsToGroup | () | method |
public function addItemsToGroup(group:Group, itemFactories:Array):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 |
instantiate the itemFactories and add them to the specified group.
Parameters
group:Group — - group to add the instantiated items.
| |
itemFactories:Array — - the item factories to be instantiated.
|
addItemsToGroups | () | method |
public function addItemsToGroups(groups:Array, itemFactories:Array, startTabIndex:int = -1, tabIncrement:int = 0):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 |
Add items alternating between the specified groups, incremented the tab indexes. The routine returns the next tab index to be used in subsequent calls.
Parameters
groups:Array — where the items are alternately added.
| |
itemFactories:Array — the factories for the items to instantiated and added to the groups.
| |
startTabIndex:int (default = -1) | |
tabIncrement:int (default = 0) |
int — - the next tab index.
|
alignHorizontalGroupContent | () | method |
public function alignHorizontalGroupContent(outerGroup:Group):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 |
Aligns each row in a multi-column layout by making each item in each row the same height.
Parameters
outerGroup:Group — - the outer container of a series of HGroup containers.
|
getItemFactoriesForArea | () | method |
public function getItemFactoriesForArea(areaIndex:int):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 the item factories for a specified area index
Parameters
areaIndex:int — - index of the area or group.
|
Array — the array of panel item factories for the specified area.
|
isDesignItem | () | method |
public function isDesignItem(oFactory:Object):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 |
Determine if the factory that was created for design mode and is running inside the guide builder canvas.
Parameters
oFactory:Object — Specifies the factory of the item to be introspected.
|
Boolean — A boolean value that specifies whether or not this item or item factory is a design item. A value of true is returned when the factory was created for design mode.
|
itemsToAreas | () | method |
public function itemsToAreas():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 the panelItems split into arrays based on how the list has been delimited with panel breaks. The return is an array of arrays. For example the first element of the array is an array of items for the first area.
ReturnsArray — the items broken into a series of arrays, one array for each area.
|
makeSameHeight | () | method |
public function makeSameHeight(oContainers:Array):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 |
Align each child with same same child index to be the same height.
Parameters
oContainers:Array — - make each container in the array the height of the largest container.
|
resetNextTabIndex | () | method |
public function resetNextTabIndex():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 |
Reset the nextTabIndex.
Mon Nov 28 2011, 06:48 AM -08:00