[read-only]
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.
[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.
An event that is dispatched when the user right clicks in the PDF portfolio navigator window.
INavigatorHost
Property Detail
apiVersion
property
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
property
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
property
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
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.
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
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
property
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
property
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
property
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
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-nullIAttachment 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
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.
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.
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.
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.
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_MENUICommand.
