Packagecom.ghostwire.ui.controls
Classpublic class uiTabViewBar
InheritanceuiTabViewBar Inheritance uiComponent Inheritance flash.display.Sprite
SubclassesuiMenuBar

The uiTabViewBar class is used to display a row of selectable tab buttons. This class is used by the uiTabView container class.

You would typically not use this class directly in your application code.

"skin" Property
The default value is "TabViewBar" and the asset(s) used are:

 TabViewBar.png
 TabViewBarItem.png
 

~ This class is available in Aspire UI Components Lite Edition ~

See also

com.ghostwire.ui.containers.uiTabView


Public Properties
 PropertyDefined by
 InheritedalignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
uiComponent
 InheritedalignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
uiComponent
 Inheritedbackground : Object
Indicates the style of the background for this component.
uiComponent
 Inheritedcontainer : uiComponent
Indicates the uiComponent instance that contains this instance.
uiComponent
  dataMap : Object
Indicates an object used to map properties in the renderers to properties in the data objects (items).
uiTabViewBar
 Inheriteddepth : int
Indicates how deep the component is in the containment hierarchy.
uiComponent
 InheriteddesiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
uiComponent
 InheriteddesiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
uiComponent
 Inheritedenabled : Boolean
Indicates whether the component is enabled for user interaction.
uiComponent
 InheritedfillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated horizontal space.
uiComponent
 InheritedfillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated vertical space.
uiComponent
 InheritedfocusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus rectangle.
uiComponent
 InheritedfocusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it is in focus.
uiComponent
 Inheritedheight : Number
Indicates the current height of the component.
uiComponent
  itemRenderer : Class
Indicates the class to use to paint the "face" of the item.
uiTabViewBar
 Inheritedmargin : Object
Indicates the thickness of the space surrounding the component.
uiComponent
 InheritedmaxHeight : int
Indicates the upper limit for height.
uiComponent
 InheritedmaxWidth : int
Indicates the upper limit for width.
uiComponent
 InheritedminHeight : int
Indicates the lower limit for height.
uiComponent
 InheritedminWidth : int
Indicates the lower limit for width.
uiComponent
  model : uiModel
Indicates the uiModel used to populate this uiTabViewBar.
uiTabViewBar
 Inheritedpadding : 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.
uiTabViewBar
 Inheritedskin : String
Indicates the name of the skin to use for this component instance.
uiComponent
  spacing : int
Indicates the spacing between tab buttons.
uiTabViewBar
 Inheritedstretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this component.
uiComponent
 InheritedtextStyle : String
Indicates the style to use for uiText instances contained in this component.
uiComponent
 InheritedtoolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers over this control.
uiComponent
 Inheriteduiskin : uiBitmapImage
Returns the uiBitmapImage rendered as the skin - for advanced users only.
uiComponent
  uistepper : uiStepper
[read-only] Returns the embedded uiStepper instance - for advanced users only.
uiTabViewBar
 Inheritedvisible : Boolean
Indicates whether or not the component is visible within its container.
uiComponent
 Inheritedwidth : Number
Indicates the current width of the component.
uiComponent
Public Methods
 MethodDefined by
  
Constructor - creates a new uiTabViewBar instance.
uiTabViewBar
 Inherited
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
uiComponent
 Inherited
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
uiComponent
 Inherited
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
uiComponent
 Inherited
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
 Inherited
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified width and height.
uiComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
uiComponent
 Inherited
validateNow():void
Validates and render the component instance, and any component instances with depth higher than itself in the validation queue, immediately.
uiComponent
Events
 EventSummaryDefined by
   Dispatched when the current selected tab has changed.uiTabViewBar
 Inherited Dispatched when the component's visible property is changed from true to false via calling the setVisible() method.uiComponent
 Inherited Dispatched when the component's position within its parent container has changed via calling the move() method.uiComponent
 Inherited Dispatched when the component's size has changed via calling the setSize() method.uiComponent
 Inherited Dispatched when the component's visible property is changed from false to true via calling the setVisible() method.uiComponent
Property detail
dataMapproperty
dataMap:Object  [read-write]

Indicates an object used to map properties in the renderers to properties in the data objects (items).

For example, if you are using uiLabel as the renderer, you can map the image property of the uiLabel to an image property in the item, and the text property in uiLabel to a label property in the item, as follows:
myListBox.dataMap = {text:"label",image:"image"};

The above example happens to describe the default dataMap used if none is specified (property set to null).

Instead of mapping to a property in the data object, you can also map to a custom callback function. The function must accept one single parameter (the data object used to describe the item) and must return the value to be used for the specified property in the renderer.

Implementation
    public function get dataMap():Object
    public function set dataMap(value:Object):void
itemRendererproperty 
itemRenderer:Class  [read-write]

Indicates the class to use to paint the "face" of the item. Suitable classes include uiText, uiLabel and uiImage.

When set to null (default value), the uiText class is used.

The default value is null.

Implementation
    public function get itemRenderer():Class
    public function set itemRenderer(value:Class):void
modelproperty 
model:uiModel  [read-write]

Indicates the uiModel used to populate this uiTabViewBar.

Each item in the model 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.

Implementation
    public function get model():uiModel
    public function set model(value:uiModel):void

See also

selectedIndexproperty 
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.

Implementation
    public function get selectedIndex():int
    public function set selectedIndex(value:int):void
spacingproperty 
spacing:int  [read-write]

Indicates the spacing between tab buttons.

Implementation
    public function get spacing():int
    public function set spacing(value:int):void

See also

uistepperproperty 
uistepper:uiStepper  [read-only]

Returns the embedded uiStepper instance - for advanced users only. This property is exposed in case you would like greater control over the embedded uiStepper instance.

Implementation
    public function get uistepper():uiStepper
Constructor detail
uiTabViewBar()constructor
public function uiTabViewBar()

Constructor - creates a new uiTabViewBar instance.

Event detail
changeevent 
Event object type: flash.events.Event

Dispatched when the current selected tab has changed.