Packagecom.adobe.portfolio.components
Classpublic class Navigator
InheritanceNavigator Inheritance spark.components.Application
Implements INavigator

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The Navigator class extends Application and is the base class for Acrobat X Navigators. New navigators should extend this class rather than Application to handle common initialization procedures.

Default MXML PropertymxmlContentFactory



Public Properties
 PropertyDefined By
  currAttCurrentPageNum : int
[read-only] The current page of the focus attachment.
Navigator
  currAttFilename : String
[read-only] The filename of the focus attachment.
Navigator
  currAttFolderName : String
[read-only] The name of the focus attachment's parent folder.
Navigator
  currAttIndex : int
[read-only] The index of the focus attachment.
Navigator
  currAttIsFolder : Boolean
[read-only] True when the focus attachment is a folder; false otherwise.
Navigator
  currAttMIMEType : String
[read-only] The mime type of the current attachment.
Navigator
  currAttNumPages : int
[read-only] The number of pages in the focus attachment.
Navigator
  currAttThumb : String
[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
  portAccentColor : int
[read-only]
Navigator
  portBackgroundColor : int
[read-only]
Navigator
  portBorderColor : int
[read-only]
Navigator
  portCardSize : String
[read-only]
Navigator
  portFolderFileListing : String
[read-only] A string listing the non-folder attachment filenames in the current folder.
Navigator
  portFolderNumFiles : int
[read-only] The number of non-folder attachments in the current folder.
Navigator
  portFolderNumSubfolders : int
[read-only] The number of folder attachments in the current folder.
Navigator
  portFolderSubfolderListing : String
[read-only] A string listing the folder attachment names in the current folder.
Navigator
  portFontName : String
[read-only]
Navigator
  portLayoutName : String
[read-only] The localized name of this navigator.
Navigator
  portPrimaryColor : int
[read-only]
Navigator
  portTextColor : int
[read-only]
Navigator
  portTheme : 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
True if the navigator should always use the provided application font; false if the navigator should set its font according to the navigator properties.
Navigator
Protected Properties
 PropertyDefined By
  commonProperties : CommonProperties
An object for loading and accessing customizable properties for this navigator.
Navigator
  handleGestures : Boolean
Navigator
  initializedHost : Boolean = false
True if this application has been initialized with a navigator host.
Navigator
  pendingHost : INavigatorHost = null
A host object that has been set, but not yet initialized.
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
Public Methods
 MethodDefined By
  
Default constructor
Navigator
Protected Methods
 MethodDefined By
  
Returns the current desired state of the navigator based on the conditions of initialization.
Navigator
  
A function to initialize commonProperties.
Navigator
  
initHost():void
A setup function to initialize host specific data
Navigator
  
onApplicationComplete(event:FlexEvent):void
Navigator
  
onGestureEvent(event:TransformGestureEvent):void
Navigator
  
onKeyDown(event:KeyboardEvent):void
Default handling of keyboard events for a navigator.
Navigator
  
Default handling of right-click events for a navigator.
Navigator
  
setupState():void
Sets the current state of the navigator to the desired state based on the conditions of initialization.
Navigator
  
Displays an alert to the user when this navigator is loaded in an unsupported host application, informing that functionality will be limited.
Navigator
Public Constants
 ConstantDefined By
  FOCUS_DURATION : Number = 1000
[static] The default duration for effects when the focus attachment changes.
Navigator
Protected Constants
 ConstantDefined By
  collectionManager : CollectionManager
The navigator's CollectionManager instance.
Navigator
  runningOnMacintosh : Boolean
Returns true if this application is loaded under Mac OS X.
Navigator
  STATE_EMPTY : String = empty
String literal representing the empty state.
Navigator
  STATE_LOADING : String = loading
String literal representing the loading state.
Navigator
  STATE_NORMAL : String = normal
String literal representing the normal state.
Navigator
Property Detail
commonPropertiesproperty
protected var commonProperties:CommonProperties

An object for loading and accessing customizable properties for this navigator.

currAttCurrentPageNumproperty 
currAttCurrentPageNum:int  [read-only]

The current page of the focus attachment.


Implementation
    public function get currAttCurrentPageNum():int
currAttFilenameproperty 
currAttFilename:String  [read-only]

The filename of the focus attachment.


Implementation
    public function get currAttFilename():String
currAttFolderNameproperty 
currAttFolderName:String  [read-only]

The name of the focus attachment's parent folder.


Implementation
    public function get currAttFolderName():String
currAttIndexproperty 
currAttIndex:int  [read-only]

The index of the focus attachment.


Implementation
    public function get currAttIndex():int
currAttIsFolderproperty 
currAttIsFolder:Boolean  [read-only]

True when the focus attachment is a folder; false otherwise.


Implementation
    public function get currAttIsFolder():Boolean
currAttMIMETypeproperty 
currAttMIMEType:String  [read-only]

The mime type of the current attachment.


Implementation
    public function get currAttMIMEType():String
currAttNumPagesproperty 
currAttNumPages:int  [read-only]

The number of pages in the focus attachment.


Implementation
    public function get currAttNumPages():int
currAttThumbproperty 
currAttThumb:String  [read-only]


Implementation
    public function get currAttThumb():String
defaultFocusItemproperty 
defaultFocusItem:IFocusManagerComponent  [read-only]

A component that's suitable for receiving focus by default. Navigators can override this getter to provide an appropriate default.


Implementation
    public function get defaultFocusItem():IFocusManagerComponent
handleGesturesproperty 
handleGestures:Boolean


Implementation
    protected function get handleGestures():Boolean
    protected function set handleGestures(value:Boolean):void
hostproperty 
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.


Implementation
    public function set host(value:INavigatorHost):void
initializedHostproperty 
protected var initializedHost:Boolean = false

True if this application has been initialized with a navigator host.

See also

INavigatorHost
pendingHostproperty 
protected var pendingHost:INavigatorHost = null

A host object that has been set, but not yet initialized.

portAccentColorproperty 
portAccentColor:int  [read-only]


Implementation
    public function get portAccentColor():int
portBackgroundColorproperty 
portBackgroundColor:int  [read-only]


Implementation
    public function get portBackgroundColor():int
portBorderColorproperty 
portBorderColor:int  [read-only]


Implementation
    public function get portBorderColor():int
portCardSizeproperty 
portCardSize:String  [read-only]


Implementation
    public function get portCardSize():String
portFolderFileListingproperty 
portFolderFileListing:String  [read-only]

A string listing the non-folder attachment filenames in the current folder.


Implementation
    public function get portFolderFileListing():String
portFolderNumFilesproperty 
portFolderNumFiles:int  [read-only]

The number of non-folder attachments in the current folder.


Implementation
    public function get portFolderNumFiles():int
portFolderNumSubfoldersproperty 
portFolderNumSubfolders:int  [read-only]

The number of folder attachments in the current folder.


Implementation
    public function get portFolderNumSubfolders():int
portFolderSubfolderListingproperty 
portFolderSubfolderListing:String  [read-only]

A string listing the folder attachment names in the current folder.


Implementation
    public function get portFolderSubfolderListing():String
portFontNameproperty 
portFontName:String  [read-only]


Implementation
    public function get portFontName():String
portLayoutNameproperty 
portLayoutName:String  [read-only]

The localized name of this navigator.


Implementation
    public function get portLayoutName():String
portPrimaryColorproperty 
portPrimaryColor:int  [read-only]


Implementation
    public function get portPrimaryColor():int
portTextColorproperty 
portTextColor:int  [read-only]


Implementation
    public function get portTextColor():int
portThemeproperty 
portTheme:String  [read-only]


Implementation
    public function get portTheme():String
propertiesDidInitproperty 
propertiesDidInit:Boolean

A boolean indicating whether the navigator properties have been initialized.


Implementation
    protected function get propertiesDidInit():Boolean
    protected function set propertiesDidInit(value:Boolean):void
propertiesFactoryproperty 
propertiesFactory:ClassFactory  [read-only]

Returns a factory that can be used to create a CommonProperties instance for this navigator. Subclasses can override this function to allow for custom properties.


Implementation
    public function get propertiesFactory():ClassFactory

See also

commonProperties
CommonProperties
PropertyManager.commonProperties
resourceLoadingDidInitproperty 
resourceLoadingDidInit:Boolean

A boolean indicating whether the navigator resources have been initialized.


Implementation
    protected function get resourceLoadingDidInit():Boolean
    protected function set resourceLoadingDidInit(value:Boolean):void
rootItemsDidInitproperty 
rootItemsDidInit:Boolean

A boolean indicating whether the rootItems of the CollectionManager have been initialized.


Implementation
    protected function get rootItemsDidInit():Boolean
    protected function set rootItemsDidInit(value:Boolean):void
useApplicationFontOnlyproperty 
useApplicationFontOnly:Boolean

True if the navigator should always use the provided application font; false if the navigator should set its font according to the navigator properties.


Implementation
    public function get useApplicationFontOnly():Boolean
    public function set useApplicationFontOnly(value:Boolean):void

See also

CollectionManager.applicationFont
CommonProperties.portfolioFontName
Constructor Detail
Navigator()Constructor
public function Navigator()

Default constructor

Method Detail
getDesiredState()method
protected function getDesiredState():String

Returns the current desired state of the navigator based on the conditions of initialization.

Returns
String
initCommonProperties()method 
protected function initCommonProperties():void

A function to initialize commonProperties. Subclasses can override this method to support custom properties.

initHost()method 
protected function initHost():void

A setup function to initialize host specific data

onApplicationComplete()method 
protected function onApplicationComplete(event:FlexEvent):void

Parameters

event:FlexEvent

onGestureEvent()method 
protected function onGestureEvent(event:TransformGestureEvent):void

Parameters

event:TransformGestureEvent

onKeyDown()method 
protected function onKeyDown(event:KeyboardEvent):void

Default 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):void

Default 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():void

Sets the current state of the navigator to the desired state based on the conditions of initialization.

See also

getDesiredState
showExperienceAlert()method 
protected function showExperienceAlert():void

Displays an alert to the user when this navigator is loaded in an unsupported host application, informing that functionality will be limited.

Constant Detail
collectionManagerConstant
protected const collectionManager:CollectionManager

The navigator's CollectionManager instance. All host interaction should go through this instance, rather than the INavigatorHost directly.

FOCUS_DURATIONConstant 
public static const FOCUS_DURATION:Number = 1000

The default duration for effects when the focus attachment changes.

runningOnMacintoshConstant 
protected const runningOnMacintosh:Boolean

Returns true if this application is loaded under Mac OS X.

STATE_EMPTYConstant 
protected const STATE_EMPTY:String = empty

String literal representing the empty state.

STATE_LOADINGConstant 
protected const STATE_LOADING:String = loading

String literal representing the loading state.

STATE_NORMALConstant 
protected const STATE_NORMAL:String = normal

String literal representing the normal state.