Packagemx.containers
Classpublic class DividedBox
InheritanceDividedBox Inheritance Box Inheritance Container Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite
Subclasses HDividedBox, VDividedBox

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

A DividedBox container measures and lays out its children horizontally or vertically in exactly the same way as a Box container, but it inserts draggable dividers in the gaps between the children. Users can drag any divider to resize the children on each side.

The DividedBox class is the base class for the more commonly used HDividedBox and VDividedBox classes.

The direction property of a DividedBox container, inherited from Box container, determines whether it has horizontal or vertical layout.

A DividedBox, HDividedBox, or VDividedBox container has the following default sizing characteristics:

CharacteristicDescription
Default size Vertical DividedBox Height is large enough to hold all of its children at the default or explicit heights of the children, plus any vertical gap between the children, plus the top and bottom padding of the container. The width is the default or explicit width of the widest child, plus the left and right padding of the container. Horizontal DividedBox Width is large enough to hold all of its children at the default or explicit widths of the children, plus any horizontal gap between the children, plus the left and right padding of the container. Height is the default or explicit height of the tallest child plus the top and bottom padding of the container.
Default padding0 pixels for the top, bottom, left, and right values.
Default gap10 pixels for the horizontal and vertical gaps.

MXML SyntaxexpandedHide MXML Syntax

The <mx:DividedBox> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:DividedBox
    Properties
    liveDragging="false|true"
    resizeToContent="false|true"
  
    Styles
    dividerAffordance="6"
    dividerAlpha="0.75"
    dividerColor="0x6F7777"
    dividerSkin="'mx.skins.BoxDividerSkin' symbol in Assets.swf"
    dividerThickness="3"
    horizontalDividerCursor="'mx.skins.cursor.HBoxDivider' symbol in Assets.swf"
    verticalDividerCursor="'mx.skins.cursor.VBoxDivider' symbol in Assets.swf"
 
    Events
    dividerPress="No default"
    dividerDrag="No default"
    dividerRelease="No default"
    >
      ...
      child tags
      ...
  </mx:DividedBox>
  

View the examples

See also

mx.containers.HDividedBox
mx.containers.VDividedBox


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
 InheritedautoLayout : Boolean
If true, measurement and layout are done when the position or size of a child is changed.
Container
 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
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedborderMetrics : EdgeMetrics
[read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
Container
 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
 InheritedchildDescriptors : Array
[read-only] Array of UIComponentDescriptor objects produced by the MXML compiler.
Container
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
 InheritedclipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container.
Container
 InheritedcontentMouseX : Number
[override] [read-only] Returns the x position of the mouse, in the content coordinate system.
Container
 InheritedcontentMouseY : Number
[override] [read-only] Returns the y position of the mouse, in the content coordinate system.
Container
 InheritedcreatingContentPane : Boolean
Containers use an internal content pane to control scrolling.
Container
 InheritedcreationIndex : int
Deprecated: Deprecated
Specifies the order to instantiate and draw the children of the container.
Container
 InheritedcreationPolicy : String
The child creation policy for this MX Container.
Container
 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
 Inheriteddata : Object
The data property lets you pass a value to the component when you use it in an item renderer or item editor.
Container
 InheriteddefaultButton : IFlexDisplayObject
The Button control designated as the default button for the container.
Container
 InheriteddeferredContentCreated : Boolean
[read-only] IDeferredContentOwner equivalent of processedDescriptors
Container
 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
 Inheriteddirection : String
The direction in which this Box container lays out its children.
Box
 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
 InheritedhorizontalLineScrollSize : Number
Number of pixels to move when the left- or right-arrow button in the horizontal scroll bar is pressed.
Container
 InheritedhorizontalPageScrollSize : Number
Number of pixels to move when the track in the horizontal scroll bar is pressed.
Container
 InheritedhorizontalScrollBar : ScrollBar
The horizontal scrollbar used in this container.
Container
 InheritedhorizontalScrollPolicy : String
Specifies whether the horizontal scroll bar is always present, always absent, or automatically added when needed.
Container
 InheritedhorizontalScrollPosition : Number
The current position of the horizontal scroll bar.
Container
 Inheritedicon : Class
The Class of the icon displayed by some navigator containers to represent this Container.
Container
 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
 Inheritedlabel : String
The text displayed by some navigator containers to represent this Container.
Container
 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
  liveDragging : Boolean = false
If true, the children adjacent to a divider are continuously resized while the user drags it.
DividedBox
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxHorizontalScrollPosition : Number
[read-only] The largest possible value for the horizontalScrollPosition property.
Container
 InheritedmaxVerticalScrollPosition : Number
[read-only] The largest possible value for the verticalScrollPosition property.
Container
 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
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedMXMLDescriptor : Array
[read-only]
UIComponent
 InheritedMXMLProperties : Array
[read-only]
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
 InheritednumChildren : int
[override] [read-only] Number of child components in this container.
Container
  numDividers : int
[read-only] The number of dividers.
DividedBox
 InheritednumElements : int
[read-only] The number of visual elements in this container.
Container
 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
 InheritedrawChildren : IChildList
[read-only] A container typically contains child components, which can be enumerated using the Container.getChildAt() method and Container.numChildren property.
Container
 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
  resizeToContent : Boolean
If true, the DividedBox automatically resizes to the size of its children.
DividedBox
 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
 InheritedverticalLineScrollSize : Number
Number of pixels to scroll when the up- or down-arrow button in the vertical scroll bar is pressed, or when you scroll by using the mouse wheel.
Container
 InheritedverticalPageScrollSize : Number
Number of pixels to scroll when the track in the vertical scroll bar is pressed.
Container
 InheritedverticalScrollBar : ScrollBar
The vertical scrollbar used in this container.
Container
 InheritedverticalScrollPolicy : String
Specifies whether the vertical scroll bar is always present, always absent, or automatically added when needed.
Container
 InheritedverticalScrollPosition : Number
The current position of the vertical scroll bar.
Container
 InheritedviewMetrics : EdgeMetrics
[read-only] Returns an object that has four properties: left, top, right, and bottom.
Container
 InheritedviewMetricsAndPadding : EdgeMetrics
[read-only] Returns an object that has four properties: left, top, right, and bottom.
Container
 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
 InheritedactualCreationPolicy : String
The creation policy of this container.
Container
 InheritedcurrentCSSState : String
[read-only] The state to be used when matching CSS pseudo-selectors.
UIComponent
  dividerClass : Class
The class for the divider between the children.
DividedBox
 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.
DividedBox
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds a child DisplayObject to this Container.
Container
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds a child DisplayObject to this Container.
Container
 Inherited
Adds a visual element to this container.
Container
 Inherited
Adds a visual element to this container.
Container
 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
 Inherited
contentToGlobal(point:Point):Point
[override] Converts a Point object from content coordinates to global coordinates.
Container
 Inherited
contentToLocal(point:Point):Point
[override] Converts a Point object from content to local coordinates.
Container
 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
Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this Container.
Container
 Inherited
createComponentsFromDescriptors(recurse:Boolean = true):void
Iterate through the Array of childDescriptors, and call the createComponentFromDescriptor() method for each one.
Container
 Inherited
Performs the equivalent action of calling the createComponentsFromDescriptors(true) method for containers that implement the IDeferredContentOwner interface to support deferred instantiation.
Container
 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
[override] Executes all the data bindings on this Container.
Container
 Inherited
executeChildBindings(recurse:Boolean):void
Executes the bindings into this Container's child UIComponent objects.
Container
 Inherited
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array
UIComponent
 Inherited
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):*
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
getChildAt(index:int):DisplayObject
[override] Gets the nth child component object.
Container
 Inherited
getChildByName(name:String):DisplayObject
[override] Returns the child whose name property is the specified String.
Container
 Inherited
getChildIndex(child:DisplayObject):int
[override] Gets the zero-based index of a specific child.
Container
 Inherited
getChildren():Array
Returns an Array of DisplayObject objects consisting of the content children of the container.
Container
 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 a reference to the specified BoxDivider object in this DividedBox container or null if it doesn't exist.
DividedBox
 Inherited
Returns the visual element at the specified index.
Container
 Inherited
Returns the index position of a visual element.
Container
 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
 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
 Inherited
getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user on the screen.
UIComponent
 Inherited
globalToContent(point:Point):Point
[override] Converts a Point object from global to content coordinates.
Container
 Inherited
hasCSSState():Boolean
Returns true if currentCSSState is not null.
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
[override] Converts a Point object from local to content coordinates.
Container
 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
  
moveDivider(i:int, amt:Number):void
Move a specific divider a given number of pixels.
DividedBox
 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
pixelsToPercent(pxl:Number):Number
Method used to convert number of pixels to a percentage relative to the contents of this container.
Box
 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 all children from the child list of this container.
Container
 Inherited
Removes all visual elements from the container.
Container
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes a child DisplayObject from the child list of this Container.
Container
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes a child DisplayObject from the child list of this Container at the specified index.
Container
 Inherited
Removes the specified visual element from the child list of this container.
Container
 Inherited
Removes a visual element from the specified index position in the container.
Container
 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
setChildIndex(child:DisplayObject, newIndex:int):void
[override] Sets the index of a particular child.
Container
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
setElementIndex(element:IVisualElement, index:int):void
Changes the position of an existing visual element in the visual container.
Container
 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
setMXMLDescriptor(value:Array):void
UIComponent
 Inherited
setMXMLProperties(value:Array):void
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
swapElements(element1:IVisualElement, element2:IVisualElement):void
Swaps the index of the two specified visual elements.
Container
 Inherited
swapElementsAt(index1:int, index2:int):void
Swaps the visual elements at the two specified index positions in the container.
Container
 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
addMXMLChildren(comps:Array):void
UIComponent
 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
[override] Used internally by the Dissolve Effect to add the overlay to the chrome of a container.
Container
 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
 Inherited
Creates the container's border skin if it is needed and does not already exist.
Container
 Inherited
Create child objects of the component.
UIComponent
 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
generateMXMLAttributes(data:Array):void
UIComponent
 Inherited
generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void
UIComponent
 Inherited
generateMXMLObject(document:Object, data:Array):Object
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
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Respond to size changes by setting the positions and sizes of this container's borders.
Container
 Inherited
measure():void
[override] Calculates the default sizes and minimum and maximum values of the Box container.
Box
 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
Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties.
Container
 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
[override] Sets the size and position of each child of the Box container.
Box
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 after a child has been added to a container.Container
 InheritedDispatched after the index (among the container children) of a container child changes.Container
 InheritedDispatched before a child of a container is removed.Container
 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 when the data property changes.Container
  Dispatched multiple times as the user drags any divider.DividedBox
  Dispatched when the user presses any divider in this container.DividedBox
  Dispatched when the user releases a divider.DividedBox
 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 the user manually scrolls the container.Container
 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
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Accent color used by component skins.
Container
 InheritedType: Number CSS Inheritance: no Theme: halo, spark
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
Container
 InheritedType: String CSS Inheritance: no
If a background image is specified, this style specifies whether it is fixed with regard to the viewport ("fixed") or scrolls along with the content ("scroll").
Container
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Background color of a component.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Background color of the component when it is disabled.
Container
 InheritedType: Object Format: File CSS Inheritance: no Theme: halo
Background image of a component.
Container
 InheritedType: String CSS Inheritance: no Theme: halo
Scales the image specified by backgroundImage to different percentage sizes.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Determines the color of a ProgressBar.
Container
 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
 InheritedType: Number CSS Inheritance: no Theme: spark
Alpha of the border.
Container
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border.
Container
 InheritedType: String CSS Inheritance: no Theme: halo
Bounding box sides.
Container
 InheritedType: Class CSS Inheritance: no
The border skin class of the component.
Container
 InheritedType: String CSS Inheritance: no
Bounding box style.
Container
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Bounding box thickness.
Container
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Visibility of the border.
Container
 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
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component, including the component label.
Container
 InheritedType: Number CSS Inheritance: yes Theme: spark
The alpha of the content background for this component.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the content area of the component.
Container
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo, spark
Radius of component corners.
Container
 InheritedType: String CSS Inheritance: yes
The directionality of the text displayed by the component.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component if it is disabled.
Container
 InheritedType: Number CSS Inheritance: no
The alpha value for the overlay that is placed on top of the container when it is disabled.
Container
  
dividerAffordance
Type: Number Format: Length CSS Inheritance: no
Thickness in pixels of the area where the user can click to drag a divider. This area is centered in the gaps between the container's children, which are determined by the horizontalGap or verticalGap style property. The affordance cannot be set to a value larger than the gap size. A resize cursor appears when the mouse is over this area. The default value is 6.
DividedBox
  
dividerAlpha
Type: Number CSS Inheritance: no
The alpha value that determines the transparency of the dividers. A value of 0.0 means completely transparent and a value of 1.0 means completely opaque. The default value is 0.75.
DividedBox
  
dividerColor
Type: uint Format: Color CSS Inheritance: yes
Color of the dividers when the user presses or drags the dividers if the liveDragging property is set to false. If the liveDragging property is set to true, only the divider's knob is shown. The default value is 0x6F7777.
DividedBox
  
dividerSkin
Type: Class CSS Inheritance: no
The divider skin. The default value is the "mx.skin.BoxDividerSkin" symbol in the Assets.swf file.
DividedBox
  
dividerThickness
Type: Number Format: Length CSS Inheritance: no
Thickness in pixels of the dividers when the user presses or drags the dividers, if the liveDragging property is set to false. (If the liveDragging property is set to true, only the divider's knob is shown.) The visible thickness cannot be set to a value larger than the affordance. The default value is 3.
DividedBox
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Color of the drop shadow.
Container
 InheritedType: Boolean CSS Inheritance: no Theme: halo
Boolean property that specifies whether the component has a visible drop shadow.
Container
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Boolean property that specifies whether the component has a visible drop shadow.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of focus ring when the component is in focus.
Container
 InheritedType: String CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.

See also

flash.text.TextField
flash.text.AntiAliasType
Container
 InheritedType: String CSS Inheritance: yes
Name of the font to use.
Container
 InheritedType: String CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.

See also

flash.text.TextField
flash.text.GridFitType
Container
 InheritedType: Number CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.

See also

flash.text.TextField
Container
 InheritedType: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.
Container
 InheritedType: String CSS Inheritance: yes
Determines whether the text is italic font.
Container
 InheritedType: Number CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.

See also

flash.text.TextField
Container
 InheritedType: String CSS Inheritance: yes
Determines whether the text is boldface.
Container
 InheritedType: String CSS Inheritance: no
Horizontal alignment of children in the container.
Box
 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
  
horizontalDividerCursor
Type: Class CSS Inheritance: no
The cursor skin for a horizontal DividedBox. The default value is the "mx.skins.cursor.HBoxDivider" symbol in the Assets.swf file.
DividedBox
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between children in the horizontal direction.
Box
 InheritedType: String CSS Inheritance: no
The name of the horizontal scrollbar style.
Container
 InheritedType: String CSS Inheritance: yes
The primary interaction mode for this component.

See also

UIComponent
 InheritedType: Boolean CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
Container
 InheritedType: String CSS Inheritance: yes
Specifies the desired layout direction of a component.

See also

UIComponent
 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
 InheritedType: Number CSS Inheritance: yes
The number of additional pixels to appear between each character.
Container
 InheritedType: String CSS Inheritance: yes
The locale of the text displayed by this component.
Container
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the container's bottom border and the bottom of its content area.
Box
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.
Container
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.
Container
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the container's top border and the top of its content area.
Box
 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
 InheritedType: String CSS Inheritance: no Theme: halo
Direction of the drop shadow.
Container
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Distance of the drop shadow.
Container
 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
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of any symbol of a component.
Container
 InheritedType: String CSS Inheritance: yes
Alignment of text within a container.
Container
 InheritedType: String CSS Inheritance: yes
Determines whether the text is underlined.
Container
 InheritedType: Class CSS Inheritance: no
The class implementing IUITextField that is used by this component to render text.
Container
 InheritedType: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
Container
 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
 InheritedType: String CSS Inheritance: no
Vertical alignment of children in the container.
Box
 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
  
verticalDividerCursor
Type: Class CSS Inheritance: no
The cursor skin for a vertical DividedBox. The default value is the "mx.skins.cursor.VBoxDivider" symbol in the Assets.swf file.
DividedBox
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between children in the vertical direction.
Box
 InheritedType: String CSS Inheritance: no
The name of the vertical scrollbar style.
Container
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: 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
dividerClassproperty
protected var dividerClass:Class

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The class for the divider between the children.

The default value is mx.containers.dividedBoxClasses.BoxDivider.

liveDraggingproperty 
public var liveDragging:Boolean = false

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

If true, the children adjacent to a divider are continuously resized while the user drags it. If false, they are not resized until the user releases the divider.

The default value is false.

numDividersproperty 
numDividers:int  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The number of dividers. The count is always numChildren - 1.


Implementation
    public function get numDividers():int
resizeToContentproperty 
resizeToContent:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

If true, the DividedBox automatically resizes to the size of its children.

The default value is false.


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

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructor.

Method Detail
getDividerAt()method
public function getDividerAt(i:int):BoxDivider

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Returns a reference to the specified BoxDivider object in this DividedBox container or null if it doesn't exist.

Parameters

i:int — Zero-based index of a divider, counting from the left for a horizontal DividedBox, or from the top for a vertical DividedBox.

Returns
BoxDivider — A BoxDivider object.
moveDivider()method 
public function moveDivider(i:int, amt:Number):void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Move a specific divider a given number of pixels.

Parameters

i:int — Zero-based index of a divider, counting from the left for a horizontal DividedBox, or from the top for a vertical DividedBox.
 
amt:Number — The number of pixels to move the divider. A negative number can be specified in order to move a divider up or left. The divider movement is constrained in the same manner as if a user had moved it.

Event Detail
dividerDrag Event
Event Object Type: mx.events.DividerEvent
DividerEvent.type property = mx.events.DividerEvent.DIVIDER_DRAG

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Dispatched multiple times as the user drags any divider. The dividerDrag event is dispatched after the dividerPress event and before the dividerRelease event.

The DividerEvent.DIVIDER_DRAG constant defines the value of the type property of the event object for a dividerDrag event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
deltaContains the number of pixels that the divider has been dragged. Positive numbers represent a drag toward the right or bottom, negative numbers toward the left or top.
dividerIndexContains the zero-based index of the divider being dragged. The leftmost or topmost divider has a dividerIndex of 0.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dividerPress Event  
Event Object Type: mx.events.DividerEvent
DividerEvent.type property = mx.events.DividerEvent.DIVIDER_PRESS

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Dispatched when the user presses any divider in this container. The dividerPress event is dispatched before any dividerDrag events are dispatched.

The DividerEvent.DIVIDER_PRESS constant defines the value of the type property of the event object for a dividerPress event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
deltaContains the number of pixels that the divider has been dragged. Positive numbers represent a drag toward the right or bottom, negative numbers toward the left or top.
dividerIndexContains the zero-based index of the divider being dragged. The leftmost or topmost divider has a dividerIndex of 0.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dividerRelease Event  
Event Object Type: mx.events.DividerEvent
DividerEvent.type property = mx.events.DividerEvent.DIVIDER_RELEASE

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Dispatched when the user releases a divider. The dividerRelease event is dispatched after the dividerDrag events, but before the container's children are resized. The divider's x and y properties are not updated until after this event is triggered. As a result, a call to hDividerBox.getDividerAt(0).x will return the value of the original x position of the first divider. If you want the position of the divider after the move, you can access it when the DividerBox's updateComplete event has been triggered.

The DividerEvent.DIVIDER_RELEASE constant defines the value of the type property of the event object for a dividerRelease event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
deltaContains the number of pixels that the divider has been dragged. Positive numbers represent a drag toward the right or bottom, negative numbers toward the left or top.
dividerIndexContains the zero-based index of the divider being dragged. The leftmost or topmost divider has a dividerIndex of 0.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
Examples
DividedBoxExample.mxml
<?xml version="1.0"?>
<!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->
<!-- Simple example to demonstrate the Halo DividedBox layout container. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

    <s:Panel title="DividedBox Container Example"
           width="75%" height="75%"
           horizontalCenter="0" verticalCenter="0">
        <s:VGroup left="20" right="20" top="20" bottom="20">
            <s:Label width="100%" color="blue"
                text="A horizontal DividedBox container. Drag the divider side to side to resize the children."/>

            <mx:DividedBox direction="horizontal" width="100%" height="100%">
                <mx:Panel title="Panel 1" width="25%" height="100%" backgroundColor="0xCCCCCC">
                </mx:Panel>
                <mx:Panel title="Panel 2" width="25%" height="100%" backgroundColor="0xCCCCCC">
                </mx:Panel>
            </mx:DividedBox>
        </s:VGroup>
    </s:Panel>

</s:Application>