| Package | com.adobe.portfolio.components |
| Class | public class Navigator |
| Inheritance | Navigator  spark.components.Application |
| Implements | INavigator |
Default MXML PropertymxmlContentFactory
| Property | Defined By | ||
|---|---|---|---|
| currAttCurrentPageNum : int [read-only] | Navigator | ||
| currAttFilename : String [read-only] | Navigator | ||
| currAttFolderName : String [read-only] | Navigator | ||
| currAttIndex : int [read-only] | Navigator | ||
| currAttIsFolder : Boolean [read-only] | Navigator | ||
| currAttMIMEType : String [read-only] | Navigator | ||
| currAttNumPages : int [read-only] | Navigator | ||
| defaultFocusItem : IFocusManagerComponent [read-only] A component that's suitable for receiving focus by default. | Navigator | ||
| host : INavigatorHost [write-only]
Initializes and later shuts down an INavigator instance. | Navigator | ||
| portFolderFileListing : String [read-only] | Navigator | ||
| portFolderNumFiles : int [read-only] | Navigator | ||
| portFolderNumSubfolders : int [read-only] | Navigator | ||
| portFolderSubfolderListing : String [read-only] | Navigator | ||
| portLayoutName : String [read-only] | Navigator | ||
| propertiesFactory : ClassFactory [read-only]
Returns a factory that can be used to create a CommonProperties instance for this navigator. | Navigator | ||
| useApplicationFontOnly : Boolean | Navigator | ||
| Property | Defined By | ||
|---|---|---|---|
| commonProperties : CommonProperties An object for loading and accessing customizable properties for this navigator. | Navigator | ||
| includeTestControls : Boolean [read-only] | Navigator | ||
| initializedHost : Boolean = false | Navigator | ||
| pendingHost : INavigatorHost = null | Navigator | ||
| propertiesDidInit : Boolean
A boolean indicating whether the navigator properties have been initialized. | Navigator | ||
| resourceLoadingDidInit : Boolean
A boolean indicating whether the navigator resources have been initialized. | Navigator | ||
| rootItemsDidInit : Boolean
A boolean indicating whether the rootItems of the CollectionManager
have been initialized. | Navigator | ||
| Method | Defined By | ||
|---|---|---|---|
| Navigator | |||
| Method | Defined By | ||
|---|---|---|---|
initCommonProperties():void A function to initialize commonProperties. | Navigator | ||
initHost():void A setup function to initialize host specific data
| Navigator | ||
onKeyDown(event:KeyboardEvent):void
Default handling of keyboard events for a navigator. | Navigator | ||
onRightClick(event:RightClickEvent):void
Default handling of right-click events for a navigator. | Navigator | ||
setupState():void
Sets the current state of the navigator based on the state of initialization. | Navigator | ||
showExperienceAlert():void | Navigator | ||
| Constant | Defined By | ||
|---|---|---|---|
| FOCUS_DURATION : Number = 1000 [static] | Navigator | ||
| Constant | Defined By | ||
|---|---|---|---|
| collectionManager : CollectionManager The navigator's CollectionManager instance. | Navigator | ||
| runningOnMacintosh : Boolean | Navigator | ||
| STATE_EMPTY : String = empty | Navigator | ||
| STATE_LOADING : String = loading | Navigator | ||
| STATE_NORMAL : String = normal | Navigator | ||
| commonProperties | property |
protected var commonProperties:CommonPropertiesAn object for loading and accessing customizable properties for this navigator.
| currAttCurrentPageNum | property |
currAttCurrentPageNum:int [read-only] public function get currAttCurrentPageNum():int| currAttFilename | property |
currAttFilename:String [read-only] public function get currAttFilename():String| currAttFolderName | property |
currAttFolderName:String [read-only] public function get currAttFolderName():String| currAttIndex | property |
currAttIndex:int [read-only] public function get currAttIndex():int| currAttIsFolder | property |
currAttIsFolder:Boolean [read-only] public function get currAttIsFolder():Boolean| currAttMIMEType | property |
currAttMIMEType:String [read-only] public function get currAttMIMEType():String| currAttNumPages | property |
currAttNumPages:int [read-only] public function get currAttNumPages():int| defaultFocusItem | property |
defaultFocusItem:IFocusManagerComponent [read-only] A component that's suitable for receiving focus by default. Navigators can override this getter to provide an appropriate default.
public function get defaultFocusItem():IFocusManagerComponent| host | property |
host:INavigatorHost [write-only] | Product Version : | Acrobat ActionScript API 9.0 |
Initializes and later shuts down an INavigator instance.
Called early with a non-null host instance, at which
point the PDF portfolio navigator can initialize itself and add event listeners.
This is likely to occur shortly after construction and may occur before any
children have been added (in the case of MXML components).
When the host shuts down, the PDF portfolio navigator calls this method once again with
a value of null. At this point the INavigator instance
is expected to shut itself down.
public function set host(value:INavigatorHost):void| includeTestControls | property |
includeTestControls:Boolean [read-only] protected function get includeTestControls():Boolean| initializedHost | property |
protected var initializedHost:Boolean = false| pendingHost | property |
protected var pendingHost:INavigatorHost = null| portFolderFileListing | property |
portFolderFileListing:String [read-only] public function get portFolderFileListing():String| portFolderNumFiles | property |
portFolderNumFiles:int [read-only] public function get portFolderNumFiles():int| portFolderNumSubfolders | property |
portFolderNumSubfolders:int [read-only] public function get portFolderNumSubfolders():int| portFolderSubfolderListing | property |
portFolderSubfolderListing:String [read-only] public function get portFolderSubfolderListing():String| portLayoutName | property |
portLayoutName:String [read-only] public function get portLayoutName():String| propertiesDidInit | property |
propertiesDidInit:BooleanA boolean indicating whether the navigator properties have been initialized.
protected function get propertiesDidInit():Boolean protected function set propertiesDidInit(value:Boolean):void| propertiesFactory | property |
propertiesFactory:ClassFactory [read-only] Returns a factory that can be used to create a CommonProperties instance for this navigator.
public function get propertiesFactory():ClassFactory| resourceLoadingDidInit | property |
resourceLoadingDidInit:BooleanA boolean indicating whether the navigator resources have been initialized.
protected function get resourceLoadingDidInit():Boolean protected function set resourceLoadingDidInit(value:Boolean):void| rootItemsDidInit | property |
rootItemsDidInit:Boolean
A boolean indicating whether the rootItems of the CollectionManager
have been initialized.
protected function get rootItemsDidInit():Boolean protected function set rootItemsDidInit(value:Boolean):void| useApplicationFontOnly | property |
useApplicationFontOnly:Boolean public function get useApplicationFontOnly():Boolean public function set useApplicationFontOnly(value:Boolean):void| Navigator | () | Constructor |
public function Navigator()| initCommonProperties | () | method |
protected function initCommonProperties():voidA function to initialize commonProperties. Subclasses can override this method to support custom properties.
| initHost | () | method |
protected function initHost():voidA setup function to initialize host specific data
| onKeyDown | () | method |
protected function onKeyDown(event:KeyboardEvent):voidDefault handling of keyboard events for a navigator. Components handling their own keyboard events who want to avoid this behavior should call preventDefault to avoid handling the event again.
Parameters
event:KeyboardEvent |
| onRightClick | () | method |
protected function onRightClick(event:RightClickEvent):voidDefault handling of right-click events for a navigator. Components handling their own events who want to avoid this behavior should call preventDefault to avoid handling the event again.
Parameters
event:RightClickEvent |
| setupState | () | method |
protected function setupState():voidSets the current state of the navigator based on the state of initialization.
| showExperienceAlert | () | method |
protected function showExperienceAlert():void| collectionManager | Constant |
protected const collectionManager:CollectionManagerThe navigator's CollectionManager instance. All host interaction should go through this instance, rather than the INavigatorHost directly.
| FOCUS_DURATION | Constant |
public static const FOCUS_DURATION:Number = 1000| runningOnMacintosh | Constant |
protected const runningOnMacintosh:Boolean| STATE_EMPTY | Constant |
protected const STATE_EMPTY:String = empty| STATE_LOADING | Constant |
protected const STATE_LOADING:String = loading| STATE_NORMAL | Constant |
protected const STATE_NORMAL:String = normal