| Package | acrobat.collection |
| Interface | public interface INavigatorHost extends IEventDispatcher |
| Player Version : | Acrobat ActionScript API 9.0 |
INavigator instance uses this interface to communicate with its
hosting environment.
See also
| Property | Defined By | ||
|---|---|---|---|
| authoringMode : Boolean [read-only]
Returns a value of true when Acrobat is in collection
authoring mode. | INavigatorHost | ||
| collection : ICollection [read-only]
Retrieves the portfolio (an ICollection instance) on which the navigator is operating. | INavigatorHost | ||
| collectionDropManager : ICollectionDropManager [read-only]
Gets the drop manager object used by flex developers to specify the target directory
for drag and drop of files from the OS, and by flash developers to enable and control
drag and drop functionality. | INavigatorHost | ||
| commands : Object [read-only]
Returns the set of delivered ICommand instances as requested via
requestCommands(). | INavigatorHost | ||
| currentFolder : IAttachment
The folder where new attachments will be added when Acrobat menu
items such as "Add File...", "Add Folder...", and "New Folder..."
are invoked. | INavigatorHost | ||
| locale : String [read-only]
Returns Acrobat's current runtime locale. | INavigatorHost | ||
| navigatorColorPalette : Object [read-only]
Returns a suggested palette of colors for the navigator. | INavigatorHost | ||
| navigatorFont : Font [read-only]
Use this font to get the same look as the custom navigators that Adobe includes with
Acrobat. | INavigatorHost | ||
| selection : Array
The currently selected set of IAttachment instances. | INavigatorHost | ||
| Method | Defined By | ||
|---|---|---|---|
Formats a date to match the formatting of dates elsewhere in
Acrobat's (non-Flash) user interface. | INavigatorHost | ||
Gets a localized string from Acrobat's resources. | INavigatorHost | ||
Requests a set of named ICommand instances. | INavigatorHost | ||
Updates Acrobat's next and previous attachment values. | INavigatorHost | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| An event that is dispatched when the user right clicks in the PDF portfolio navigator window. | INavigatorHost | |||
| authoringMode | property |
authoringMode:Boolean [read-only] | Player Version : | Acrobat ActionScript API 9.0 |
Returns a value of true when Acrobat is in collection
authoring mode. This flag is useful if your navigator has
functionality that you want to make available to collection authors
only.
This property can be used as the source for data binding.
public function get authoringMode():Boolean| collection | property |
collection:ICollection [read-only] | Player Version : | Acrobat ActionScript API 9.0 |
Retrieves the portfolio (an ICollection instance) on which the navigator is operating.
public function get collection():ICollection| collectionDropManager | property |
collectionDropManager:ICollectionDropManager [read-only] | Player Version : | Acrobat ActionScript API 9.0 |
Gets the drop manager object used by flex developers to specify the target directory for drag and drop of files from the OS, and by flash developers to enable and control drag and drop functionality.
public function get collectionDropManager():ICollectionDropManagerSee also
| commands | property |
commands:Object [read-only] | Player Version : | Acrobat ActionScript API 9.0 |
Returns the set of delivered ICommand instances as requested via
requestCommands(). The instance returned is a copy;
changes to it have no effect on the set held by INavigatorHost.
The value of this property is an Object. For each dynamic properties of this
object:
ICommand name.ICommand instance.This property can be used as the source for data binding.
public function get commands():ObjectSee also
| currentFolder | property |
currentFolder:IAttachment [read-write] | Player Version : | Acrobat ActionScript API 9.0 |
The folder where new attachments will be added when Acrobat menu items such as "Add File...", "Add Folder...", and "New Folder..." are invoked.
If currentFolder is null, new attachments
will be added at the root level of the tree of attachments.
This property can be used as the source for data binding.
public function get currentFolder():IAttachment public function set currentFolder(value:IAttachment):void| locale | property |
locale:String [read-only] | Player Version : | Acrobat ActionScript API 9.0 |
Returns Acrobat's current runtime locale. This will not change during the navigator's lifetime. The locale is given as an ISO language and region code. For example, "en_US".
public function get locale():String| navigatorColorPalette | property |
navigatorColorPalette:Object [read-only] | Player Version : | Acrobat ActionScript API 9.0 |
Returns a suggested palette of colors for the navigator.
The returned palette is an Object with the following
key strings:
"background": A color to use for the navigator's background."cardBackground": A color to use for an attachment card's background."cardBorder": A color to use for an attachment card's border."primaryText": Suggested uses for this color include attachment or file names, and links."secondaryText": Suggested uses for this color include all other text.uint specifying an RGB color.
This property can be used as the source for data binding.
public function get navigatorColorPalette():Object| navigatorFont | property |
navigatorFont:Font [read-only] | Player Version : | Acrobat ActionScript API 9.0 |
Use this font to get the same look as the custom navigators that Adobe includes with Acrobat.
This font should have the glyphs needed to display the language used by Acrobat's current runtime locale, but may not have good coverage of glyphs for other locales.
The characteristics of this font (the supported font name, the font styles and glyphs) may
change when Acrobat's runtime local changes. You should not assume that the Font
returned here in one run of Acrobat will have the same properties as the Font
returned in subsequent runs.
public function get navigatorFont():FontSee also
| selection | property |
selection:Array [read-write] | Player Version : | Acrobat ActionScript API 9.0 |
The currently selected set of IAttachment instances.
The selection can be controlled both by the host (typically via host-side user interface
controls) or by the INavigator instance.
Each element must be a valid, non-null IAttachment instance.
The Array may be empty
(signifying that there is no selection) but it can never be null. Duplicates are not allowed.
Multiple IAttachment instances can be selected at once.
It is also the IAttachment instance on which
the next and previous instances are based.
Changing the selection may invalidate the current values of the next and previous instances.
In response to selection changes, the INavigator should call setNextPrevious()
if necessary to indicate such changes.
This property can be used as the source for data binding.
public function get selection():Array public function set selection(value:Array):voidSee also
| formatDate | () | method |
public function formatDate(date:Date):String| Player Version : | Acrobat ActionScript API 9.0 |
Formats a date to match the formatting of dates elsewhere in Acrobat's (non-Flash) user interface.
The formatting reflects Acrobat's current runtime locale.
Parameters
date:Date — A Date object
|
String — A formatted version of the date
|
| getLocalizedString | () | method |
public function getLocalizedString(key:String):String| Player Version : | Acrobat ActionScript API 9.0 |
Gets a localized string from Acrobat's resources.
Only a limited set of keys is supported:
"attachmentCreationDate": a display name for the IAttachment.creationDate property."attachmentDescription": a display name for the IAttachment.description property."attachmentFileName": a display name for the IAttachment.fileName property."attachmentModDate": a display name for the IAttachment.modDate property."attachmentSize": a display name for the IAttachment.size property."attachmentCompressedSize": a display name for the IAttachment.compressedSize property."attachmentPath": a display name for the IAttachment.path property.Parameters
key:String — A unique key identifying a localized string.
|
String — The string identified by key, localized for the
Acrobat's current runtime locale.
|
Error — An Error is thrown if an
unsupported key argument is specified.
|
See also
| requestCommands | () | method |
public function requestCommands(commandNames:Array, callback:Function = null):void| Player Version : | Acrobat ActionScript API 9.0 |
Requests a set of named ICommand instances. The requested ICommand
instances will be added to the commands property.
Requests are cumulative (that is, existing ICommand instances will not be removed
from the commands property). A particular ICommand instance will never be
delivered more than once, although it is permitted to request it multiple times.
If one or more of the command names is invalid, only those that are valid will be delivered.
The method accepts an optional callback function as an argument.
The callback function is invoked to indicate the result of the operation.
The callback function receives a single argument, an Object,
and has the following signature:
function callback(response:Object):voidThe
response:Object parameter holds properties that define the response.
These include:
| Property | Type | Value |
|---|---|---|
success | Boolean | true if the request succeeded for all command names in the array;
false if the request failed for one or more names. |
invalidCommandNames | Array: each element is a String. | The names of all commands that could not be delivered, if any; otherwise
an empty Array. |
Parameters
commandNames:Array — An Array of command names. Each element is a String,
and legal values are any of the values defined in the CommandType class.
| |
callback:Function (default = null) |
See also
| setNextPrevious | () | method |
public function setNextPrevious(next:IAttachment, previous:IAttachment):void| Player Version : | Acrobat ActionScript API 9.0 |
Updates Acrobat's next and previous attachment values.
Acrobat maintains values for the next and previous attachments, based on
the selection and the current sort order. When either the selection or the sort order
changes, the user interface's definition of next and previous may change.
INavigator instances are responsible
for updating these values in response to selection and sort changes.
Parameters
next:IAttachment — The new value for the next IAttachment.
A null value means there is no next IAttachment.
| |
previous:IAttachment — The new value for the previous IAttachment.
A null value means there is no previous IAttachment.
|
See also
| rightClick | Event |
acrobat.collection.RightClickEventacrobat.collection.AcrobatDragEvent.DRAG_COMPLETE| Player Version : | Acrobat ActionScript API 9.0 |
An event that is dispatched when the user right clicks in the PDF portfolio navigator window.
The typical response
to this event is to execute the CommandType.CONTEXT_MENU ICommand.
mx.events.DragEvent.DRAG_COMPLETE constant defines the value of the
type property of the event object for a dragComplete event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
action | The mx.managers.DragManager action that caused the event:
DragManager.COPY, DragManager.LINK,
DragManager.MOVE, or DragManager.NONE. |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
dragInitiator | The component that initiated the drag. |
dragSource | The mx.core.DragSource object containing the
data being dragged. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to access the
Object listening for the event. |
See also
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/navigator/9/Navigator_SDK9_HTMLHelp/API_References/Acrobat_Navigator_API_Reference/acrobat/collection/INavigatorHost.html