Package | mx.containers |
Class | public class TabNavigator |
Inheritance | TabNavigator ViewStack Container UIComponent FlexSprite flash.display.Sprite |
Implements | IFocusManagerComponent |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Note: The direct children of an MX navigator container must be MX containers, either MX layout or MX navigator containers, or the Spark NavigatorContent container. You cannot directly nest a control or a Spark container other than the Spark NavigatorContent container within a navigator; they must be children of an child MX container.
Like a ViewStack container, a TabNavigator container has a collection of child containers, in which only one child at a time is visible. Flex automatically creates a TabBar container at the top of the TabNavigator container, with a tab corresponding to each child container. Each tab can have its own label and icon. When the user clicks a tab, the corresponding child container becomes visible as the selected child of the TabNavigator container.
When you change the currently visible child container,
you can use the hideEffect
property of the container being
hidden and the showEffect
property of the newly visible child
container to apply an effect to the child containers.
The TabNavigator container waits for the hideEffect
of the
child container being hidden to complete before it reveals the new child
container.
You can interrupt a currently playing effect if you change the
selectedIndex
property of the TabNavigator container
while an effect is playing.
To define the appearance of tabs in a TabNavigator, you can define style properties in a Tab type selector, as the following example shows:
<fx:Style> @namespace mx "library://ns.adobe.com/flex/mx" mx|Tab { fillColors: #006699, #cccc66; upSkin: ClassReference("CustomSkinClass"); overSkin: ClassReference("CustomSkinClass"); downSkin: ClassReference("CustomSkinClass"); } </fx:Style>
The Tab type selector defines values on the hidden mx.controls.tabBarClasses.Tab class. The default values for the Tab type selector are defined in the defaults.css file.
You can also define the styles in a class selector that you specify using
the tabStyleName
style property; for example:
<fx:Style> @namespace mx "library://ns.adobe.com/flex/mx" mx|TabNavigator { tabStyleName:myTabStyle; } .myTabStyle { fillColors: #006699, #cccc66; upSkin: ClassReference("CustomSkinClass"); overSkin: ClassReference("CustomSkinClass"); downSkin: ClassReference("CustomSkinClass"); } </fx:Style>
A TabNavigator container has the following default sizing characteristics:
Characteristic | Description |
---|---|
Default size | The default or explicit width and height of the first active child plus the tabs, at their default or explicit heights and widths. Default tab height is determined by the font, style, and skin applied to the TabNavigator container. |
Container resizing rules | By default, TabNavigator containers are only sized once to fit the size of the first child container. They do not resize when you navigate to other child containers. To force TabNavigator containers to resize when you navigate to a different child container, set the resizeToContent property to true. |
Child layout rules | If the child is larger than the TabNavigator container, it is clipped. If the child is smaller than the TabNavigator container, it is aligned to the upper-left corner of the TabNavigator container. |
Default padding | 0 pixels for the top, bottom, left, and right values. |
The <mx:TabNavigator>
tag inherits all of the
tag attributes of its superclass,
and adds the following tag attributes:
<mx:TabNavigator Styles firstTabStyleName="Value of thetabStyleName
property" focusAlpha="0.4" focusRoundedCorners="tl tr bl br" horizontalAlign="left|center|right" horizontalGap="-1" lastTabStyleName="Value of thetabStyleName
property" selectedTabTextStyleName="undefined" tabHeight="undefined" tabOffset="0" tabStyleName="Name of CSS style declaration that specifies styles for the tabs" tabWidth="undefined" > ... child tags ... </mx:TabNavigator>
See also
Property | Defined By | ||
---|---|---|---|
actualCreationPolicy : String
The creation policy of this container. | Container | ||
contentHeight : Number [read-only]
The height of the area, in pixels, in which content is displayed. | ViewStack | ||
contentWidth : Number [read-only]
The width of the area, in pixels, in which content is displayed. | ViewStack | ||
contentX : Number [read-only]
The x coordinate of the area of the ViewStack container
in which content is displayed, in pixels. | ViewStack | ||
contentY : Number [read-only]
The y coordinate of the area of the ViewStack container
in which content is displayed, in pixels. | ViewStack | ||
currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | ||
hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | ||
resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | ||
tabBar : TabBar
A reference to the TabBar inside this TabNavigator. | TabNavigator | ||
tabBarStyleFilters : Object [read-only]
The set of styles to pass from the TabNavigator to the tabBar. | TabNavigator | ||
unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | ||
unscaledWidth : Number [read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList(). | UIComponent |
Method | Defined By | ||
---|---|---|---|
Constructor. | TabNavigator | ||
addChild(child:DisplayObject):DisplayObject [override]
Adds a child DisplayObject to this Container. | Container | ||
addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds a child DisplayObject to this Container. | Container | ||
Adds a visual element to this container. | Container | ||
Adds a visual element to this container. | Container | ||
addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | ||
callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | ||
clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | ||
contentToGlobal(point:Point):Point [override]
Converts a Point object from content coordinates to global coordinates. | Container | ||
contentToLocal(point:Point):Point [override]
Converts a Point object from content to local coordinates. | Container | ||
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | ||
createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs 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 | ||
createComponentsFromDescriptors(recurse:Boolean = true):void
Iterate through the Array of childDescriptors,
and call the createComponentFromDescriptor() method for each one. | Container | ||
createDeferredContent():void
Performs the equivalent action of calling
the createComponentsFromDescriptors(true) method for containers
that implement the IDeferredContentOwner interface to support deferred instantiation. | Container | ||
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
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 | ||
dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | ||
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component. | UIComponent | ||
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | ||
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | ||
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | ||
endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | ||
executeBindings(recurse:Boolean = false):void [override]
Executes all the data bindings on this Container. | Container | ||
executeChildBindings(recurse:Boolean):void
Executes the bindings into this Container's child UIComponent objects. | Container | ||
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | ||
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | ||
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | ||
getAutomationChildren():Array
Provides the automation object list . | UIComponent | ||
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | ||
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | ||
getChildAt(index:int):DisplayObject [override]
Gets the nth child component object. | Container | ||
getChildByName(name:String):DisplayObject [override]
Returns the child whose name property is the specified String. | Container | ||
getChildIndex(child:DisplayObject):int [override]
Gets the zero-based index of a specific child. | Container | ||
getChildren():Array
Returns an Array of DisplayObject objects consisting of the content children
of the container. | Container | ||
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | ||
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | ||
getElementAt(index:int):IVisualElement
Returns the visual element at the specified index. | Container | ||
getElementIndex(element:IVisualElement):int
Returns the index position of a visual element. | Container | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | ||
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | ||
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | ||
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | ||
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | ||
getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | ||
getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | ||
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | ||
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | ||
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | ||
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | ||
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | ||
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | ||
getRepeaterItem(whichRepeater:int = -1):Object
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 | ||
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | ||
Returns the tab of the navigator's TabBar control at the specified
index. | TabNavigator | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | ||
globalToContent(point:Point):Point [override]
Converts a Point object from global to content coordinates. | Container | ||
hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | ||
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | ||
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
initialize():void
Initializes the internal structure of this component. | UIComponent | ||
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | ||
invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | ||
invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | ||
invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | ||
invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | ||
loadState(state:Object):void
Loads the state of this object. | ViewStack | ||
localToContent(point:Point):Point [override]
Converts a Point object from local to content coordinates. | Container | ||
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | ||
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | ||
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can 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 | ||
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | ||
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | ||
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | ||
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | ||
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | ||
regenerateStyleCache(recursive:Boolean):void
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 | ||
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | ||
removeAllChildren():void
Removes all children from the child list of this container. | Container | ||
removeAllElements():void
Removes all visual elements from the container. | Container | ||
removeChild(child:DisplayObject):DisplayObject [override]
Removes a child DisplayObject from the child list of this Container. | Container | ||
removeChildAt(index:int):DisplayObject [override]
Removes a child DisplayObject from the child list of this Container
at the specified index. | Container | ||
Removes the specified visual element from the child list of
this container. | Container | ||
removeElementAt(index:int):IVisualElement
Removes a visual element from the specified index position
in the container. | Container | ||
removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | ||
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | ||
resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | ||
saveState():Object
Saves the state of this object. | ViewStack | ||
setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | ||
setChildIndex(child:DisplayObject, newIndex:int):void [override]
Sets the index of a particular child. | Container | ||
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | ||
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | ||
setElementIndex(element:IVisualElement, index:int):void
Changes the position of an existing visual element in the visual container. | Container | ||
setFocus():void
Sets the focus to this component. | UIComponent | ||
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | ||
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | ||
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
setMXMLDescriptor(value:Array):void | UIComponent | ||
setMXMLProperties(value:Array):void | UIComponent | ||
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | ||
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | ||
styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | ||
stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | ||
Swaps the index of the two specified visual elements. | Container | ||
swapElementsAt(index1:int, index2:int):void
Swaps the visual elements at the two specified index
positions in the container. | Container | ||
toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | ||
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | ||
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | ||
validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | ||
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | ||
validateSize(recursive:Boolean = false):void
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 | ||
validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | ||
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent |
Method | Defined By | ||
---|---|---|---|
addMXMLChildren(comps:Array):void | UIComponent | ||
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle. | UIComponent | ||
applyComputedMatrix():void
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | ||
attachOverlay():void [override]
Used internally by the Dissolve Effect to add the overlay to the chrome of a container. | Container | ||
canSkipMeasurement():Boolean
Determines if the call to the measure() method can be skipped. | UIComponent | ||
childrenCreated():void
Performs any final processing after child objects are created. | UIComponent | ||
commitProperties():void
Processes the properties set on the component. | UIComponent | ||
commitSelectedIndex(newIndex:int):void
Commits the selected index. | ViewStack | ||
createBorder():void
Creates the container's border skin
if it is needed and does not already exist. | Container | ||
createChildren():void
Create child objects of the component. | UIComponent | ||
createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used. | UIComponent | ||
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory. | UIComponent | ||
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | ||
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus. | UIComponent | ||
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus. | UIComponent | ||
generateMXMLAttributes(data:Array):void | UIComponent | ||
generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent | ||
generateMXMLObject(document:Object, data:Array):Object | UIComponent | ||
initAdvancedLayoutFeatures():void
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | ||
initializationComplete():void
Finalizes the initialization of this component. | UIComponent | ||
initializeAccessibility():void
Initializes this component's accessibility code. | UIComponent | ||
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | ||
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | ||
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event. | UIComponent | ||
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event. | UIComponent | ||
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Respond to size changes by setting the positions and sizes
of this container's borders. | Container | ||
measure():void [override]
Calculates the default sizes and mininum and maximum values of this
TabNavigator container. | TabNavigator | ||
resourcesChanged():void
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 | ||
scrollChildren():void
Positions the container's content area relative to the viewable area
based on the horizontalScrollPosition and verticalScrollPosition properties. | Container | ||
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | ||
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | ||
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]
Responds to size changes by setting the positions and sizes
of this container's tabs and children. | TabNavigator |
Style | Description | Defined By | ||
---|---|---|---|---|
Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. | Container | |||
Type: Number CSS Inheritance: no Theme: halo, spark 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 Theme: halo, spark Background color of a component. | Container | |||
Type: uint Format: Color CSS Inheritance: yes Theme: halo Background color of the component when it is disabled. | Container | |||
Type: Object Format: File CSS Inheritance: no Theme: halo Background image of a component. | Container | |||
Type: String CSS Inheritance: no Theme: halo Scales the image specified by backgroundImage to different percentage sizes. | Container | |||
Type: uint Format: Color CSS Inheritance: yes Theme: halo 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: Number CSS Inheritance: no Theme: spark Alpha of the border. | Container | |||
Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | Container | |||
Type: String CSS Inheritance: no Theme: halo 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 Theme: halo Bounding box thickness. | Container | |||
Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. | Container | |||
Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent | |||
Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Container | |||
Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | Container | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | Container | |||
Type: Number Format: Length CSS Inheritance: no Theme: halo, spark Radius of component corners. | Container | |||
Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | 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 Theme: halo Color of the drop shadow. | Container | |||
Type: Boolean CSS Inheritance: no Theme: halo Boolean property that specifies whether the component has a visible drop shadow. | Container | |||
Type: Boolean CSS Inheritance: no Theme: spark 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 | |||
firstTabStyleName | Type: String CSS Inheritance: no Name of CSS style declaration that specifies styles for the first tab. If this is unspecified, the default value of the tabStyleName style property is used.
| TabNavigator | ||
focusAlpha | Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. The default value for the Halo theme is 0.4 .
The default value for the Spark theme is 0.55 .
| TabNavigator | ||
Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | Container | |||
focusRoundedCorners | Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. This value is a space-separated String that can contain any combination of "tl" , "tr" , "bl"
and "br" .
For example, to specify that the right side corners should be rounded,
but the left side corners should be square, use "tr br" .
The cornerRadius style property specifies
the radius of the rounded corners.
The default value depends on the component class; if not overridden for
the class, default value is "tl tr bl br" .
| TabNavigator | ||
Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields.See also flash.text.TextField flash.text.AntiAliasType | 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.See also flash.text.TextField flash.text.GridFitType | Container | |||
Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.See also flash.text.TextField | 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.See also flash.text.TextField | Container | |||
Type: String CSS Inheritance: yes Determines whether the text is boldface. | Container | |||
horizontalAlign | Type: String CSS Inheritance: no Horizontal positioning of tabs at the top of this TabNavigator container. The possible values are "left" , "center" ,
and "right" .
The default value is "left" .
If the value is To see a difference between the alignments, the total width of all the tabs must be less than the width of the TabNavigator container. | TabNavigator | ||
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 Separation between tabs, in pixels. The default value is -1, so that the borders of adjacent tabs overlap. | TabNavigator | ||
Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | |||
Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true ) or disabled (false ). | Container | |||
lastTabStyleName | Type: String CSS Inheritance: no Name of CSS style declaration that specifies styles for the last tab. If this is unspecified, the default value of the tabStyleName style property is used.
| TabNavigator | ||
Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | |||
Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | |||
Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Container | |||
Type: String CSS Inheritance: yes The locale of the text displayed by this component. | Container | |||
Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's bottom border and its content area. | ViewStack | |||
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 | |||
Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's top border and its content area. | ViewStack | |||
Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | |||
selectedTabTextStyleName | Type: String CSS Inheritance: no Name of CSS style declaration that specifies styles for the text of the selected tab. | TabNavigator | ||
Type: String CSS Inheritance: no Theme: halo Direction of the drop shadow. | Container | |||
Type: Number Format: Length CSS Inheritance: no Theme: halo Distance of the drop shadow. | Container | |||
Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent | |||
Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | Container | |||
tabHeight | Type: Number Format: Length CSS Inheritance: no Height of each tab, in pixels. The default value is undefined .
When this property is undefined , the height of each tab is
determined by the font styles applied to this TabNavigator container.
If you set this property, the specified value overrides this calculation.
| TabNavigator | ||
tabOffset | Type: Number Format: Length CSS Inheritance: no The horizontal offset, in pixels, of the tab bar from the left edge of the TabNavigator container. A positive value moves the tab bar to the right. A negative value move the tab bar to the left. The default value is 0 . | TabNavigator | ||
tabStyleName | Type: String CSS Inheritance: no Name of CSS style declaration that specifies styles for the tabs. The default value is undefined . | TabNavigator | ||
tabWidth | Type: Number Format: Length CSS Inheritance: no Width of each tab, in pixels. The default value is undefined .
When this property is undefined , the width of each tab is
determined by the width of its label text, using the font styles applied
to this TabNavigator container.
If the total width of the tabs would be greater than the width of the
TabNavigator container, the calculated tab width is decreased, but
only to a minimum of 30 pixels.
If you set this property, the specified value overrides this calculation.
The label text on a tab is truncated if it does not fit in the tab. If a tab label is truncated, a tooltip with the full label text is displayed when a user rolls the mouse over the tab. | TabNavigator | ||
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: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | 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: halo Theme color of a component. | UIComponent | |||
Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | |||
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 | |||
Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. | ViewStack |
tabBar | property |
protected var tabBar:TabBar
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
A reference to the TabBar inside this TabNavigator.
tabBarStyleFilters | property |
tabBarStyleFilters:Object
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The set of styles to pass from the TabNavigator to the tabBar.
protected function get tabBarStyleFilters():Object
See also
TabNavigator | () | Constructor |
public function TabNavigator()
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
getTabAt | () | method |
public function getTabAt(index:int):Button
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns the tab of the navigator's TabBar control at the specified index.
Parameters
index:int — Index in the navigator's TabBar control.
|
Button — The tab at the specified index.
|
measure | () | method |
override protected function measure():void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Calculates the default sizes and mininum and maximum values of this
TabNavigator container.
See the UIComponent.measure()
method for more information
about the measure()
method.
The TabNavigator container uses the same measurement logic as the
ViewStack
container, with two modifications:
First, it increases the value of the
measuredHeight
and
measuredMinHeight
properties to accomodate the tabs.
Second, it increases the value of the
measuredWidth
property if necessary
to ensure that each tab can be at least 30 pixels wide.
See also
updateDisplayList | () | method |
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Responds to size changes by setting the positions and sizes
of this container's tabs and children.
For more information about the updateDisplayList()
method,
see the UIComponent.updateDisplayList()
method.
A TabNavigator container positions its TabBar container at the top.
The width of the TabBar is set to the width of the
TabNavigator, and the height of the TabBar is set
based on the tabHeight
property.
A TabNavigator container positions and sizes its child containers underneath the TabBar, using the same logic as in ViewStack 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.
|
See also
<?xml version="1.0"?> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <!-- Simple example to demonstrate the Halo TabNavigator layout container. --> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mx="library://ns.adobe.com/flex/mx"> <s:Panel title="TabNavigator Container Example" width="75%" height="75%" horizontalCenter="0" verticalCenter="0"> <s:VGroup left="10" right="10" top="10" bottom="10"> <s:Label width="100%" color="blue" text="Select the tabs to change the panel."/> <mx:TabNavigator id="tn" width="100%" height="100%"> <!-- Define each panel using a VBox container. --> <mx:VBox label="Panel 1"> <mx:Label text="TabNavigator container panel 1"/> </mx:VBox> <mx:VBox label="Panel 2"> <mx:Label text="TabNavigator container panel 2"/> </mx:VBox> <mx:VBox label="Panel 3"> <mx:Label text="TabNavigator container panel 3"/> </mx:VBox> </mx:TabNavigator> <s:Label width="100%" color="blue" text="Programmatically select the panel using a Button control."/> <s:HGroup> <mx:Button label="Select Tab 1" click="tn.selectedIndex=0"/> <mx:Button label="Select Tab 2" click="tn.selectedIndex=1"/> <mx:Button label="Select Tab 3" click="tn.selectedIndex=2"/> </s:HGroup> </s:VGroup> </s:Panel> </s:Application>