| Package | feathers.extensions.tabbedApplication |
| Class | public class ViewNavigator |
| Inheritance | ViewNavigator feathers.extensions.tabbedApplication.StackScreenNavigator |
| Subclasses | ViewNavigatorApplication |
StackScreenNavigator.
See also
| Property | Defined By | ||
|---|---|---|---|
| keyCode : String
Keyboard key code to pop view
[ViewNavigatorApplication-only]. | ViewNavigator | ||
| latencyToStartSwipe : uint
The latency in pixels to start swipe
[ViewNavigatorApplication-only]. | ViewNavigator | ||
| length : uint [read-only]
Number of views in the navigation stack. | ViewNavigator | ||
| owner : Object
The tabbed navigators that is currently displaying this navigator
[TabbedViewNavigatorApplication-only]. | ViewNavigator | ||
| persistNavigatorState : Boolean
In-memory persistence saves navigators, views and data as the user navigates the application
[ViewNavigatorApplication-only]. | ViewNavigator | ||
| position : uint [read-only]
Position in the navigation stack. | ViewNavigator | ||
| speedBackReleaseSwipe : uint
Speed back in pixels when you release swipe
[ViewNavigatorApplication-only]. | ViewNavigator | ||
| speedSwipe : Number
Swipe speed to change View
[ViewNavigatorApplication-only]. | ViewNavigator | ||
| swipeView : Boolean
Swipe to change View
[ViewNavigatorApplication-only]. | ViewNavigator | ||
| vnID : String
The navigator id that is currently displaying by the tabbed navigators
[TabbedViewNavigatorApplication-only]. | ViewNavigator | ||
| Method | Defined By | ||
|---|---|---|---|
ViewNavigator(screen:Object = null, data:Object = null, transition:Function = null, owner:Object = null, vnID:String = null, _history:Vector.<String> = null, _historyData:Vector.<Object> = null, position:uint = 0)
Constructor. | ViewNavigator | ||
clear():void
Clear the persistence views and data
[ViewNavigatorApplication-only]. | ViewNavigator | ||
exit(errorCode:int = 0):void
Exit to the application and clear the persistence navigators, views and data
[ViewNavigatorApplication-only]. | ViewNavigator | ||
historyDataUpdate():void
Update data in a view. | ViewNavigator | ||
popView(transition:Function = null):DisplayObject
Pops the current view off the navigation stack. | ViewNavigator | ||
pushView(screen:Object, data:Object = null, transition:Function = null):void
Pushes a new view to the top of the navigation stack. | ViewNavigator | ||
save():void
Save views and data
[ViewNavigatorApplication-only]. | ViewNavigator | ||
| Method | Defined By | ||
|---|---|---|---|
preinitialize():void
Override this method to perform other tasks before the application is displayed. | ViewNavigator | ||
| keyCode | property |
keyCode:StringKeyboard key code to pop view [ViewNavigatorApplication-only].
Possible values are "back", "left" or key code (uint).
The default value is null.
public function get keyCode():String public function set keyCode(value:String):void| latencyToStartSwipe | property |
latencyToStartSwipe:uintThe latency in pixels to start swipe [ViewNavigatorApplication-only].
The default value is 10.
public function get latencyToStartSwipe():uint public function set latencyToStartSwipe(value:uint):void| length | property |
length:uint [read-only] Number of views in the navigation stack.
public function get length():uint| owner | property |
public var owner:ObjectThe tabbed navigators that is currently displaying this navigator [TabbedViewNavigatorApplication-only].
| persistNavigatorState | property |
persistNavigatorState:BooleanIn-memory persistence saves navigators, views and data as the user navigates the application [ViewNavigatorApplication-only].
The default value is false.
public function get persistNavigatorState():Boolean public function set persistNavigatorState(value:Boolean):void| position | property |
position:uint [read-only] Position in the navigation stack.
public function get position():uint| speedBackReleaseSwipe | property |
speedBackReleaseSwipe:uintSpeed back in pixels when you release swipe [ViewNavigatorApplication-only].
The default value is 10.
public function get speedBackReleaseSwipe():uint public function set speedBackReleaseSwipe(value:uint):void| speedSwipe | property |
speedSwipe:NumberSwipe speed to change View [ViewNavigatorApplication-only].
The default value is 3.
public function get speedSwipe():Number public function set speedSwipe(value:Number):void| swipeView | property |
swipeView:BooleanSwipe to change View [ViewNavigatorApplication-only].
The default value is false.
public function get swipeView():Boolean public function set swipeView(value:Boolean):void| vnID | property |
public var vnID:StringThe navigator id that is currently displaying by the tabbed navigators [TabbedViewNavigatorApplication-only].
| ViewNavigator | () | Constructor |
public function ViewNavigator(screen:Object = null, data:Object = null, transition:Function = null, owner:Object = null, vnID:String = null, _history:Vector.<String> = null, _historyData:Vector.<Object> = null, position:uint = 0)Constructor.
Parametersscreen:Object (default = null) | |
data:Object (default = null) | |
transition:Function (default = null) | |
owner:Object (default = null) | |
vnID:String (default = null) | |
_history:Vector.<String> (default = null) | |
_historyData:Vector.<Object> (default = null) | |
position:uint (default = 0) |
| clear | () | method |
public function clear():voidClear the persistence views and data [ViewNavigatorApplication-only].
| exit | () | method |
public function exit(errorCode:int = 0):voidExit to the application and clear the persistence navigators, views and data [ViewNavigatorApplication-only].
Parameters
errorCode:int (default = 0) |
| historyDataUpdate | () | method |
public function historyDataUpdate():voidUpdate data in a view.
| popView | () | method |
public function popView(transition:Function = null):DisplayObjectPops the current view off the navigation stack.
Parameters
transition:Function (default = null) |
DisplayObject |
| preinitialize | () | method |
protected function preinitialize():voidOverride this method to perform other tasks before the application is displayed.
override protected function preinitialize():void
{
//perform other tasks here
setTimeout(otherTasks, 5000);
}
private function otherTasks():void
{
left = 100;
super.preinitialize();
}| pushView | () | method |
public function pushView(screen:Object, data:Object = null, transition:Function = null):voidPushes a new view to the top of the navigation stack.
Parameters
screen:Object — view class.
| |
data:Object (default = null) — Properties saved in a view.
| |
transition:Function (default = null) |
| save | () | method |
public function save():voidSave views and data [ViewNavigatorApplication-only].