Packagecom.gestureworks.cml.elements
Classpublic class Tab
InheritanceTab Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The Tab element is a container with a tab extension. The container's contents will be visible when the selected state is true and hidden othewise. Intended to be grouped and toggled between other tab elements in a TabbedContainer.
         
        var tab:Tab = new Tab();
        tab.title = "tab1";
        tab.init();
        addChild(tab);
        
        var square:Graphic = new Graphic();
        square.color = 0x00FF00;
        square.shape = "rectangle";
        square.width = 200;
        square.height = 200;
        square.y = 100;
        tab.addChild(square);
     
     

See also

TabbedContainer


Public Properties
 PropertyDefined By
  applyMask : Boolean
Mask the content to prevent objects from exceeding the boundaries
Tab
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
  displayBottomLeftRadius : Number
The radius of the lower left corner of the display in pixels
Tab
  displayBottomRightRadius : Number
The radius of the lower right corner of the display in pixels
Tab
  displayColor : uint
The background color of the container
Tab
  displayLeftRadius : Number
Deprecated: Please Use displayTopLeftRadius
Tab
  displayRightRadius : Number
Deprecated: Please Use displayTopRightRadius
Tab
  displayTopLeftRadius : Number
The radius of the upper left corner of the display in pixels
Tab
  displayTopRightRadius : Number
The radius of the upper right corner of the display in pixels
Tab
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
  height : Number
[override] The height of the container
Tab
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedid : String
Returns the object's id.
TouchContainer
  isSelected : Boolean
The selected state of the tab container
Tab
  layout : *
[override] Return layout from content container
Tab
 InheritedlayoutList : Dictionary
TouchContainer
  mouseChildren : Boolean
[override] Sets the mouseChildren flag
Tab
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
  tabFont : String
The font of tab's text
Tab
  tabFontColor : Number
The font color of the tab's text
Tab
  tabFontSize : Number
The font size of the tab's text
Tab
  tabHeight : Number
The height of the tab
Tab
  tabLeftRadius : Number
The radius of the upper left corner of the tab in pixels
Tab
  tabRightRadius : Number
The radius of the upper right corner of the tab in pixels
Tab
  tabWidth : Number
The width of the tab
Tab
  tabX : Number
The the x location of the tab relative to the tab container
Tab
  title : String
The text displayed on the container's tab
Tab
 InheritedtoBitmap : Boolean
TouchContainer
  width : Number
[override] The width of the container
Tab
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Tab()
Constructor
Tab
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
  
addChild(child:DisplayObject):DisplayObject
[override] Reroutes children addition to the content container
Tab
  
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Reroutes children addition at a specified index to the content container
Tab
  
applyLayout(value:* = null):void
[override] Apply layout to content container
Tab
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
dispose():void
[override] Destructor
Tab
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
init():void
[override] Initialization call
Tab
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Property Detail
applyMaskproperty
applyMask:Boolean

Mask the content to prevent objects from exceeding the boundaries


Implementation
    public function get applyMask():Boolean
    public function set applyMask(value:Boolean):void
displayBottomLeftRadiusproperty 
displayBottomLeftRadius:Number

The radius of the lower left corner of the display in pixels


Implementation
    public function get displayBottomLeftRadius():Number
    public function set displayBottomLeftRadius(value:Number):void
displayBottomRightRadiusproperty 
displayBottomRightRadius:Number

The radius of the lower right corner of the display in pixels


Implementation
    public function get displayBottomRightRadius():Number
    public function set displayBottomRightRadius(value:Number):void
displayColorproperty 
displayColor:uint

The background color of the container

The default value is 0x000000.


Implementation
    public function get displayColor():uint
    public function set displayColor(value:uint):void
displayLeftRadiusproperty 
displayLeftRadius:Number
Deprecated: Please Use displayTopLeftRadius


Implementation
    public function get displayLeftRadius():Number
    public function set displayLeftRadius(value:Number):void
displayRightRadiusproperty 
displayRightRadius:Number
Deprecated: Please Use displayTopRightRadius


Implementation
    public function get displayRightRadius():Number
    public function set displayRightRadius(value:Number):void
displayTopLeftRadiusproperty 
displayTopLeftRadius:Number

The radius of the upper left corner of the display in pixels


Implementation
    public function get displayTopLeftRadius():Number
    public function set displayTopLeftRadius(value:Number):void
displayTopRightRadiusproperty 
displayTopRightRadius:Number

The radius of the upper right corner of the display in pixels


Implementation
    public function get displayTopRightRadius():Number
    public function set displayTopRightRadius(value:Number):void
heightproperty 
height:Number[override]

The height of the container

The default value is 385.


Implementation
    public function get height():Number
    public function set height(value:Number):void
isSelectedproperty 
isSelected:Boolean

The selected state of the tab container


Implementation
    public function get isSelected():Boolean
    public function set isSelected(value:Boolean):void
layoutproperty 
layout:*[override]

Return layout from content container


Implementation
    public function get layout():*
    public function set layout(value:any):void
mouseChildrenproperty 
mouseChildren:Boolean[override]

Sets the mouseChildren flag


Implementation
    public function get mouseChildren():Boolean
    public function set mouseChildren(value:Boolean):void
tabFontproperty 
tabFont:String

The font of tab's text

The default value is OpenSansRegular.


Implementation
    public function get tabFont():String
    public function set tabFont(value:String):void
tabFontColorproperty 
tabFontColor:Number

The font color of the tab's text

The default value is 0xFFFFFF.


Implementation
    public function get tabFontColor():Number
    public function set tabFontColor(value:Number):void
tabFontSizeproperty 
tabFontSize:Number

The font size of the tab's text

The default value is 20.


Implementation
    public function get tabFontSize():Number
    public function set tabFontSize(value:Number):void
tabHeightproperty 
tabHeight:Number

The height of the tab


Implementation
    public function get tabHeight():Number
    public function set tabHeight(value:Number):void
tabLeftRadiusproperty 
tabLeftRadius:Number

The radius of the upper left corner of the tab in pixels


Implementation
    public function get tabLeftRadius():Number
    public function set tabLeftRadius(value:Number):void
tabRightRadiusproperty 
tabRightRadius:Number

The radius of the upper right corner of the tab in pixels


Implementation
    public function get tabRightRadius():Number
    public function set tabRightRadius(value:Number):void
tabWidthproperty 
tabWidth:Number

The width of the tab


Implementation
    public function get tabWidth():Number
    public function set tabWidth(value:Number):void
tabXproperty 
tabX:Number

The the x location of the tab relative to the tab container


Implementation
    public function get tabX():Number
    public function set tabX(value:Number):void
titleproperty 
title:String

The text displayed on the container's tab

The default value is "".


Implementation
    public function get title():String
    public function set title(value:String):void
widthproperty 
width:Number[override]

The width of the container

The default value is 500.


Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor Detail
Tab()Constructor
public function Tab()

Constructor

Method Detail
addChild()method
override public function addChild(child:DisplayObject):DisplayObject

Reroutes children addition to the content container

Parameters

child:DisplayObject — object to add

Returns
DisplayObject — the object added
addChildAt()method 
override public function addChildAt(child:DisplayObject, index:int):DisplayObject

Reroutes children addition at a specified index to the content container

Parameters

child:DisplayObject — object to add
 
index:int — the content container's index

Returns
DisplayObject — the object added
applyLayout()method 
override public function applyLayout(value:* = null):void

Apply layout to content container

Parameters

value:* (default = null)

dispose()method 
override public function dispose():void

Destructor

init()method 
override public function init():void

Initialization call