Package | mx.controls |
Class | public class NavBar |
Inheritance | NavBar Box Container UIComponent FlexSprite flash.display.Sprite |
Subclasses | ButtonBar |
The
tag inherits all of the tag attributes
of its superclass, with the exception of scrolling-related
attributes, and adds the following tag attributes:
<mx:tagname Properties dataProvider="No default" iconField="icon" labeField="label" selectedIndex="-1" toolTipField="toolTip" Events itemClick="No default" > ... child tags ... </mx:tagname>
See also
Property | Defined by | ||
---|---|---|---|
activeEffects : Array
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | ||
autoLayout : Boolean
If
true , measurement and layout are done
when the position or size of a child is changed. | Container | ||
automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | ||
automationName : String
Name that can be used as an identifier for this object.
| UIComponent | ||
automationTabularData : Object
An implementation of the
IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | ||
automationValue : Array
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | ||
baselinePosition : Number
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | ||
borderMetrics : EdgeMetrics
Returns an EdgeMetrics object that has four properties:
left , top , right ,
and bottom . | Container | ||
cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | ||
cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | ||
childDescriptors : Array
Array of UIComponentDescriptor objects produced by the MXML compiler.
| Container | ||
className : String
The name of this instance's class, such as
"Button" . | UIComponent | ||
clipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes
of this container's children extend outside the borders of
this container.
| Container | ||
contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| Container | ||
contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| Container | ||
creatingContentPane : Boolean
Containers use an internal content pane to control scrolling.
| Container | ||
creationIndex : int
Specifies the order to instantiate and draw the children
of the container.
| Container | ||
creationPolicy : String
The child creation policy for this Container.
| Container | ||
currentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
| UIComponent | ||
currentState : String
The current view state of the component.
| UIComponent | ||
cursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | ||
data : Object
The
data property lets you pass a value
to the component when you use it in an item renderer or item editor. | Container | ||
dataProvider : Object
Data used to populate the navigator control.
| NavBar | ||
descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | ||
direction : String
The direction in which this Box container lays out its children.
| Box | ||
document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | ||
doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | ||
enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | ||
errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | ||
explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | ||
focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | ||
focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | ||
focusPane : Sprite
The focus pane associated with this object.
| UIComponent | ||
globalX : Number | UIComponent | ||
globalY : Number | UIComponent | ||
height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
iconField : String
Name of the field in the
dataProvider object
to display as the icon for each navigation item. | NavBar | ||
id : String
ID of the component.
| UIComponent | ||
includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | ||
inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | ||
initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | ||
instanceIndex : int
The index of a repeated component.
| UIComponent | ||
instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | ||
isDocument : Boolean
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | ||
isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | ||
labelField : String
Name of the field in the
dataProvider object
to display as the label for each navigation item. | NavBar | ||
labelFunction : Function
A user-supplied function to run on each item to determine its label.
| NavBar | ||
maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | ||
measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | ||
measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | ||
measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | ||
minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
miscHolder : Object
A utility holder for any various properties
| UIComponent | ||
moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | ||
mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | ||
move_enableProtection : Boolean = false | UIComponent | ||
nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | ||
nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | ||
numAutomationChildren : int
The number of automation children this container has.
| UIComponent | ||
numChildren : int
Number of child components in this container.
| Container | ||
owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | ||
parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | ||
parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | ||
parentDocument : Object
A reference to the parent document object for this UIComponent.
| UIComponent | ||
percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | ||
percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | ||
processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | ||
rawChildren : IChildList
A container typically contains child components, which can be enumerated
using the
Container.getChildAt() method and
Container.numChildren property. | Container | ||
repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | ||
repeaterIndex : int
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | ||
repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | ||
repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | ||
scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | ||
scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | ||
screen : Rectangle
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | ||
selectedIndex : int
Index of the active navigation item,
where the first item is at an index of 0.
| NavBar | ||
setActualSize_enableProtection : Boolean = false | UIComponent | ||
setVisible_enableProtection : Boolean = true | UIComponent | ||
showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | ||
states : Array
The view states that are defined for this component.
| UIComponent | ||
styleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the
styleName property) override inline styles. | UIComponent | ||
styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | ||
styleName : Object
The class style used by this component.
| UIComponent | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | ||
toolTip : String
Text to display in the ToolTip.
| UIComponent | ||
toolTipField : String
Name of the the field in the
dataProvider object
to display as the tooltip label. | NavBar | ||
transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | ||
tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | ||
uid : String
A unique identifier for the object.
| UIComponent | ||
updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | ||
validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | ||
viewMetrics : EdgeMetrics
Returns an object that has four properties:
left ,
top , right , and bottom . | Container | ||
viewMetricsAndPadding : EdgeMetrics
Returns an object that has four properties:
left ,
top , right , and bottom . | Container | ||
visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | ||
visible_unprotected : Boolean
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
| UIComponent | ||
width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | ||
xmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
| UIComponent | ||
y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent |
Method | Defined by | ||
---|---|---|---|
NavBar()
Constructor.
| NavBar | ||
addChild(child:DisplayObject):DisplayObject
Adds a child DisplayObject to this Container.
| Container | ||
addChildAt(child:DisplayObject, index:int):DisplayObject
Adds a child DisplayObject to this Container.
| Container | ||
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
Converts a
Point object from content coordinates to global coordinates. | Container | ||
contentToLocal(point:Point):Point
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 | ||
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 | ||
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
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
Programatically 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
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 | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| UIComponent | ||
getChildAt(index:int):DisplayObject
Gets the nth child component object.
| Container | ||
getChildByName(name:String):DisplayObject
Returns the child whose
name property is the specified String. | Container | ||
getChildIndex(child:DisplayObject):int
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 | ||
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
| UIComponent | ||
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
| UIComponent | ||
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 | ||
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 | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
| UIComponent | ||
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | Container | ||
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 | ||
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 | ||
itemToLabel(data:Object):String
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties.
| NavBar | ||
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | Container | ||
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may 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 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 | ||
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
| 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 | ||
pixelsToPercent(pxl:Number):Number
Method used to convert number of pixels to a
percentage relative to the contents of this container.
| Box | ||
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 | ||
removeChild(child:DisplayObject):DisplayObject
Removes a child DisplayObject from the child list of this Container.
| Container | ||
removeChildAt(index:int):DisplayObject
Removes a child DisplayObject from the child list of this Container
at the specified index.
| Container | ||
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 | ||
setActualSize(w:Number, h:Number):void
Sizes the object.
| UIComponent | ||
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
| UIComponent | ||
setChildIndex(child:DisplayObject, newIndex:int):void
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 | ||
setFocus():void
Sets the focus to this component.
| 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 | ||
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
| 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 | ||
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | ||
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 | ||
---|---|---|---|
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
| UIComponent | ||
attachOverlay():void
Used internally by the Dissolve Effect to add the overlay to the chrome of a container.
| Container | ||
childrenCreated():void
Performs any final processing after child objects are created.
| UIComponent | ||
clickHandler(event:MouseEvent):void
Handles the
MouseEvent.CLICK event
for the items in the NavBar control. | NavBar | ||
commitProperties():void
Processes the properties set on the component.
| UIComponent | ||
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 | ||
createNavItem(label:String, icon:Class = null):IFlexDisplayObject
Creates the individual navigator items.
| NavBar | ||
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 | ||
hiliteSelectedNavItem(index:int):void
Highlights the selected navigator item.
| NavBar | ||
initializationComplete():void
Finalizes the initialization of this component.
| UIComponent | ||
initializeAccessibility():void
Initializes this component's accessibility code.
| 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
Calculates the default sizes and minimum and maximum values of the Box
container.
| Box | ||
resetNavItems():void
Resets the navigator bar to its default state.
| NavBar | ||
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 | ||
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sets the size and position of each child of the Box container.
| Box | ||
updateNavItemIcon(index:int, icon:Class):void
Resets the icon of a navigator item in the
NavBar control.
| NavBar | ||
updateNavItemLabel(index:int, label:String):void
Sets the label property of a navigator item in the
NavBar control.
| NavBar |
Event | Summary | Defined by | ||
---|---|---|---|---|
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | |||
Dispatched after a child has been added to a container. | Container | |||
Dispatched after the index (among the container children) of a container child changes. | Container | |||
Dispatched before a child of a container is removed. | Container | |||
Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | |||
Dispatched after the view state has changed. | UIComponent | |||
Dispatched after the currentState property changes,
but before the view state changes. | UIComponent | |||
Dispatched when the data property changes. | Container | |||
Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | |||
Dispatched by the drop target when the user releases the mouse over it. | UIComponent | |||
Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | |||
Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | |||
Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | |||
Dispatched by the drag initiator when starting a drag operation. | UIComponent | |||
Dispatched after an effect ends. | UIComponent | |||
Dispatched just before an effect starts. | UIComponent | |||
Dispatched after the component has returned to the root view state. | UIComponent | |||
Dispatched before the component exits from the root view state. | UIComponent | |||
Dispatched when an object's state changes from visible to invisible. | UIComponent | |||
Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | |||
Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | |||
Dispatched when a navigation item is selected. | NavBar | |||
Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | |||
Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | |||
Dispatched when the object has moved. | UIComponent | |||
Dispatched at the beginning of the component initialization sequence. | UIComponent | |||
Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | |||
Dispatched when the component is resized. | UIComponent | |||
Dispatched when an object's state changes from invisible to visible. | UIComponent | |||
Dispatched by the component when it is time to create a ToolTip. | UIComponent | |||
Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | |||
Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | |||
Dispatched by the component when its ToolTip is about to be shown. | UIComponent | |||
Dispatched by the component when its ToolTip has been shown. | UIComponent | |||
Dispatched by a component whose toolTip property is set,
as soon as the user moves the mouse over it. | UIComponent | |||
Dispatched when an object has had its commitProperties() ,
measure() , and
updateDisplayList() methods called (if needed). | UIComponent | |||
Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | |||
Dispatched when values are changed programmatically or by user interaction. | UIComponent |
dataProvider | property |
dataProvider:Object
[read-write]Data used to populate the navigator control. The type of data can either be a ViewStack container or an Array.
When you use a ViewStack container, the label
and icon
properties of the ViewStack container's children
are used to populate the navigation items,
as in the following example:
<mx:LinkBar dataProvider="{vs}"/> <mx:ViewStack id="vs"> <mx:VBox label="Accounts" icon="account_icon"/> <mx:VBox label="Leads" icon="leads_icon"/> </mx:ViewStack>
The LinkBar control contains two links: "Accounts" and "Leads," each with its own icon as specified on the VBox tags. When you click a link, the ViewStack container navigates to the corresponding view.
When you use an Array, the labelField
property
determines the name of the dataProvider
field
to use as the label for each navigation item; the iconField
property determines the name of the dataProvider
field
to use as the icon for each navigation item.
If you use an Array of Strings, the labelField
property is ignored.
The default value is "undefined"
.
This property can be used as the source for data binding.
Implementation public function get dataProvider():Object
public function set dataProvider(value:Object):void
iconField | property |
iconField:String
[read-write]
Name of the field in the dataProvider
object
to display as the icon for each navigation item.
The default value is "icon"
.
This property can be used as the source for data binding.
Implementation public function get iconField():String
public function set iconField(value:String):void
labelField | property |
labelField:String
[read-write]
Name of the field in the dataProvider
object
to display as the label for each navigation item.
The default value is "label"
.
This property can be used as the source for data binding.
Implementation public function get labelField():String
public function set labelField(value:String):void
labelFunction | property |
labelFunction:Function
[read-write]
A user-supplied function to run on each item to determine its label.
By default, the component looks for a property named label
on each data provider item and displays it.
However, some data sets do not have a label
property
nor do they have another property that can be used for displaying.
An example is a data set that has lastName and firstName fields
but you want to display full names.
You can supply a labelFunction
that finds the
appropriate fields and returns a displayable string. The
labelFunction
is also good for handling formatting and
localization.
For most components, the label function takes a single argument which is the item in the data provider and returns a String.
myLabelFunction(item:Object):String
The default value is null
.
This property can be used as the source for data binding.
Implementation public function get labelFunction():Function
public function set labelFunction(value:Function):void
selectedIndex | property |
selectedIndex:int
[read-write]Index of the active navigation item, where the first item is at an index of 0.
The default value is -1
.
This property can be used as the source for data binding.
Implementation public function get selectedIndex():int
public function set selectedIndex(value:int):void
toolTipField | property |
toolTipField:String
[read-write]
Name of the the field in the dataProvider
object
to display as the tooltip label.
The default value is "toolTip"
.
This property can be used as the source for data binding.
Implementation public function get toolTipField():String
public function set toolTipField(value:String):void
NavBar | () | constructor |
public function NavBar()
Constructor.
clickHandler | () | method |
protected function clickHandler(event:MouseEvent):void
Handles the MouseEvent.CLICK
event
for the items in the NavBar control. This handler
dispatches the itemClick
event for the NavBar control.
event:MouseEvent — The event object.
|
createNavItem | () | method |
protected function createNavItem(label:String, icon:Class = null):IFlexDisplayObject
Creates the individual navigator items. By default, this method performs no action. You can override this method in a subclass to create a navigator item based on the type of navigator items in your subclass.
Parameterslabel:String — The label for the created navigator item.
|
|
icon:Class (default = null ) — The icon for the created navigator item.
Typically, this is an icon that you have embedded in the application.
|
IFlexDisplayObject —
The created navigator item.
|
hiliteSelectedNavItem | () | method |
protected function hiliteSelectedNavItem(index:int):void
Highlights the selected navigator item. By default, this method performs no action. You can override this method in a subclass to highlight the selected navigator item.
Parametersindex:int — The index of the selected item in the NavBar control.
The first item is at an index of 0.
|
itemToLabel | () | method |
public function itemToLabel(data:Object):String
Returns the string the renderer would display for the given data object based on the labelField and labelFunction properties. If the method cannot convert the parameter to a string, it returns a single space.
Parametersdata:Object — Object to be rendered.
|
String — The string to be displayed based on the data.
|
resetNavItems | () | method |
protected function resetNavItems():void
Resets the navigator bar to its default state. By default, this method performs no action. You can override this method in a subclass to reset the navigator bar to a default state.
updateNavItemIcon | () | method |
protected function updateNavItemIcon(index:int, icon:Class):void
Resets the icon of a navigator item in the NavBar control. You can override this method in a subclass to set the icon of a navigator item based on the type of navigator items in your subclass.
Parametersindex:int — The index of the navigator item in the NavBar control.
The first navigator item is at an index of 0.
|
|
icon:Class — The new icon for the navigator item.
Typically, this is an icon that you have embedded in the application.
|
updateNavItemLabel | () | method |
protected function updateNavItemLabel(index:int, label:String):void
Sets the label property of a navigator item in the NavBar control. You can override this method in a subclass to set the label of a navigator item based on the type of navigator items in your subclass.
Parametersindex:int — The index of the navigator item in the NavBar control.
The first navigator item is at an index of 0.
|
|
label:String — The new label text for the navigator item.
|
itemClick | event |
mx.events.ItemClickEvent
mx.events.ItemClickEvent.ITEM_CLICK
Dispatched when a navigation item is selected.
The ItemClickEvent.ITEM_CLICK
constant defines the value of the
type
property of the event object for an itemClick
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
index | The index of the navigation item that was clicked. |
item | The item in the data provider of the navigation item that was clicked. |
label | The label of the navigation item that was clicked. |
relatedObject | The child object that generated the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |