Package | com.adobe.portfolio.components |
Class | public class Navigator |
Inheritance | Navigator ![]() |
Implements | INavigator |
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Default MXML PropertymxmlContentFactory
Property | Defined 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 |
Property | Defined 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 |
Method | Defined By | ||
---|---|---|---|
Default constructor
| Navigator |
Method | Defined By | ||
---|---|---|---|
getDesiredState():String
Returns the current desired state of the navigator based on the
conditions of initialization. | Navigator | ||
initCommonProperties():void
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 | ||
onRightClick(event:RightClickEvent):void
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 | ||
showExperienceAlert():void
Displays an alert to the user when this navigator is loaded in an unsupported host application,
informing that functionality will be limited. | Navigator |
Constant | Defined By | ||
---|---|---|---|
FOCUS_DURATION : Number = 1000 [static]
The default duration for effects when the focus attachment changes. | Navigator |
Constant | Defined 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 |
commonProperties | property |
protected var commonProperties:CommonProperties
An object for loading and accessing customizable properties for this navigator.
currAttCurrentPageNum | property |
currAttCurrentPageNum:int
[read-only] The current page of the focus attachment.
public function get currAttCurrentPageNum():int
currAttFilename | property |
currAttFilename:String
[read-only] The filename of the focus attachment.
public function get currAttFilename():String
currAttFolderName | property |
currAttFolderName:String
[read-only] The name of the focus attachment's parent folder.
public function get currAttFolderName():String
currAttIndex | property |
currAttIndex:int
[read-only] The index of the focus attachment.
public function get currAttIndex():int
currAttIsFolder | property |
currAttIsFolder:Boolean
[read-only] True when the focus attachment is a folder; false otherwise.
public function get currAttIsFolder():Boolean
currAttMIMEType | property |
currAttMIMEType:String
[read-only] The mime type of the current attachment.
public function get currAttMIMEType():String
currAttNumPages | property |
currAttNumPages:int
[read-only] The number of pages in the focus attachment.
public function get currAttNumPages():int
currAttThumb | property |
currAttThumb:String
[read-only] public function get currAttThumb():String
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
handleGestures | property |
handleGestures:Boolean
protected function get handleGestures():Boolean
protected function set handleGestures(value:Boolean):void
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
initializedHost | property |
protected var initializedHost:Boolean = false
True if this application has been initialized with a navigator host.
See also
pendingHost | property |
protected var pendingHost:INavigatorHost = null
A host object that has been set, but not yet initialized.
portAccentColor | property |
portAccentColor:int
[read-only] public function get portAccentColor():int
portBackgroundColor | property |
portBackgroundColor:int
[read-only] public function get portBackgroundColor():int
portBorderColor | property |
portBorderColor:int
[read-only] public function get portBorderColor():int
portCardSize | property |
portCardSize:String
[read-only] public function get portCardSize():String
portFolderFileListing | property |
portFolderFileListing:String
[read-only] A string listing the non-folder attachment filenames in the current folder.
public function get portFolderFileListing():String
portFolderNumFiles | property |
portFolderNumFiles:int
[read-only] The number of non-folder attachments in the current folder.
public function get portFolderNumFiles():int
portFolderNumSubfolders | property |
portFolderNumSubfolders:int
[read-only] The number of folder attachments in the current folder.
public function get portFolderNumSubfolders():int
portFolderSubfolderListing | property |
portFolderSubfolderListing:String
[read-only] A string listing the folder attachment names in the current folder.
public function get portFolderSubfolderListing():String
portFontName | property |
portFontName:String
[read-only] public function get portFontName():String
portLayoutName | property |
portLayoutName:String
[read-only] The localized name of this navigator.
public function get portLayoutName():String
portPrimaryColor | property |
portPrimaryColor:int
[read-only] public function get portPrimaryColor():int
portTextColor | property |
portTextColor:int
[read-only] public function get portTextColor():int
portTheme | property |
portTheme:String
[read-only] public function get portTheme():String
propertiesDidInit | property |
propertiesDidInit:Boolean
A 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. Subclasses can override this function to allow for custom properties.
public function get propertiesFactory():ClassFactory
See also
resourceLoadingDidInit | property |
resourceLoadingDidInit:Boolean
A 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
True if the navigator should always use the provided application font; false if the navigator should set its font according to the navigator properties.
public function get useApplicationFontOnly():Boolean
public function set useApplicationFontOnly(value:Boolean):void
See also
Navigator | () | Constructor |
public function Navigator()
Default constructor
getDesiredState | () | method |
protected function getDesiredState():String
Returns the current desired state of the navigator based on the conditions of initialization.
ReturnsString |
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
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.
collectionManager | Constant |
protected const collectionManager:CollectionManager
The 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
The default duration for effects when the focus attachment changes.
runningOnMacintosh | Constant |
protected const runningOnMacintosh:Boolean
Returns true if this application is loaded under Mac OS X.
STATE_EMPTY | Constant |
protected const STATE_EMPTY:String = empty
String literal representing the empty state.
STATE_LOADING | Constant |
protected const STATE_LOADING:String = loading
String literal representing the loading state.
STATE_NORMAL | Constant |
protected const STATE_NORMAL:String = normal
String literal representing the normal state.