Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
An
INavigator
instance uses this interface to communicate with its
hosting environment.
apiVersion:Array
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The API version number as recorded in the apiVersion
field
of the navigator's navigator.xml file.
Implementation public function get apiVersion():Array
applicationFontList:Array
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Returns an array of Objects that describe fonts available on the system or to the hosting application
Fonts that are not legally embeddable are filtered out.
Each entry in the array is an Object which contains the following attributes:
Attribute | Description |
---|
fontName | Name of the font |
fontWeight | "normal" or "bold" |
fontPosture | "normal" or "italic"| |
familyName | Family name of the font, for example, "Adobe Caslon Pro Italic" would have the family name "Adobe Caslon" |
styleName | Style name of the font, for example, "Adobe Caslon Pro Italic" would have the family name "Italic" |
psName | PostScript name of the font, for example, "Adobe Caslon Pro Italic" has the PostScript name "ACaslonPro-Italic" |
This property can be used as the source for data binding.
Implementation public function get applicationFontList():Array
authoringMode:Boolean
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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.
Implementation public function get authoringMode():Boolean
collection:ICollection
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Retrieves the portfolio (an ICollection
instance) on which the navigator is operating.
Implementation public function get collection():ICollection
collectionDropManager:ICollectionDropManager
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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.
Implementation public function get collectionDropManager():ICollectionDropManager
See also
commands:Object
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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:
- the property name is an
ICommand
name.
- the property value is an
ICommand
instance.
This property can be used as the source for data binding.
Implementation public function get commands():Object
See also
currentFolder:IAttachment
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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.
Implementation public function get currentFolder():IAttachment
public function set currentFolder(value:IAttachment):void
currentPropertyContext:IPropertyContext
[write-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Sets the current IPropertyContext
for the navigator, based
on the user's interaction.
Implementation public function set currentPropertyContext(value:IPropertyContext):void
See also
locale:String
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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".
Implementation public function get locale():String
navigatorColorPalette:Object
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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.
The value for each key is a uint
specifying an RGB color.
This property can be used as the source for data binding.
Implementation public function get navigatorColorPalette():Object
public function set navigatorColorPalette(value:Object):void
navigatorFont:Font
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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.
Implementation public function get navigatorFont():Font
See also
flash.text.Font
propertyContexts:Array
[write-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Sets an IPropertyContext
array for properties supported by the
navigator. If contextArray is null
, it will be treated as if it were
an empty array. Any null
entries in the array will be ignored; if multiple
IPropertyContext
entries have equal name
properties, the resulting
behavior is undefined.
The caller retains ownerwhip of contextArray
; further modifications to it will
not affect this property.
Implementation public function set propertyContexts(value:Array):void
See also
rootDocument:IPDFDocument
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.1 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The portfolio's root document.
The document that contains the collection. A portfolio's root
document is sometimes referred to as its "cover sheet". The value of
this property does not change over the lifetime of this
INavigatorHost
instance.
Implementation public function get rootDocument():IPDFDocument
selection:Array
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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.
Implementation public function get selection():Array
public function set selection(value:Array):void
See also
viewConfiguration:Object
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.1 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Describes the current configuration of the view in which the
navigator is being displayed. The value might be missing one
or more properties, but will never be null.
The view configuration is described by a set of key-value
properties. It is possible that a navigator embedded in a PDF
document may someday be displayed in a runtime environment that
doesn't support all of the current view configuration keys. You
should always use the Object.hasOwnProperty()
method
to check for the existence of a property before getting its
value.
The following view configuration properties can be present:
"collectionViewLayout": The collection view layout. If present,
can have one of the following values:
- "navigatorLeft": The collection view is split into left and
right panes. The navigator is being displayed in the left
pane and the right pane can be used to show the root document
or preview an attachment. In the references for the .nav file
format and the PDF language, this split view configuration is
described as "vertical" or "split vertically".
- "navigatorOnly": The collection view is not split. The
navigator takes up the entire view.
- "navigatorTop": The collection view is split into top and
bottom panes. The navigator is being displayed in the top
pane and the bottom pane can be used to show the root
document or preview an attachment. In the references for the
.nav file format and the PDF language, this split view
configuration is described as "horizontal" or "split
horizontally".
- "previewOnly": The collection view is not split. The
navigator is still being run, but is completely obscured by
the root document or a preview of an attachment.
"collectionPreviewDocumentType": The type of document being shown
in conjunction with the navigator. Can have one of the following
values:
- "none": No document is being shown.
- "attachment": A preview of an attachment is being shown.
- "root": The root document is being shown.
Where the document is shown depends on the collection view layout
(see above):
- "navigatorLeft": The document is shown in the right pane.
- "navigatorOnly": No document is being shown.
- "navigatorTop": The document is shown in the bottom pane.
- "previewOnly": The document is shown layered on top of the
navigator, obscuring it.
This property can be used as the source for data binding.
Implementation public function get viewConfiguration():Object
public function getLocalizedString(key:String):String
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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.
|
Returns | String — The string identified by key , localized for the
Acrobat's current runtime locale.
|
Throws | Error — An Error is thrown if an
unsupported key argument is specified.
|
See also
public function requestCommands(commandNames:Array, callback:Function = null):void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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):void
The
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 ) — An optional notification function, as described above.
|
See also
public function setNextPrevious(next:IAttachment, previous:IAttachment):void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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
public function showRootDocument():void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.1 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Shows the portfolio's root document.
The root document is called the "cover sheet" in the Acrobat user
interface. When the portfolio window is split, one pane displays the
navigator and the other pane displays either an attachment preview
or the cover sheet, or is blank. When the portfolio window is not
split, the cover sheet or attachment preview is shown on top of the
navigator; the navigator remains running but is completely
obscured.
In both the split and non-split cases, showing the cover sheet
hides the attachment preview, if it is showing, and previewing an
attachment hides the cover sheet view, if it is showing. There is no
method for hiding the root document, but the cover sheet view can be
replaced with an attachment preview by executing the
CommandType.PREVIEW
command, which can be requested by
calling the requestCommands()
method.
If the user has permission to edit the root document, the cover
sheet view is editable. Depending on the purpose and design of the
portfolio, the navigator developer may need to be careful about
previewing an attachment while the user is working with the root
document.
public function updateProperty(context:IPropertyContext, property:IProperty):void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
A function to indicate that the navigator has changed the given IProperty
in the context of the given IPropertyContext
. If property
is not
present in context
's properties
array, or if context
has not been previously set in propertyContexts
or currentPropertyContext
,
then this function has no effect.
Parameters
See also
Event Object Type: com.adobe.portfolio.api.PropertyValueChangedEvent
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
An event that is dispatched for a change to a property value.
Since contexts and properties cannot be directly manipulated
by the host, events are used to indicate that a property has changed.
This is analogous to FieldValueChangedEvent
.
See also
Event Object Type: com.adobe.portfolio.api.RightClickEvent
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 9.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.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
.
See also
Fri Apr 15 2011, 11:10 AM -07:00