| Package | com.adobe.guides.spark.layouts.components |
| Class | public class LayoutHostBase |
| Inheritance | LayoutHostBase  NavigatorContent SkinnableContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | ILayoutComponent |
| Subclasses | ChartLayoutHost, RepeaterLayoutHost, SingleGroupLayoutHost, VariableGroupLayoutHost |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
LayoutHostBase class is the base class for all Skinnable Guide panel layouts.
The class holds a list of panel item factories which it can instantiate and place into containers in the skin.
The properties for PanelItem when acting as a placeholder slot in a LayoutHostBase
<ga:LayoutHostBase Properties dataProvider="" panelItems="[..]" >
Default MXML PropertymxmlContentFactory
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| autoLayout : Boolean
If true, measurement and layout are done
when the position or size of a child is changed. | SkinnableContainer | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [override] [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | SkinnableComponent | |
| baseReferenceChain : BaseReferenceChain [read-only]
The chain of bindings up the ancestor chain. | LayoutHostBase | ||
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| creationPolicy : String
Content creation policy for this component. | SkinnableContainer | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| dataProvider : Object
The data provider that is bound to this panel layout. | LayoutHostBase | ||
| defaultButton : IFlexDisplayObject
The Button control designated as the default button for the container. | SkinnableContainerBase | |
| defaultCaptionWidth : int
The default caption width for each panel item within a panel layout. | LayoutHostBase | ||
| deferredContentCreated : Boolean [read-only]
Contains true if deferred content has been created. | SkinnableContainer | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| icon : Class
The Class of the icon displayed by some navigator
containers to represent this Container. | NavigatorContent | |
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| label : String
The text displayed by some navigator containers to represent
this Container. | NavigatorContent | |
| layout : LayoutBase
The layout object for this container. | SkinnableContainer | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mxmlContent : Array [write-only]
The visual content children for this Group. | SkinnableContainer | |
| mxmlContentFactory : IDeferredInstance [write-only]
A factory object that creates the initial value for the
content property. | SkinnableContainer | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nextTabIndex : int
Set the next tab index to be used by the tab index generator. | LayoutHostBase | ||
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numElements : int [read-only]
The number of visual elements in this container. | SkinnableContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| panel : Panel [read-only]
the parent panel of the layout. | LayoutHostBase | ||
| panelItems : Array
An array of panel items that are slotted into the panel layout. | LayoutHostBase | ||
| panelType : int = 0
The panel type of this panel in the Guide layout. | LayoutHostBase | ||
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| 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. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| sizeState : int
The size state of this panel in the Guide layout. | LayoutHostBase | ||
| skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | |
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| suggestedFocusSkinExclusions : Array [read-only]
Lists the skin parts that are
excluded from bitmaps captured and used to
show focus. | SkinnableComponent | |
| supportsDynamicAlignmentAreas : Boolean [read-only]
Indicates that this layout supports a dynamic number of alignment areas. | LayoutHostBase | ||
| supportsKeepWithPrevious : Boolean [read-only]
Indicates that this layout supports the keep with previous hint on a panel item. | LayoutHostBase | ||
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
|
Adds a visual element to this container. | SkinnableContainer | |
|
Adds a visual element to this container. | SkinnableContainer | |
| 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. | EventDispatcher | |
instantiate the itemFactory and add it to the specified group
| LayoutHostBase | ||
instantiate the itemFactories and add them to the specified group. | LayoutHostBase | ||
addItemsToGroups(groups:Array, itemFactories:Array, startTabIndex:int = -1, tabIncrement:int = 0):int
Add items alternating between the specified groups, incremented the tab indexes. | LayoutHostBase | ||
|
Adds a non-visual style client to this component instance. | UIComponent | |
Aligns each row in a multi-column layout by making each item in each row the same height. | LayoutHostBase | ||
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
Clone this panel layout. | LayoutHostBase | ||
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Create the content for this component. | SkinnableContainer | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
Returns all display objects on this panel. | LayoutHostBase | ||
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
Returns the visual element at the specified index. | SkinnableContainer | |
|
Returns the index position of a visual element. | SkinnableContainer | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
Returns the bound visible fields which are referenced in this layout. | LayoutHostBase | ||
Returns the first panel item in the panel layout. | LayoutHostBase | ||
|
Gets the object that currently has focus. | UIComponent | |
return the item factories for a specified area index
| LayoutHostBase | ||
Get label corresponding to the index in the data provider. | LayoutHostBase | ||
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
Return an array of name areas or groups that this layout supports. | LayoutHostBase | ||
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
getPanelItems(visibleItemsOnly:Boolean = false, container:DisplayObjectContainer = null, itemList:Array = null):Array
Returns the panel items contained in the panel layout. | LayoutHostBase | ||
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
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. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | |
Determine if the factory that was created for design mode and is running inside the guide builder canvas. | LayoutHostBase | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Return the panelItems split into arrays based on how the list has been delimited with panel breaks. | LayoutHostBase | ||
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
Align each child with same same child index to be the same height. | LayoutHostBase | ||
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes all visual elements from the container. | SkinnableContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes the specified visual element from the child list of
this container. | SkinnableContainer | |
|
Removes a visual element from the specified index position
in the container. | SkinnableContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
Resets the fields in a container. | LayoutHostBase | ||
Reset the nextTabIndex. | LayoutHostBase | ||
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object. | UIComponent | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Changes the position of an existing visual element in the visual container. | SkinnableContainer | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the index of the two specified visual elements. | SkinnableContainer | |
|
Swaps the visual elements at the two specified index
positions in the container. | SkinnableContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
Spark Theme Styles
Mobile Theme Styles
Skin Parts
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
Skin States
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
Public Constants
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.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
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):voidnextTabIndex | property |
nextTabIndex: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 |
Set the next tab index to be used by the tab index generator.
Implementation
public function get nextTabIndex():int public function set nextTabIndex(value:int):voidpanel | property |
panel:Panel [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 parent panel of the layout.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get panel():PanelpanelItems | 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):voidpanelType | property |
public var panelType:int = 0| 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 panel type of this panel in the Guide layout.
sizeState | 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.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
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
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 | |
itemFactories:Array |
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 | |
itemFactories:Array | |
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.
|
clone | () | method |
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
|
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.
|
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.
|
isDesignItem | () | method |
public function isDesignItem(oItem: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
oItem: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.
|
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) |
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 Apr 10 2017, 12:28 PM -07:00