Packagespark.components.supportClasses
Classpublic class GroupBase
InheritanceGroupBase Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite
Implements IViewport
Subclasses DataGroup, Group

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The GroupBase class defines the base class for components that display visual elements. A group component does not control the layout of the visual items that it contains. Instead, the layout is handled by a separate layout component.

MXML SyntaxexpandedHide MXML Syntax

The <s:GroupBase> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:GroupBase
    Properties
    autoLayout="true"
    clipAndEnableScrolling="false"
    horizontalScrollPosition="null"
    luminosityClip="false"
    luminosityInvert="false"
    layout="BasicLayout"
    mask=""
    maskType="clip"
    mouseEnabledWhereTransparent="true"
    resizeMode="noScale"
    verticalScrollPosition="no default"
  
    Styles
    accentColor="0x0099FF"
    alignmentBaseline="useDominantBaseline"
    alternatingItemColors="undefined"
    baselineShift="0"
    blockProgression="tb"
    breakOpportunity="auto"
    cffHinting="horizontalStem"
    chromeColor="0xCCCCCC"
    color="0x000000"
    contentBackgroundAlpha="1.0"
    contentBackgroundColor="0xFFFFFF"
    clearFloats="none"
    digitCase="default"
    digitWidth="default"
    direction="ltr"
    disabledAlpha="0.5"
    dominantBaseline="auto"
    firstBaselineOffset="auto"
    focusColor="0x70B2EE"
    focusedTextSelectionColor="A8C6EE"
    fontFamily="Arial"
    fontLookup="device"
    fontSize="12"
    fontStyle="normal"
    fontWeight="normal"
    inactiveTextSelectionColor="E8E8E8"
    justificationRule="auto"
    justificationStyle="auto"
    kerning="auto"
    leadingModel="auto"
    ligatureLevel="common"
    lineHeight="120%"
    lineThrough="false"
    listAutoPadding="40"
    listStylePosition="outside"
    listStyleType="disc"
    locale="en"
    paragraphEndIndent="0"
    paragraphSpaceAfter="0"
    paragraphSpaceBefore="0"
    paragraphStartIndent="0"
    renderingMode="cff"
    rollOverColor="0xCEDBEF"
    symbolColor="0x000000"
    tabStops="null"
    textAlign="start"
    textAlignLast="start"
    textAlpha="1"
    textDecoration="none"
    textIndent="0"
    textJustify="interWord"
    textRotation="auto"
    trackingLeft="0"
    trackingRight="0"
    typographicCase="default"
    unfocusedTextSelectionColor="0xE8E8E8"
    whiteSpaceCollapse="collapse"
    wordSpacing="100%,50%,150%"
  />
  

See also

spark.layouts.supportClasses.LayoutBase
spark.components.ResizeMode


Public Properties
 PropertyDefined By
 InheritedaccessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
  autoLayout : Boolean
If true, measurement and layout are done when the position or size of a child is changed.
GroupBase
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIComponent
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : 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
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
 Inheritedbaseline : 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.
GroupBase
 Inheritedbottom : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
  clipAndEnableScrolling : Boolean
If true, specifies to clip the children to the boundaries of the viewport.
GroupBase
  contentHeight : Number
[read-only] The height of the viewport's content.
GroupBase
 InheritedcontentMouseX : Number
[read-only] Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
[read-only] Returns the y position of the mouse, in the content coordinate system.
UIComponent
  contentWidth : Number
[read-only] The width of the viewport's contents.
GroupBase
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : String
The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contains true if the element has 3D Matrix.
UIComponent
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhorizontalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  horizontalScrollPosition : Number
The x coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component.
GroupBase
 Inheritedid : String
ID of the component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : 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
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 Inheritedis3D : Boolean
[read-only] Contains true when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
  layout : LayoutBase
The layout object for this container.
GroupBase
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  luminosityClip : Boolean
A property that controls whether the luminosity mask clips the masked content.
GroupBase
  luminosityInvert : Boolean
A property that controls the calculation of the RGB color value of a graphic element being masked by a luminosity mask.
GroupBase
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
  mask : DisplayObject
[override] Sets the mask.
GroupBase
  maskType : String
The mask type.
GroupBase
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : 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
  mouseEnabledWhereTransparent : Boolean
When true, this property ensures that the entire bounds of the Group respond to mouse events such as click and roll over.
GroupBase
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
  numElements : int
[read-only] The number of visual elements in this container.
GroupBase
  overlay : DisplayLayer
[read-only] The overlay plane for this group.
GroupBase
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
[read-only] A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
[read-only] A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : 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
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : 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
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
  resizeMode : String
The ResizeMode for this container.
GroupBase
 Inheritedright : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedrotation : Number
[override]
UIComponent
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationZ : Number
[override]
UIComponent
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabFocusEnabled : 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
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedtransform : Transform
[override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
UIComponent
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  verticalScrollPosition : Number
The y coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component.
GroupBase
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
UIComponent
 Inheritedwidth : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedx : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 Inheritedy : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
 Inheritedz : Number
[override]
UIComponent
Protected Properties
 PropertyDefined By
 InheritedcurrentCSSState : String
[read-only] The state to be used when matching CSS pseudo-selectors.
UIComponent
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.
UIComponent
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
[read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().
UIComponent
Public Methods
 MethodDefined By
  
Constructor.
GroupBase
 Inherited
Adds a non-visual style client to this component instance.
UIComponent
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
  
Determines whether the specified IVisualElement is a child of the container instance or the instance itself.
GroupBase
 Inherited
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Returns a set of properties as automation IDs that identify the child within this container.
UIComponent
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
dispatchEvent(event:Event):Boolean
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
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
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination.
UIComponent
 Inherited
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
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.
GroupBase
  
Returns the index position of a visual element.
GroupBase
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
getFocus():InteractiveObject
Gets the object that currently has focus.
UIComponent
  
getHorizontalScrollPositionDelta(navigationUnit:uint):Number
Returns the change to the horizontal scroll position to handle different scrolling options.
GroupBase
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
Returns the layout transform Matrix3D for this element.
UIComponent
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
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
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
  
getVerticalScrollPositionDelta(navigationUnit:uint):Number
Returns the change to the vertical scroll position to handle different scrolling options.
GroupBase
  
getVirtualElementAt(index:int, eltWidth:Number, eltHeight:Number):IVisualElement
Layouts that honor the useVirtualLayout flag will use this method at updateDisplayList() time to get layout elements that are "in view", i.e.
GroupBase
 Inherited
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
initialize():void
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
 Inherited
measureHTMLText(htmlText:String):TextLineMetrics
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
 Inherited
measureText(text:String):TextLineMetrics
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
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
regenerateStyleCache(recursive:Boolean):void
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
 Inherited
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
Removes a non-visual style client from this component instance.
UIComponent
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
 Inherited
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
  
setContentSize(width:Number, height:Number):void
Sets the contentWidth and contentHeight properties.
GroupBase
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
setFocus():void
Sets the focus to this component.
UIComponent
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
UIComponent
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
toString():String
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
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
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
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
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
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
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
Protected Methods
 MethodDefined By
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
UIComponent
 Inherited
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Processes the properties set on the component.
UIComponent
  
[override] If the layout object has not been set yet, createChildren() assigns this container a default layout object, BasicLayout.
GroupBase
 Inherited
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
UIComponent
 Inherited
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
 Inherited
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
 Inherited
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
 Inherited
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
 Inherited
measure():void
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
 Inherited
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether state-specific styles apply to this component.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children.
UIComponent
Events
 Event Summary Defined By
 InheritedDispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIComponent
 InheritedDispatched by the drop target when the user releases the mouse over it.UIComponent
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 InheritedDispatched by the drag initiator when starting a drag operation.UIComponent
 InheritedDispatched after an effect ends.UIComponent
 InheritedDispatched just before an effect starts.UIComponent
 InheritedDispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 InheritedDispatched after the component has entered a view state.UIComponent
 InheritedDispatched just before the component exits a view state.UIComponent
 InheritedDispatched when an object's state changes from visible to invisible.UIComponent
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 InheritedDispatched when the component is resized.UIComponent
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched after the component has entered a new state and any state transition animation to that state has finished playing.UIComponent
 InheritedDispatched when a component interrupts a transition to its current state in order to switch to a new state.UIComponent
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and is to be discarded soon.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be shown.UIComponent
 InheritedDispatched by the component when its ToolTip has been shown.UIComponent
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.UIComponent
 InheritedA cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.UIComponent
 InheritedDispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 InheritedDispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 Style Description Defined By
  
accentColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile
Accent color used by component skins. The default button skin uses this color to tint the background. Slider track highlighting uses this color. The default value is #0099FF.
GroupBase
  
alignmentBaseline
Type: String CSS Inheritance: yes
Specifies the baseline to which the dominant baseline aligns.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline
GroupBase
  
alternatingItemColors
Type: Array Format: Color CSS Inheritance: yes Theme: spark, mobile
The colors to use for the backgrounds of the items in the list. The value is an array of one or more colors. The backgrounds of the list items alternate among the colors in the array.

The default value for the Spark theme is undefined. The default value for the Mobile theme is 0xFFFFFF.

GroupBase
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
  
baselineShift
Type: Object CSS Inheritance: yes
Amount to shift the baseline.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.baselineShift.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.baselineShift
GroupBase
  
blockProgression
Type: String CSS Inheritance: yes
Specifies a vertical or horizontal progression of line placement.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.blockProgression.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.blockProgression
GroupBase
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
  
breakOpportunity
Type: String CSS Inheritance: yes
Controls where lines are allowed to break when breaking wrapping text into multiple lines.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.breakOpportunity.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.breakOpportunity
GroupBase
  
cffHinting
Type: String CSS Inheritance: yes
The type of CFF hinting used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.cffHinting.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.cffHinting
GroupBase
  
chromeColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile
The main color for a component. The default value is 0xCCCCCC.
GroupBase
  
clearFloats
Type: String CSS Inheritance: yes
Controls how text wraps around a float.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.clearFloats.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.clearFloats
GroupBase
  
color
Type: uint Format: Color CSS Inheritance: yes
Color of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.color.

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style color.

The default value is 0x000000.

See also

flashx.textLayout.formats.ITextLayoutFormat.color
spark.components.supportClasses.StyleableTextField.color
GroupBase
  
contentBackgroundAlpha
Type: Number CSS Inheritance: yes Theme: spark, mobile
The alpha of the content background for this component. The default value is 1.0.
GroupBase
  
contentBackgroundColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile
The color of the content background for this component.

For a List, changing contentBackgroundColor will change the content background color of the List; however, if the item renderer is opaque, the user may not see any difference. The item renderer's color is affected by alternatingItemColors. In the Spark theme, by default, item renderers are transparent (alternatingItemColors = undefined); however, in the Mobile theme, item renderers are opaque by default (alternatingItemColors = 0xFFFFFF).

The default value for the Spark theme is 0xFFFFFF. The default value for the Mobile theme is 0xF0F0F0.

GroupBase
  
digitCase
Type: String CSS Inheritance: yes
The type of digit case used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitCase.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.digitCase
GroupBase
  
digitWidth
Type: String CSS Inheritance: yes
Type of digit width used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitWidth.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.digitWidth
GroupBase
  
direction
Type: String CSS Inheritance: yes
Specifies the default bidirectional embedding level of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.direction.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.direction
GroupBase
  
disabledAlpha
Type: Number CSS Inheritance: no Theme: spark, mobile
The alpha value when the container is disabled. The default value is 0.5.
GroupBase
  
dominantBaseline
Type: String CSS Inheritance: yes
Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline
GroupBase
  
downColor
Type: uint Format: Color CSS Inheritance: yes Theme: mobile
Color of the background of an item renderer when it is being pressed down

If downColor is set to undefined, downColor is not used.

The default value for the Spark theme is undefined. The default value for the Mobile theme is 0xE0E0E0.

GroupBase
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
  
firstBaselineOffset
Type: Object CSS Inheritance: yes
Specifies the baseline position of the first line in the container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.firstBaselineOffset.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.firstBaselineOffset
GroupBase
  
focusColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile
Color of focus ring when the component is in focus. The default value is 0x70B2EE.
GroupBase
  
focusedTextSelectionColor
Type: uint Format: Color CSS Inheritance: yes
The color of text when the component is enabled and has focus.

For the Mobile theme, this is not supported.

GroupBase
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
  
fontFamily
Type: String CSS Inheritance: yes
The name of the font to use, or a comma-separated list of font names.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontFamily.

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style fontFamily.

The default value for the Spark theme is Arial. The default value for the Mobile theme is _sans.

See also

flashx.textLayout.formats.ITextLayoutFormat.fontFamily
spark.components.supportClasses.StyleableTextField.fontFamily
GroupBase
  
fontLookup
Type: String CSS Inheritance: yes
Font lookup to use.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontLookup

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.fontLookup
GroupBase
  
fontSize
Type: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontSize

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style fontSize

The default value for the Spark theme is 12. The default value for the Mobile theme is 24.

See also

flashx.textLayout.formats.ITextLayoutFormat.fontSize
spark.components.supportClasses.StyleableTextField.fontSize
GroupBase
  
fontStyle
Type: String CSS Inheritance: yes
Determines whether the text is italic font.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontStyle

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style fontStyle

See also

flashx.textLayout.formats.ITextLayoutFormat.fontStyle
spark.components.supportClasses.StyleableTextField.fontStyle
GroupBase
  
fontWeight
Type: String CSS Inheritance: yes
Determines whether the text is boldface.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontWeight

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style fontWeight

See also

flashx.textLayout.formats.ITextLayoutFormat.fontWeight
spark.components.supportClasses.StyleableTextField.fontWeight
GroupBase
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
inactiveTextSelectionColor
Type: uint Format: Color CSS Inheritance: yes
The color of text when the component is disabled.

For the Mobile theme, this is not supported.

GroupBase
 InheritedType: String CSS Inheritance: yes
The primary interaction mode for this component.

See also

UIComponent
  
justificationRule
Type: String CSS Inheritance: yes
Rule used to justify text in a paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationRule

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.justificationRule
GroupBase
  
justificationStyle
Type: String CSS Inheritance: yes
The style used for justification of the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationStyle

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.justificationStyle
GroupBase
  
kerning
Type: String CSS Inheritance: yes
The style used for justification of the paragraph.

Kerning is enabled by default for Spark components, but is disabled by default for MX components. Spark components interpret default as auto, while MX components interpret default as false.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.kerning

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.kerning
GroupBase
 InheritedType: String CSS Inheritance: yes
Specifies the desired layout direction of a component.

See also

UIComponent
  
leading
Type: Number Format: Length CSS Inheritance: yes Theme: mobile
Additional vertical space between lines of text.

For the Spark theme, this is not supported. See lineHeight.

For the Mobile theme, see spark.components.supportClasses.StyleableTextField.leading.

See also

GroupBase
  
leadingModel
Type: String CSS Inheritance: yes
Specifies the leading model, which is a combination of leading basis and leading direction.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.leadingModel.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.leadingModel
GroupBase
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
  
letterSpacing
Type: Number CSS Inheritance: yes Theme: mobile
The number of additional pixels to appear between each character.

For the Spark theme, this is not supported. See trackingLeft and trackingRight.

For the Mobile theme, see spark.components.supportClasses.StyleableTextField.letterSpacing.

See also

GroupBase
  
ligatureLevel
Type: String CSS Inheritance: yes
Controls which of the ligatures that are defined in the font may be used in the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel
GroupBase
  
lineHeight
Type: Object CSS Inheritance: yes
Leading controls for the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineHeight.

For the Mobile theme, this is not supported. See leading.

See also

flashx.textLayout.formats.ITextLayoutFormat.lineHeight
leading
GroupBase
  
lineThrough
Type: Boolean CSS Inheritance: yes
If true, applies strikethrough, a line drawn through the middle of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineThrough

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.lineThrough
GroupBase
  
listAutoPadding
Type: Number Format: length CSS Inheritance: yes
This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding
GroupBase
  
listStylePosition
Type: String CSS Inheritance: yes
This controls the placement of a list item marker relative to the list item.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listStylePosition.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.listStylePosition
GroupBase
  
listStyleType
Type: String CSS Inheritance: yes
This controls the appearance of items in a list.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listStyleType.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.listStyleType
GroupBase
  
locale
Type: String CSS Inheritance: yes
The locale of the text. Controls case transformations and shaping. Uses standard locale identifiers as described in Unicode Technical Standard #35. For example "en", "en_US" and "en-US" are all English, "ja" is Japanese.

The default value is undefined. This property inherits its value from an ancestor; if still undefined, it inherits from the global locale style. During the application initialization, if the global locale style is undefined, then the default value is set to "en".

When using the Spark formatters and globalization classes, you can set this style on the root application to the value of the LocaleID.DEFAULT constant. Those classes will then use the client operating system's international preferences.

GroupBase
  
paragraphEndIndent
Type: Number Format: length CSS Inheritance: yes
The amount to indent the paragraph's end edge.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphEndIndent.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paragraphEndIndent
GroupBase
  
paragraphSpaceAfter
Type: Number Format: length CSS Inheritance: yes
The amount of space to leave after the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceAfter.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceAfter
GroupBase
  
paragraphSpaceBefore
Type: Number Format: length CSS Inheritance: yes
The amount of space to leave before the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceBefore.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceBefore
GroupBase
  
paragraphStartIndent
Type: Number Format: length CSS Inheritance: yes
The amount to indent the paragraph's start edge.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphStartIndent.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paragraphStartIndent
GroupBase
  
renderingMode
Type: String CSS Inheritance: yes
The rendering mode used for this text which applies only to embedded fonts.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.renderingMode

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.renderingMode
GroupBase
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
  
rollOverColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the highlights when the mouse is over the component.

This style is only applicable in mouse interactionMode.

The default value is 0xCEDBEF.
GroupBase
 InheritedType: Boolean CSS Inheritance: yes
Show the error border or skin when this component is invalid.
UIComponent
 InheritedType: Boolean CSS Inheritance: yes
Show the error tip when this component is invalid and the user rolls over it.
UIComponent
  
symbolColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile
Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a scroll button. The default value is 0x000000.
GroupBase
  
tabStops
Type: String CSS Inheritance: yes
Specifies the tab stops associated with the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.tabStops.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.tabStops
GroupBase
  
textAlign
Type: String CSS Inheritance: yes
Alignment of text within a container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlign

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style textAlign

See also

flashx.textLayout.formats.ITextLayoutFormat.textAlign
spark.components.supportClasses.StyleableTextField.textAlign
GroupBase
  
textAlignLast
Type: String CSS Inheritance: yes
Alignment of the last line in the paragraph relative to the container in justified text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlignLast

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.textAlignLast
GroupBase
  
textAlpha
Type: Number CSS Inheritance: yes
Alpha (transparency) value for the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlpha

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.textAlpha
GroupBase
  
textDecoration
Type: String CSS Inheritance: yes
Determines whether the text is underlined.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textDecoration

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style textDecoration

See also

flashx.textLayout.formats.ITextLayoutFormat.textDecoration
spark.components.supportClasses.StyleableTextField.textDecoration
GroupBase
  
textIndent
Type: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container. .

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textIndent.

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style textIndent.

See also

flashx.textLayout.formats.ITextLayoutFormat.textIndent
spark.components.supportClasses.StyleableTextField.textIndent
GroupBase
  
textJustify
Type: String CSS Inheritance: yes
Specifies options for justifying text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textJustify

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.textJustify
GroupBase
  
textRotation
Type: String CSS Inheritance: yes
Determines the number of degrees to rotate this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textRotation.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.textRotation
GroupBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Theme color of a component.
UIComponent
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
  
touchDelay
Type: Number Format: Time CSS Inheritance: yes
When in touch interaction mode, the number of milliseconds to wait after the user interaction has occured before showing the component in a visually down state.

The reason for this delay is because when a user initiates a scroll gesture, we don't want components to flicker as they touch the screen. By having a reasonable delay, we make sure that the user still gets feedback when they press down on a component, but that the feedback doesn't come too quickly that it gets displayed during a scroll gesture operation.

If the mobile theme is applied, the default value for this style is 100 ms for components inside of a Scroller and 0 ms for components outside of a Scroller.

GroupBase
  
trackingLeft
Type: Object CSS Inheritance: yes
The amount of tracking (manual kerning) to be applied to the left of each character.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingLeft

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.trackingLeft
GroupBase
  
trackingRight
Type: Object CSS Inheritance: yes
The amount of tracking (manual kerning) to be applied to the right of each character.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingRight

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.trackingRight
GroupBase
  
typographicCase
Type: String CSS Inheritance: yes
The type of typographic case used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.typographicCase

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.typographicCase
GroupBase
  
unfocusedTextSelectionColor
Type: uint Format: Color CSS Inheritance: yes
The color of text when the component is enabled but does not have focus.

For the Mobile theme, this is not supported.

GroupBase
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
whiteSpaceCollapse
Type: String CSS Inheritance: yes
Collapses or preserves whitespace when importing text into a TextFlow.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.whiteSpaceCollapse.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.whiteSpaceCollapse
GroupBase
  
wordSpacing
Type: Object CSS Inheritance: yes
Specifies the spacing between words to use during justification.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.wordSpacing.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.wordSpacing
GroupBase
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: move
Played when the component is moved.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined By
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property Detail
autoLayoutproperty
autoLayout:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

If true, measurement and layout are done when the position or size of a child is changed. If false, measurement and layout are done only once, when children are added to or removed from the container.

The default value is true.


Implementation
    public function get autoLayout():Boolean
    public function set autoLayout(value:Boolean):void
baselinePositionproperty 
baselinePosition:Number  [read-only] [override]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The y-coordinate of the baseline of the first line of text of the component.

This property is used to implement the baseline constraint style. It is also used to align the label of a FormItem with the controls in the FormItem.

Each component should override this property.


Implementation
    public function get baselinePosition():Number
clipAndEnableScrollingproperty 
clipAndEnableScrolling:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

If true, specifies to clip the children to the boundaries of the viewport. If false, the container children extend past the container boundaries, regardless of the size specification of the component.

The default value is false.


Implementation
    public function get clipAndEnableScrolling():Boolean
    public function set clipAndEnableScrolling(value:Boolean):void
contentHeightproperty 
contentHeight:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The height of the viewport's content. If clipAndEnabledScrolling is true, the viewport's contentHeight defines the limit for vertical scrolling and the viewport's actual height defines how much of the content is visible. To scroll through the content vertically, vary the verticalScrollPosition between 0 and contentHeight - height.

Implementations of this property must be Bindable and must generate events of type propertyChange.

This property can be used as the source for data binding.


Implementation
    public function get contentHeight():Number
contentWidthproperty 
contentWidth:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The width of the viewport's contents. If clipAndEnabledScrolling is true, the viewport's contentWidth defines the limit for horizontal scrolling and the viewport's actual width defines how much of the content is visible. To scroll through the content horizontally, vary the horizontalScrollPosition between 0 and contentWidth - width.

Implementations of this property must be Bindable and must generate events of type propertyChange.

This property can be used as the source for data binding.


Implementation
    public function get contentWidth():Number
horizontalScrollPositionproperty 
horizontalScrollPosition:Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The x coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component. If clipAndEnableScrolling is true, setting this property typically causes the viewport to be set to:

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)
      
Implementations of this property must be Bindable and must generate events of type propertyChange.

This property can be used as the source for data binding.


Implementation
    public function get horizontalScrollPosition():Number
    public function set horizontalScrollPosition(value:Number):void
layoutproperty 
layout:LayoutBase

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The layout object for this container. This object is responsible for the measurement and layout of the visual elements in the container.

The default value is spark.layouts.BasicLayout.


Implementation
    public function get layout():LayoutBase
    public function set layout(value:LayoutBase):void

See also

luminosityClipproperty 
luminosityClip:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

A property that controls whether the luminosity mask clips the masked content. This property can only have an effect if the graphic element has a mask applied to it that is of type MaskType.LUMINOSITY.

The default value is false.


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

See also

luminosityInvertproperty 
luminosityInvert:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

A property that controls the calculation of the RGB color value of a graphic element being masked by a luminosity mask. If true, the RGB color value of a pixel in the source content is inverted and multipled by the corresponding region in the mask. If false, the source content's pixel's RGB color value is used directly.

The default value is false.


Implementation
    public function get luminosityInvert():Boolean
    public function set luminosityInvert(value:Boolean):void
maskproperty 
mask:DisplayObject[override]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Sets the mask. The mask will be added to the display list. The mask must not already on a display list nor in the elements array.


Implementation
    public function get mask():DisplayObject
    public function set mask(value:DisplayObject):void

See also

flash.display.DisplayObject.mask
maskTypeproperty 
maskType:String

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The mask type. Possible values are MaskType.CLIP, MaskType.ALPHA or MaskType.LUMINOSITY.

Clip Masking

When masking in clip mode, a clipping masks is reduced to 1-bit. This means that a mask will not affect the opacity of a pixel in the source content; it either leaves the value unmodified, if the corresponding pixel in the mask is has a non-zero alpha value, or makes it fully transparent, if the mask pixel value has an alpha value of zero.

Alpha Masking

In alpha mode, the opacity of each pixel in the source content is multiplied by the opacity of the corresponding region of the mask. i.e., a pixel in the source content with an opacity of 1 that is masked by a region of opacity of .5 will have a resulting opacity of .5. A source pixel with an opacity of .8 masked by a region with opacity of .5 will have a resulting opacity of .4.

Luminosity Masking

A luminosity mask, sometimes called a 'soft mask', works very similarly to an alpha mask except that both the opacity and RGB color value of a pixel in the source content is multiplied by the opacity and RGB color value of the corresponding region in the mask.

Luminosity masking is not native to Flash but is common in Adobe Creative Suite tools like Adobe Illustrator and Adobe Photoshop. In order to accomplish the visual effect of a luminosity mask in Flash-rendered content, a graphic element specifying a luminosity mask actually instantiates a shader filter that mimics the visual look of a luminosity mask as rendered in Adobe Creative Suite tools.

Objects being masked by luminosity masks can set properties to control the RGB color value and clipping of the mask. See the luminosityInvert and luminosityClip attributes.

The default value is MaskType.CLIP.

This property can be used as the source for data binding.


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

See also

mouseEnabledWhereTransparentproperty 
mouseEnabledWhereTransparent:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

When true, this property ensures that the entire bounds of the Group respond to mouse events such as click and roll over. This property only goes in to effect if mouse, touch, or flash player gesture events are added to this instance. In addition, it assumes that the calls to addEventListener()/removeEventListener() are not superfluous.

The default value is true.


Implementation
    public function get mouseEnabledWhereTransparent():Boolean
    public function set mouseEnabledWhereTransparent(value:Boolean):void
numElementsproperty 
numElements:int  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The number of visual elements in this container. Visual elements include classes that implement the IVisualElement interface, such as subclasses of UIComponent and GraphicElement.


Implementation
    public function get numElements():int
overlayproperty 
overlay:DisplayLayer  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The overlay plane for this group. All objects of the overlay plane render on top of the Group elements.

Note: Do not retain this object because the group destroys and creates it on demand.


Implementation
    public function get overlay():DisplayLayer
resizeModeproperty 
resizeMode:String

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The ResizeMode for this container. If the resize mode is set to ResizeMode.NO_SCALE, resizing is done by laying out the children with the new width and height. If the resize mode is set to ResizeMode.SCALE, all of the children keep their unscaled width and height and the children are scaled to change size.

The default value is ResizeMode.NO_SCALE, corresponding to "noScale".


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

See also

verticalScrollPositionproperty 
verticalScrollPosition:Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The y coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component. If clipAndEnableScrolling is true, setting this property typically causes the viewport to be set to:

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)
      
Implementations of this property must be Bindable and must generate events of type propertyChange.

This property can be used as the source for data binding.


Implementation
    public function get verticalScrollPosition():Number
    public function set verticalScrollPosition(value:Number):void
Constructor Detail
GroupBase()Constructor
public function GroupBase()

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Method Detail
containsElement()method
public function containsElement(element:IVisualElement):Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Determines whether the specified IVisualElement is a child of the container instance or the instance itself. The search is deep, i.e. if the element is a child, grandchild, great-grandchild, etc., of this container, this returns true.

Parameters

element:IVisualElement — the child object to test

Returns
Boolean — true if the element is a descendant of the container
createChildren()method 
override protected function createChildren():void

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

If the layout object has not been set yet, createChildren() assigns this container a default layout object, BasicLayout.

getElementAt()method 
public function getElementAt(index:int):IVisualElement

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the visual element at the specified index.

Parameters

index:int — The index of the element to retrieve.

Returns
IVisualElement — The element at the specified index.
getElementIndex()method 
public function getElementIndex(element:IVisualElement):int

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the index position of a visual element.

Parameters

element:IVisualElement — The visual element.

Returns
int — The index position of the element in the container.
getHorizontalScrollPositionDelta()method 
public function getHorizontalScrollPositionDelta(navigationUnit:uint):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the change to the horizontal scroll position to handle different scrolling options. These options are defined by the NavigationUnit class: END, HOME, LEFT, PAGE_LEFT, PAGE_RIGHT, and RIGHT.

Parameters

navigationUnit:uint — Takes the following values:
  • END Returns scroll delta that will right justify the scrollRect to the content area.
  • HOME Returns scroll delta that will left justify the scrollRect to the content area.
  • LEFT Returns scroll delta that will left justify the scrollRect with the first element that spans or is to the left of the scrollRect's left edge.
  • PAGE_LEFT Returns scroll delta that will right justify the scrollRect with the first element that spans or is to the left of the scrollRect's left edge.
  • PAGE_RIGHT Returns scroll delta that will left justify the scrollRect with the first element that spans or is to the right of the scrollRect's right edge.
  • RIGHT Returns scroll delta that will right justify the scrollRect with the first element that spans or is to the right of the scrollRect's right edge.

The implementation calls getElementBoundsLeftOfScrollRect() and getElementBoundsRightOfScrollRect() to determine the bounds of the elements. Layout classes usually override those methods instead of the getHorizontalScrollPositionDelta() method.

Returns
Number — The change to the horizontal scroll position.
getVerticalScrollPositionDelta()method 
public function getVerticalScrollPositionDelta(navigationUnit:uint):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the change to the vertical scroll position to handle different scrolling options. These options are defined by the NavigationUnit class: DOWN, END, HOME, PAGE_DOWN, PAGE_UP, and UP.

Parameters

navigationUnit:uint — Takes the following values:
  • DOWN Returns scroll delta that will bottom justify the scrollRect with the first element that spans or is below the scrollRect's bottom edge.
  • END Returns scroll delta that will bottom justify the scrollRect to the content area.
  • HOME Returns scroll delta that will top justify the scrollRect to the content area.
  • PAGE_DOWN Returns scroll delta that will top justify the scrollRect with the first element that spans or is below the scrollRect's bottom edge.
  • PAGE_UP
  • Returns scroll delta that will bottom justify the scrollRect with the first element that spans or is above the scrollRect's top edge.
  • UP Returns scroll delta that will top justify the scrollRect with the first element that spans or is above the scrollRect's top edge.

The implementation calls getElementBoundsAboveScrollRect() and getElementBoundsBelowScrollRect() to determine the bounds of the elements. Layout classes usually override those methods instead of the getVerticalScrollPositionDelta() method.

Returns
Number — The change to the vertical scroll position.
getVirtualElementAt()method 
public function getVirtualElementAt(index:int, eltWidth:Number, eltHeight:Number):IVisualElement

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Layouts that honor the useVirtualLayout flag will use this method at updateDisplayList() time to get layout elements that are "in view", i.e. that overlap the Group's scrollRect.

If the element to be returned wasn't already a visible child, i.e. if it was created or recycled, and either eltWidth or eltHeight is specified, then the element's initial size is set with setLayoutBoundsSize() before it's validated. This is important for components, like text, that reflow when the layout is justified to the Group's width or height.

The returned layout element will have been validated.

This method will lazily create or "recycle" and validate layout elements as needed.

This method is not intended to be called directly, layouts that support virutalization will call it.

Parameters

index:int — The index of the element to retrieve.
 
eltWidth:Number (default = NaN) — If specified, the newly created or recycled element's initial width.
 
eltHeight:Number (default = NaN) — If specified, the newly created or recycled element's initial height.

Returns
IVisualElement — The validated element at the specified index.
setContentSize()method 
public function setContentSize(width:Number, height:Number):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Sets the contentWidth and contentHeight properties. This method is intended for layout class developers who should call it from updateDisplayList() methods.

Parameters

width:Number — The new value of contentWidth.
 
height:Number — The new value of contentHeight.