Package | com.ghostwire.ui.containers |
Class | public class uiBox |
Inheritance | uiBox ![]() ![]() |
Subclasses | uiHBox, uiVBox |
uiBox
is a layout container that organizes its child objects sequentially horizontally
or vertically. uiBox
can contain only uiComponent
child objects.
"skin" Property
Always null
- attempting to set this property will throw an error.
~ This class is available in Aspire UI Components Lite Edition ~
Property | Defined by | ||
---|---|---|---|
![]() | alignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
| uiComponent | |
![]() | alignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
| uiComponent | |
![]() | background : Object
Indicates the style of the background for this component.
| uiComponent | |
![]() | container : uiComponent
Indicates the
uiComponent instance that contains this instance. | uiComponent | |
![]() | depth : int
Indicates how deep the component is in the containment hierarchy.
| uiComponent | |
![]() | desiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
| uiComponent | |
![]() | desiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
| uiComponent | |
![]() | enabled : Boolean
Indicates whether the component is enabled for user interaction.
| uiComponent | |
![]() | fillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated
horizontal space.
| uiComponent | |
![]() | fillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated
vertical space.
| uiComponent | |
![]() | focusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus
rectangle.
| uiComponent | |
![]() | focusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it
is in focus.
| uiComponent | |
![]() | height : Number
Indicates the current
height of the component. | uiComponent | |
![]() | margin : Object
Indicates the thickness of the space surrounding the component.
| uiComponent | |
![]() | maxHeight : int
Indicates the upper limit for
height . | uiComponent | |
![]() | maxWidth : int
Indicates the upper limit for
width . | uiComponent | |
![]() | minHeight : int
Indicates the lower limit for
height . | uiComponent | |
![]() | minWidth : int
Indicates the lower limit for
width . | uiComponent | |
![]() | padding : Object
Indicates the thickness of the interior space from the edge of the component to the content area,
which is where child components, if any, are contained.
| uiComponent | |
reversed : Boolean
Indicates whether child objects should be laid out in reversed order.
| uiBox | ||
![]() | skin : String
Indicates the name of the skin to use for this component instance.
| uiComponent | |
spacing : int
Indicates the gap between each child, in pixels.
| uiBox | ||
![]() | stretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this
component.
| uiComponent | |
![]() | textStyle : String
Indicates the style to use for
uiText instances contained in this component. | uiComponent | |
![]() | toolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers
over this control.
| uiComponent | |
![]() | uiskin : uiBitmapImage
Returns the
uiBitmapImage rendered as the skin - for advanced users only. | uiComponent | |
uniform : Boolean
Indicates whether child objects should be allocated equal space.
| uiBox | ||
vertical : Boolean
Indicates whether child objects should be laid out vertically (property set to
true )
or horizontally (property set to false ). | uiBox | ||
![]() | visible : Boolean
Indicates whether or not the component is visible within its container.
| uiComponent | |
![]() | width : Number
Indicates the current
width of the component. | uiComponent |
Method | Defined by | ||
---|---|---|---|
uiBox()
Constructor - creates a new
uiBox instance. | uiBox | ||
addChild(child:DisplayObject):DisplayObject
Adds a child
uiComponent instance to this container. | uiBox | ||
addChildAt(child:DisplayObject, index:int):DisplayObject
Adds a child
uiComponent instance to this container at the
specified index position. | uiBox | ||
bringToFront(child:DisplayObject):void
Brings the specified
child to the front (top) of all other children in this container. | uiBox | ||
![]() |
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
| uiComponent | |
![]() |
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
| uiComponent | |
![]() |
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
| uiComponent | |
![]() |
setFocus(flag:Boolean = true):void
Gives this component instance the focus; the component must be on the display list and has its
tabEnabled property set to true , otherwise this method will fail
silently. | uiComponent | |
![]() |
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified
width and height . | uiComponent | |
![]() |
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
| uiComponent | |
![]() |
validateNow():void
Validates and render the component instance, and any component instances with
depth higher than itself in the validation queue, immediately. | uiComponent |
reversed | property |
reversed:Boolean
[read-write]
Indicates whether child objects should be laid out in reversed order. By default, child objects are
laid out from left-to-right horizontally (vertical
property false
) or
top-to-bottom vertically (vertical
property true
). If reversed
is set to true
, child objects will be laid out in reversed order from right-to-left
horizontally or bottom-to-top vertically.
The default value is false
.
public function get reversed():Boolean
public function set reversed(value:Boolean):void
spacing | property |
spacing:int
[read-write]Indicates the gap between each child, in pixels.
The default value is 0
.
public function get spacing():int
public function set spacing(value:int):void
uniform | property |
uniform:Boolean
[read-write]
Indicates whether child objects should be allocated equal space. Setting this property to
true
will disregard the stretch
property of the child components.
The default value is false
.
public function get uniform():Boolean
public function set uniform(value:Boolean):void
See also
vertical | property |
vertical:Boolean
[read-write]
Indicates whether child objects should be laid out vertically (property set to true
)
or horizontally (property set to false
). The default value is false
,
indicating that child objects will be laid out horizontally.
The default value is false
.
public function get vertical():Boolean
public function set vertical(value:Boolean):void
uiBox | () | constructor |
public function uiBox()
Constructor - creates a new uiBox
instance.
addChild | () | method |
public override function addChild(child:DisplayObject):DisplayObject
Adds a child uiComponent
instance to this container. The child is added
to the front (top) of all other children in this container.
Note that the order of the layout will be the same as the order you addChild()
to the uiBox
container. Adding a child object invalidates the layout.
child:DisplayObject — The uiComponent instance to add to the container.
|
DisplayObject |
See also
addChildAt | () | method |
public override function addChildAt(child:DisplayObject, index:int):DisplayObject
Adds a child uiComponent
instance to this container at the
specified index
position.
Note that the order of the layout will be the same as the order you addChild()
to the uiBox
container. Adding a child object invalidates the layout.
child:DisplayObject — The uiComponent instance to add to the container.
|
|
index:int — The index position at which to insert the child.
|
DisplayObject |
See also
bringToFront | () | method |
public function bringToFront(child:DisplayObject):void
Brings the specified child
to the front (top) of all other children in this container.
Applicable only if the spacing
property is a negative number.
child:DisplayObject |