Apache Flex (FlexJS) 0.7.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
NavigationBar

Package | org.apache.flex.mobile.chrome
Class | public class NavigationBar
Inheritance | NavigationBar Container ContainerBase UIBase HTMLElementWrapper flash.display.Sprite
Implements | IChrome

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The NavigationBar class is part of the mobile view manager's chrome. When present, it provides a place for content at the top of the view, above the contentArea.

Default MXML Property `mxmlContent`

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | $height : Number [read-only] Retrieve the low-level bounding box height. | UIBase
|  | $width : Number [read-only] Retrieve the low-level bounding box width. | UIBase
|  | beads : Array The array property that is used to add additional beads to an MXML tag. | UIBase
|  | className : String The classname. | UIBase
|  | controls : Array The controls of the NavigationBar (eg, a button to go back and a title). | NavigationBar
|  | currentState : String The name of the current state. | ContainerBase
|  | element : IFlexJSElement [read-only] Each IUIBase has an element that is actually added to the platform's display list DOM. | UIBase
|  | explicitHeight : Number The explicitly set width (as opposed to measured width or percentage width). | UIBase
|  | explicitWidth : Number The explicitly set width (as opposed to measured width or percentage width). | UIBase
|  | height : Number [override] The height of the component. | UIBase
|  | id : String An id property for MXML documents. | UIBase
|  | measurementBead : IMeasurementBead [read-only] A measurement bead, if one exists. | UIBase
|  | model : Object An IBeadModel that serves as the data model for the component. | UIBase
|  | mxmlContent : Array The default property. | ContainerBase
|  | MXMLDescriptor : Array [read-only] An array of data that describes the MXML attributes and tags in an MXML document. | ContainerBase
|  | numElements : int [read-only] The number of elements in the parent. | UIBase
|  | percentHeight : Number The requested percentage height this component should have in the parent container. | UIBase
|  | percentWidth : Number The requested percentage width this component should have in the parent container. | UIBase
|  | states : Array The array of view states. | ContainerBase
|  | style : Object The object that contains "styles" and other associated name-value pairs. | UIBase
|  | topMostEventDispatcher : IEventDispatcher [read-only] The top most event dispatcher. | UIBase
|  | transitions : Array The array of transitions. | ContainerBase
|  | typeNames : String A list of type names. | UIBase
|  | view : IBeadView An IBeadView that serves as the view for the component. | UIBase
|  | width : Number [override] The width of the component. | UIBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | NavigationBar() Constructor. | NavigationBar
|  | addBead(bead:IBead):void [override] Add a bead to the strand. | UIBase
|  | addedToParent():void [override] A ContainerBase doesn't create its children until it is added to a parent. | ContainerBase
|  | addElement(c:Object, dispatchEvent:Boolean = true):void Add a component to the parent. | UIBase
|  | addElementAt(c:Object, index:int, dispatchEvent:Boolean = true):void Add a component to the parent. | UIBase
|  | generateMXMLAttributes(data:Array):void An method called by the compiler's generated code to kick off the setting of MXML attribute values and instantiation of child tags. | ContainerBase
|  | getBeadByType(classOrInterface:Class):IBead Find a bead on the strand. | UIBase
|  | getElementAt(index:int):Object [override] Get a component from the parent. | ContainerBase
|  | getElementIndex(c:Object):int Gets the index of this subcomponent. | UIBase
|  | hasState(state:String):Boolean true if the array of states contains a state with this name. | ContainerBase
|  | hidesBackButton(value:Boolean):void | NavigationBar
|  | isHeightSizedToContent():Boolean | UIBase
|  | isWidthSizedToContent():Boolean | UIBase
|  | removeBead(value:IBead):IBead Remove a bead from the strand. | UIBase
|  | removeElement(c:Object, dispatchEvent:Boolean = true):void Remove a component from the parent. | UIBase
|  | setHeight(value:Number, noEvent:Boolean = false):void | UIBase
|  | setWidth(value:Number, noEvent:Boolean = false):void | UIBase
|  | setWidthAndHeight(newWidth:Number, newHeight:Number, noEvent:Boolean = false):void | UIBase
|  | setX(value:Number):void | UIBase
|  | setY(value:Number):void | UIBase

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | repeaterListener(event:Event):void Rebroadcast an event from a sub component from the component. | UIBase

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | childrenAdded | Indicates that the children of the container is have been added. | ContainerBase
|  | click | Set a different class for click events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | initComplete | Indicates that the initialization of the container is complete. | ContainerBase
|  | mouseDown | Set a different class for mouseDown events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseMove | Set a different class for mouseMove events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseOut | Set a different class for mouseOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseOver | Set a different class for mouseOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseUp | Set a different class for mouseUp events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | rollOut | Set a different class for rollOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | rollOver | Set a different class for rollOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | stateChangeComplete | Indicates that the state change has completed. | ContainerBase

Property Detail

controls | property

`controls:Array`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The controls of the NavigationBar (eg, a button to go back and a title).

Implementation
`public function get controls():Array`
`public function set controls(value:Array):void`
Constructor Detail

NavigationBar | () | Constructor

`public function NavigationBar()`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Constructor.

Method Detail

hidesBackButton | () | method

`public function hidesBackButton(value:Boolean):void`

Parameters

| `value:Boolean`

Mon Sep 5 2016, 07:19 AM -07:00