| Package | mx.containers |
| Class | public class Box |
| Inheritance | Box  Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Subclasses | ControlBar, DividedBox, Grid, HBox, NavBar, VBox |
direction property determines whether to use
vertical (default) or horizontal layout.
The Box class is the base class for the VBox and HBox classes.
You use the <mx:Box>, <mx:VBox>,
and <mx:HBox> tags to define Box containers.
A Box container has the following default sizing characteristics:
| Characteristic | Description |
|---|---|
| Default size | Vertical Box The height is large enough to hold all its children at the default or explicit height 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 Box The width is large enough to hold all of its children at the default width of the children, plus any horizontal gap between the children, plus the left and right padding of the container. The height is the default or explicit height of the tallest child, plus the top and bottom padding for the container. |
| Default padding | 0 pixels for the top, bottom, left, and right values. |
Hide MXML Syntax
The <mx:Box> tag inherits all of the tag
attributes of its superclass, and adds the following tag attributes:
Show MXML Syntax
<mx:Box
Properties
direction="vertical|horizontal"
Styles
horizontalAlign="left|center|right"
horizontalGap="8"
paddingBottom="0"
paddingTop="0"
verticalAlign="top|middle|bottom"
verticalGap="6"
>
...
child tags
...
</mx:Box>
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
| activeEffects : Array
[read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
| alpha : Number
Indicates the alpha transparency value of the object specified.
| DisplayObject | |
| autoLayout : Boolean
If true, measurement and layout are done
when the position or size of a child is changed.
| Container | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | |
| automationName : String
Name that can be used as an identifier for this object.
| UIComponent | |
| automationTabularData : Object
[read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data.
| UIComponent | |
| automationValue : Array
[read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | |
| baselinePosition : Number
[read-only]
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
| borderMetrics : EdgeMetrics
[read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom.
| Container | |
| buttonMode : Boolean
Specifies the button mode of this sprite.
| Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object.
| DisplayObject | |
| cacheHeuristic : Boolean
[write-only]
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
| childDescriptors : Array
[read-only]
Array of UIComponentDescriptor objects produced by the MXML compiler.
| Container | |
| className : String
[read-only]
The name of this instance's class, such as "Button".
| UIComponent | |
| clipContent : 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 | |
| constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| contentMouseX : Number
[read-only]
Returns the x position of the mouse, in the content coordinate system.
| Container | |
| contentMouseY : Number
[read-only]
Returns the y position of the mouse, in the content coordinate system.
| Container | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
| creatingContentPane : Boolean
Containers use an internal content pane to control scrolling.
| Container | |
| creationIndex : int
Specifies the order to instantiate and draw the children
of the container.
| Container | |
| creationPolicy : String
The child creation policy for this Container.
| Container | |
| currentState : String
The current view state of the component.
| UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | |
| data : Object
The data property lets you pass a value
to the component when you use it in an item renderer or item editor.
| Container | |
| defaultButton : IFlexDisplayObject
The Button control designated as the default button
for the container.
| Container | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance.
| UIComponent | |
| direction : String
The direction in which this Box container lays out its children.
| Box | ||
| document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
| doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives doubleClick events.
| UIComponent | |
| dropTarget : DisplayObject
[read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped.
| Sprite | |
| enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | |
| errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object.
| DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | |
| focusPane : Sprite
The focus pane associated with this object.
| UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
| graphics : Graphics
[read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur.
| Sprite | |
| height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
| Sprite | |
| horizontalLineScrollSize : Number
Number of pixels to move when the left- or right-arrow
button in the horizontal scroll bar is pressed.
| Container | |
| horizontalPageScrollSize : Number
Number of pixels to move when the track in the
horizontal scroll bar is pressed.
| Container | |
| horizontalScrollBar : ScrollBar
The horizontal scrollbar used in this container.
| Container | |
| horizontalScrollPolicy : String
Specifies whether the horizontal scroll bar is always present,
always absent, or automatically added when needed.
| Container | |
| horizontalScrollPosition : Number
The current position of the horizontal scroll bar.
| Container | |
| icon : Class
The Class of the icon displayed by some navigator
containers to represent this Container.
| Container | |
| id : String
ID of the component.
| UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | |
| instanceIndex : int
[read-only]
The index of a repeated component.
| UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | |
| isDocument : Boolean
[read-only]
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up.
| UIComponent | |
| label : String
The text displayed by some navigator containers to represent
this Container.
| Container | |
| loaderInfo : LoaderInfo
[read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs.
| DisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object.
| DisplayObject | |
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maxHorizontalScrollPosition : Number
[read-only]
The largest possible value for the
horizontalScrollPosition property.
| Container | |
| maxVerticalScrollPosition : Number
[read-only]
The largest possible value for the
verticalScrollPosition property.
| Container | |
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| mouseX : Number
[read-only]
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
| mouseY : Number
[read-only]
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
| nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | |
| numAutomationChildren : int
[read-only]
The number of automation children this container has.
| UIComponent | |
| numChildren : int
[read-only]
Number of child components in this container.
| Container | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
| owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
| parent : DisplayObjectContainer
[read-only]
The parent container or component for this component.
| UIComponent | |
| parentApplication : Object
[read-only]
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
| parentDocument : Object
[read-only]
A reference to the parent document object for this UIComponent.
| UIComponent | |
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens.
| UIComponent | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| rawChildren : IChildList
[read-only]
A container typically contains child components, which can be enumerated
using the Container.getChildAt() method and
Container.numChildren property.
| Container | |
| repeater : IRepeater
[read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
| repeaterIndex : int
[read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | |
| root : DisplayObject
[read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file.
| DisplayObject | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect.
| DisplayObject | |
| scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | |
| screen : Rectangle
[read-only]
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object.
| DisplayObject | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
| stage : Stage
[read-only]
The Stage of the display object.
| DisplayObject | |
| states : Array
The view states that are defined for this component.
| UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | |
| styleName : Object
The class style used by this component.
| UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled.
| DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order.
| InteractiveObject | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file.
| InteractiveObject | |
| textSnapshot : TextSnapshot
[read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance.
| DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip.
| UIComponent | |
| transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | |
| uid : String
A unique identifier for the object.
| UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the buttonMode property is set to true.
| Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
| verticalLineScrollSize : 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 | |
| verticalPageScrollSize : Number
Number of pixels to scroll when the track
in the vertical scroll bar is pressed.
| Container | |
| verticalScrollBar : ScrollBar
The vertical scrollbar used in this container.
| Container | |
| verticalScrollPolicy : String
Specifies whether the vertical scroll bar is always present,
always absent, or automatically added when needed.
| Container | |
| verticalScrollPosition : Number
The current position of the vertical scroll bar.
| Container | |
| viewMetrics : EdgeMetrics
[read-only]
Returns an object that has four properties: left,
top, right, and bottom.
| Container | |
| viewMetricsAndPadding : EdgeMetrics
[read-only]
Returns an object that has four properties: left,
top, right, and bottom.
| Container | |
| visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
| width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
| y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
|
Box()
Constructor.
| Box | ||
|
Adds a child DisplayObject to this Container.
| Container | |
|
Adds a child DisplayObject to this Container.
| Container | |
|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event.
| EventDispatcher | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point.
| DisplayObjectContainer | |
|
Queues a function to be called later.
| UIComponent | |
|
Deletes a style property from this component instance.
| UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself.
| DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates.
| Container | |
|
Converts a Point object from content to local coordinates.
| Container | |
|
Returns a set of properties that identify the child within
this container.
| UIComponent | |
|
Given a single UIComponentDescriptor, create the corresponding
component and add the component as a child of this Container.
| Container | |
|
Iterate through the Array of childDescriptors,
and call the createComponentFromDescriptor() method for each one.
| Container | |
|
Creates an id reference to this IUIComponent object
on its parent document object.
| UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object.
| UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | |
|
Dispatches an event into the event flow.
| UIComponent | |
|
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | |
|
Called by the effect instance when it stops playing on the component.
| UIComponent | |
|
Called by the effect instance when it starts playing on the component.
| UIComponent | |
|
Ends all currently playing effects on the component.
| UIComponent | |
|
Executes all the data bindings on this Container.
| Container | |
|
Executes the bindings into this Container's child UIComponent objects.
| Container | |
|
Called after printing is complete.
| UIComponent | |
|
Provides the automation object at the specified index.
| UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object.
| DisplayObject | |
|
Gets the nth child component object.
| Container | |
|
Returns the child whose name property is the specified String.
| Container | |
|
Gets the zero-based index of a specific child.
| Container | |
|
Returns an Array of DisplayObject objects consisting of the content children
of the container.
| Container | |
|
Finds the type selectors for this UIComponent instance.
| UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus.
| UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes.
| DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated.
| UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | |
|
Converts a Point object from global to content coordinates.
| Container | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates.
| DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
Indicates whether an object has a specified property defined.
| Object | |
|
Evaluates the display object to see if it overlaps or intersects with the
obj display object.
| DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters.
| DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient.
| UIComponent | |
|
Initializes the internal structure of this component.
| UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update.
| UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update.
| UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update.
| UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Converts a Point object from local to content coordinates.
| Container | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates.
| DisplayObject | |
|
Measures the specified HTML text, which may contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
Moves the component to a specified position within its parent.
| UIComponent | |
|
Propagates style changes to the children.
| UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent.
| UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | |
|
Method used to convert number of pixels to a
percentage relative to the contents of this container.
| Box | ||
|
Prepares an IFlexDisplayObject for printing.
| UIComponent | |
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well.
| UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | |
|
Removes all children from the child list of this container.
| Container | |
|
Removes a child DisplayObject from the child list of this Container.
| Container | |
|
Removes a child DisplayObject from the child list of this Container
at the specified index.
| Container | |
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
Replays the specified event.
| UIComponent | |
|
Resolves a child by using the id provided.
| UIComponent | |
|
[static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing().
| UIComponent | |
|
Sizes the object.
| UIComponent | |
|
Sets the index of a particular child.
| Container | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | |
|
Set the current state.
| UIComponent | |
|
Sets the focus to this component.
| UIComponent | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Sets a style property on this component instance.
| UIComponent | |
|
Called when the visible property changes.
| UIComponent | |
|
Lets the user drag the specified sprite.
| Sprite | |
|
Ends the startDrag() method.
| Sprite | |
|
Detects changes to style properties.
| UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized.
| UIComponent | |
|
[static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called.
| UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects.
| DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list.
| DisplayObjectContainer | |
|
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
Validates the position and size of children and draws other
visuals.
| UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method.
| UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements.
| UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component.
| UIComponent | |
|
Returns the primitive value of the specified object.
| Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient.
| UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle.
| UIComponent | |
|
Used internally by the Dissolve Effect to add the overlay to the chrome of a container.
| Container | |
|
Performs any final processing after child objects are created.
| UIComponent | |
|
Processes the properties set on the component.
| UIComponent | |
|
Creates the container's border skin
if it is needed and does not already exist.
| Container | |
|
Create child objects of the component.
| UIComponent | |
|
Creates a new object using a context
based on the embedded font being used.
| UIComponent | |
|
Creates the object using a given moduleFactory.
| UIComponent | |
|
The event handler called when a UIComponent object gets focus.
| UIComponent | |
|
The event handler called when a UIComponent object loses focus.
| UIComponent | |
|
Finalizes the initialization of this component.
| UIComponent | |
|
Initializes this component's accessibility code.
| UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
| UIComponent | |
|
The event handler called for a keyDown event.
| UIComponent | |
|
The event handler called for a keyUp event.
| UIComponent | |
|
Respond to size changes by setting the positions and sizes
of this container's borders.
| Container | |
|
Calculates the default sizes and minimum and maximum values of the Box
container.
| Box | ||
|
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 | |
|
Positions the container's content area relative to the viewable area
based on the horizontalScrollPosition and verticalScrollPosition properties.
| Container | |
|
Sets the size and position of each child of the Box container.
| Box | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: Number CSS Inheritance: no Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. | Container | ||
| Type: 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 | ||
| Type: uint Format: Color CSS Inheritance: no Background color of a component. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Background color of the component when it is disabled. | Container | ||
| Type: Object Format: File CSS Inheritance: no Background image of a component. | Container | ||
| Type: String CSS Inheritance: no Scales the image specified by backgroundImage to different percentage sizes. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Determines the color of a ProgressBar. | Container | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: no Color of the border. | Container | ||
| Type: String CSS Inheritance: no Bounding box sides. | Container | ||
| Type: Class CSS Inheritance: no The border skin class of the component. | Container | ||
| Type: String CSS Inheritance: no Bounding box style. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Bounding box thickness. | Container | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Radius of component corners. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | Container | ||
| Type: Number CSS Inheritance: no The alpha value for the overlay that is placed on top of the container when it is disabled. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow. | Container | ||
| Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | Container | ||
| Type: String CSS Inheritance: yes Name of the font to use. | Container | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | Container | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | Container | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | Container | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | Container | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | Container | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | Container | ||
|
horizontalAlign
| Type: String CSS Inheritance: no Horizontal alignment of children in the container. Possible values are "left", "center",
and "right".
The default value is "left", but some containers,
such as ButtonBar and ToggleButtonBar,
have different default values.
| Box | ||
| Type: 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 | ||
|
horizontalGap
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction. The default value depends on the component class; if not overriden for the class, the default value is 8. | Box | ||
| Type: String CSS Inheritance: no The name of the horizontal scrollbar style. | Container | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | Container | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Container | ||
|
paddingBottom
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's bottom border and the bottom of its content area. The default value is 0. | Box | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | Container | ||
|
paddingTop
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's top border and the top of its content area. The default value is 0. | Box | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
| Type: String CSS Inheritance: no Direction of the drop shadow. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow. | Container | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | Container | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | Container | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | ||
|
verticalAlign
| Type: String CSS Inheritance: no Vertical alignment of children in the container. Possible values are "top", "middle",
and "bottom".
The default value is "top", but some containers,
such as ButtonBar, ControlBar, LinkBar,
and ToggleButtonBar, have different default values.
| Box | ||
| Type: 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 | ||
|
verticalGap
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. The default value depends on the component class; if not overriden for the class, the default value is 6. | Box | ||
| Type: String CSS Inheritance: no The name of the vertical scrollbar style. | Container | ||
| direction | property |
direction:String [read-write]
The direction in which this Box container lays out its children.
Possible MXML values are
"horizontal" and "vertical".
Possible values in ActionScript are BoxDirection.HORIZONTAL
and BoxDirection.VERTICAL.
The default value is BoxDirection.VERTICAL.
This property can be used as the source for data binding.
public function get direction():String
public function set direction(value:String):void
| Box | () | Constructor |
public function Box()
Constructor.
| measure | () | method |
protected override function measure():void
Calculates the default sizes and minimum and maximum values of the Box container.
If the Box container's direction property is set to
BoxDirection.HORIZONTAL, its measuredWidth
property is equal to the sum of default widths of all of its children,
plus the thickness of the borders, plus the left and right padding,
plus the horizontal gap between each child.
The value of the measuredHeight property is the maximum of
all the children's default heights, plus room for the borders and
padding.
If the Box container's direction property is set to
BoxDirection.VERTICAL, these two values are reversed.
The Box container's minWidth and minHeight
properties are calculated similarly, by combining the minimum widths
and minimum heights of the children.
If the child's width property is a percentage value, the
Box container's minimum width is equal to the value of the child's
minWidth property.
If the child's width is unset or set to a fixed value,
the child refuses to grow or shrink, so the Box container's minimum
width is equal to the value of the child's explicitWidth
property.
The child's minimum height is calculated similarly.
The Box container's maxWidth and
maxHeight properties are not calculated.
The Box container is assumed to have an infinite maximum width and
height.
All of the values described previously are the measured widths and heights of the Box container. The user can override the measured values by explicitly supplying a value for the following properties:
width
height
minWidth
minHeight
maxWidth
maxHeight
You should not call the measure() method directly.
The Flex LayoutManager calls it at the appropriate time.
At application startup, the Flex LayoutManager attempts to measure
all components from the children to the parents before setting them
to their final sizes.
This is an advanced method for use in subclassing.
If you override this method, your implementation must call
the super.measure() method, or set the
measuredHeight and
measuredWidth properties.
You may also optionally set the following properties:
measuredMinWidth
measuredMinHeight
These properties correspond to the layout properties listed previously and, therefore, are not separately documented.
| pixelsToPercent | () | method |
public function pixelsToPercent(pxl:Number):Number
Method used to convert number of pixels to a percentage relative to the contents of this container.
The percentage value is relevant only while the container does not change size or layout. After a resize and/or new layout has occurred, the value returned from this method may be stale.
An example of how this method could be used would be to restore a component's size to a specific number of pixels after hiding it.
Parameters
pxl:Number — The number of pixels for which a percentage
value is desired.
|
Number — The percentage value that would be equivalent
to pxl under the current layout conditions
of this container.
A negative value indicates that the container must grow
in order to accommodate the requested size.
|
| updateDisplayList | () | method |
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sets the size and position of each child of the Box container.
To understand the layout algorithm for the Box container, assume that the Box container's direction is horizontal.
All of the Box container's children are positioned side-by-side in a
single horizontal row, with horizontalGap pixels between
each pair of adjacent children.
Initially, the widths of children without an explicit
width value are set equal to the values of their
measuredWidth properties.
If the sum of the values of the measuredWidth
properties of the children is greater than or less than the width of
the Box container, and if some of the children have a percentage value
for the width property, the sizes of those children are
grown or shrunk until all children exactly fit in the Box.
However, no child is shrunk to less than the value of its
minWidth property or increased greater than the value of
its maxWidth property.
Among the growing (or shrinking) children, extra space is added
(or removed) in proportion to the child's percentWidth.
For example, a child with a percentWidth of 40 percent
will grow twice as much as a child with a percentWidth of
20 percent until all of the available space is filled or the prescribed
sizes are reached.
After all flexible children have grown or shrunk, Flex checks to see
if the sum of the children's widths match the width of the Box
container.
If not, the group of children are all shifted according to the value
of the Box container's horizontalAlign property, so the
children are aligned with the left edge of the Box, aligned with the
right edge of the Box, or centered in the middle of the Box.
To determine the height of each child, Flex examines the value
of the child's height property.
If the height is unset, the child's height
is set to its measuredHeight.
If the height is set to a pixel value, that value is used.
If the height is set to a percentage value,
the child's height is grown or shrunk to match the specified
percentage of the height of the Box, as long as the child's height
is not shrunk to less than the value of its minHeight
property or grown to be larger than the value of its
maxHeight property.
The vertical position of each child is determined by
the Box container's verticalAlign property.
Each child is shifted so that it is aligned with the top edge
of the box, aligned with the bottom edge of the box,
or centered in the Box.
If the Box container's direction is
vertical, the same rules apply, except that the widths and
heights are swapped.
The children are arranged in a single vertical column.
You should not call this method directly.
The Flex LayoutManager calls it at the appropriate time.
At application startup, the Flex LayoutManager calls the
updateDisplayList() method on every component,
starting with the Application object and working downward.
This is an advanced method for use in subclassing.
If you override this method, your implementation should call the
super.updateDisplayList() method and call the
move() and setActualSize() methods
on each of the children.
For the purposes of performing layout, you should get the size
of this container from the unscaledWidth and
unscaledHeight properties, not the width
and height properties.
The width and height properties
do not take into account the values of the scaleX
and scaleY properties for this container.
Parameters
unscaledWidth:Number — Specifies the width of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleX property of the component.
|
|
unscaledHeight:Number — Specifies the height of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleY property of the component.
|
<?xml version="1.0"?>
<!-- Simple example to demonstrate the Box layout container. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Panel title="Box Container Example" height="75%" width="75%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:Label width="100%" color="blue"
text="A Box container with vertically aligned children."/>
<mx:Box direction="vertical" borderStyle="solid"
paddingTop="10" paddingBottom="10" paddingLeft="10" paddingRight="10">
<mx:Button label="Button 1"/>
<mx:Button label="Button 2"/>
<mx:Button label="Button 3"/>
<mx:ComboBox/>
</mx:Box>
<mx:Label width="100%" color="blue"
text="A Box container with horizontally aligned children."/>
<mx:Box direction="horizontal" borderStyle="solid"
paddingTop="10" paddingBottom="10" paddingLeft="10" paddingRight="10">
<mx:Button label="Button 1"/>
<mx:Button label="Button 2"/>
<mx:Button label="Button 3"/>
<mx:ComboBox/>
</mx:Box>
</mx:Panel>
</mx:Application>