| Package | ardisia.components.paneNavigators.tabPaneNavigator |
| Class | public class TabPaneNavigator |
| Inheritance | TabPaneNavigator  ViewStack spark.components.SkinnableContainer |
Supports deferred instantiation for MXML content. Set the "creationPolicy" property to "all" to immediately initialize content.
All direct children must extend the Pane container class.
To enable deferred instantiation, set the "creationPolicy" to "auto" ( the default). To create all content immediately, set the creationPolicy to "all".
View the technical documentation on the Ardisia Labs website for more information.
Default MXML PropertymxmlContentFactory
| Property | Defined By | ||
|---|---|---|---|
 | selectedChild : IVisualElement
The selected child element in the ViewStack. | ViewStack | |
| selectedIndex : int
The zero-based index of the currently visible child element. | ViewStack | |
| unDockThreshold : Number = 50
Pixels mouse must move outside of the navigator to un-dock a Pane. | TabPaneNavigator | ||
| Method | Defined By | ||
|---|---|---|---|
dockFloatedPane(floatPane:*):Boolean
Call to dock a floating pane to this navigator. | TabPaneNavigator | ||
removeAll():void
Removes all panes and tabs from the TabPaneNavigator. | TabPaneNavigator | ||
| Method | Defined By | ||
|---|---|---|---|
| commitSelectedIndex(removeFromLayout:Boolean = true):void
Commit the selected index, update the visible element and update the
bindings. | ViewStack | |
eventHandler(event:Event):void [override]
Handles events on the class. | TabPaneNavigator | ||
paneHandler(event:PaneEvent):void
Handles events on the managed panes. | TabPaneNavigator | ||
| selectElement(element:IVisualElement):void
Select the following element and initialize if necessary. | ViewStack | |
| setupDeferredContent():void
Setup the deferred content. | ViewStack | |
tabBarPartHandler(event:Event):void
Handles events on the tab bar skin part. | TabPaneNavigator | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the selectedChild changes. | ViewStack | ||
| Dispatched when the selectedChild is about to change. | ViewStack | ||
| Dispatched when a floated pane has been docked to the navigator. | TabPaneNavigator | |||
| Dispatched when a floated pane is about to be docked to the navigator. | TabPaneNavigator | |||
| Dispatched when a pane is dragged over this pane navigator. | TabPaneNavigator | |||
| Dispatched when a dragged pane is dragged out of this pane navigator. | TabPaneNavigator | |||
| Dispatched when a pane has been un-docked from the navigator and floated. | TabPaneNavigator | |||
| Dispatched when a pane is about to be un-docked from the navigator and floated. | TabPaneNavigator | |||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
tabBarPart:TabBar | Required: true Part Type: Static The button bar linked to the viewstack. | TabPaneNavigator | ||
| unDockThreshold | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var unDockThreshold:Number = 50Pixels mouse must move outside of the navigator to un-dock a Pane.
The default value is 50;.
| dockFloatedPane | () | method |
public function dockFloatedPane(floatPane:*):BooleanCall to dock a floating pane to this navigator.
Not typically called directly. Called by the dragged pane.
Parameters
floatPane:* — the Pane to dock to the navigator
|
Boolean |
| eventHandler | () | method |
override protected function eventHandler(event:Event):voidHandles events on the class.
Parameters
event:Event — the Event that triggered the handler
|
| paneHandler | () | method |
protected function paneHandler(event:PaneEvent):voidHandles events on the managed panes.
Parameters
event:PaneEvent — the PaneEvent dispatched by the pane
|
| removeAll | () | method |
public function removeAll():voidRemoves all panes and tabs from the TabPaneNavigator.
| tabBarPartHandler | () | method |
protected function tabBarPartHandler(event:Event):voidHandles events on the tab bar skin part.
Parameters
event:Event — the Event that triggered the handler
|
| docked | Event |
ardisia.components.paneNavigators.events.PaneNavigatorEventardisia.components.paneNavigators.events.PaneNavigatorEventDispatched when a floated pane has been docked to the navigator.
| docking | Event |
ardisia.components.paneNavigators.events.PaneNavigatorEventardisia.components.paneNavigators.events.PaneNavigatorEventDispatched when a floated pane is about to be docked to the navigator.
Can be cancelled to cancel the dock.
| dragEnter | Event |
ardisia.components.paneNavigators.events.PaneNavigatorEventardisia.components.paneNavigators.events.PaneNavigatorEventDispatched when a pane is dragged over this pane navigator.
Cancel to prevent the pane from docking to this navigator.
| dragExit | Event |
ardisia.components.paneNavigators.events.PaneNavigatorEventardisia.components.paneNavigators.events.PaneNavigatorEventDispatched when a dragged pane is dragged out of this pane navigator.
| unDocked | Event |
ardisia.components.paneNavigators.events.PaneNavigatorEventardisia.components.paneNavigators.events.PaneNavigatorEventDispatched when a pane has been un-docked from the navigator and floated.
| unDocking | Event |
ardisia.components.paneNavigators.events.PaneNavigatorEventardisia.components.paneNavigators.events.PaneNavigatorEventDispatched when a pane is about to be un-docked from the navigator and floated.
Can be cancelled to prevent the un-docking.