Package | com.ghostwire.ui.containers |
Class | public class uiTabView |
Inheritance | uiTabView ![]() ![]() |
Subclasses | uiBTabView |
uiTabView
component represents a tabbed set of pages - the component displays the page
corresponding to the currently selected tab in a shared content area.
"model" Property
The model
property is used to populate the uiTabView
component - each item in
the model represents a page in the collection. See the entry for the model
property for
details. Do not attempt to use addChild()
or addChildAt()
- doing so will
throw an error.
"skin" Property
The default value is "TabView"
and the asset(s) used are:
TabViewBar.png TabViewBarItem.png TabViewBarStepperDown.png TabViewBarStepperUp.png TabViewContent.png
Default Size
The component has a default desired size of 200 x 200 (width x height) if it is not populated
before it is realized (added to the display list for the first time). Otherwise, its desired
size will depends on its contents.
~ 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 | |
content : DisplayObject [read-only]
Returns the child object currently displayed in the content area.
| uiTabView | ||
![]() | 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 | |
model : uiModel
Indicates the
uiModel used to populate this uiTabView . | uiTabView | ||
![]() | 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 | |
selectedIndex : int
Indicates the
index position of the currently selected tab. | uiTabView | ||
![]() | skin : String
Indicates the name of the skin to use for this component instance.
| uiComponent | |
![]() | 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 | |
uiframe : uiFrame
[read-only]
Returns the embedded
uiFrame instance - for advanced users only. | uiTabView | ||
![]() | uiskin : uiBitmapImage
Returns the
uiBitmapImage rendered as the skin - for advanced users only. | uiComponent | |
uitabviewbar : uiTabViewBar
[read-only]
Returns the embedded
uiTabViewBar instance - for advanced users only. | uiTabView | ||
![]() | 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 | ||
---|---|---|---|
Constructor - creates a new
uiTabView instance. | uiTabView | ||
![]() |
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 |
Event | Summary | Defined by | ||
---|---|---|---|---|
Dispatched when the current selected tab has changed. | uiTabView | |||
![]() |
Dispatched when the component's visible property is changed from true to
false via calling the setVisible() method. | uiComponent | ||
![]() |
Dispatched when the component's position within its parent container has changed via calling the
move() method. | uiComponent | ||
![]() |
Dispatched when the component's size has changed via calling the setSize() method. | uiComponent | ||
![]() |
Dispatched when the component's visible property is changed from false to
true via calling the setVisible() method. | uiComponent |
content | property |
content:DisplayObject
[read-only]Returns the child object currently displayed in the content area.
Implementation public function get content():DisplayObject
model | property |
model:uiModel
[read-write]
Indicates the uiModel
used to populate this uiTabView
.
Each item in the model represents a page in the collection and should carry the
following properties:
label
The text to display in the tab button.
child
The child DisplayObject
to display when the
tab is selected; this can be any DisplayObject
, including
uiComponent
instances (typically, you would use a container
pre-populated with the user interface intended for the selected tab page).
image
The image to display in the tab button (
itemRenderer
must be set to uiImage
, uiLabel
or another renderer class capable of displaying the image).
Setting this property to null
will set it to a new empty uiModel
.
The default value is an empty uiModel object
.
public function get model():uiModel
public function set model(value:uiModel):void
See also
selectedIndex | property |
selectedIndex:int
[read-write]
Indicates the index
position of the currently selected tab.
Setting this property selects the tab at the indicated index
position.
The default value is 0
.
public function get selectedIndex():int
public function set selectedIndex(value:int):void
uiframe | property |
uiframe:uiFrame
[read-only]
Returns the embedded uiFrame
instance - for advanced users only. This property
is exposed in case you would like greater control over the embedded uiFrame
instance.
public function get uiframe():uiFrame
uitabviewbar | property |
uitabviewbar:uiTabViewBar
[read-only]
Returns the embedded uiTabViewBar
instance - for advanced users only. This property
is exposed in case you would like greater control over the embedded uiTabViewBar
instance.
public function get uitabviewbar():uiTabViewBar
uiTabView | () | constructor |
public function uiTabView()
Constructor - creates a new uiTabView
instance.
change | event |