GotoAnchorBehavior
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| anchorItem | BookmarkHyperlinkPageDestination HyperlinkTextDestination |
r/w | The anchor item, specified as a bookmark or a hyperlink text or page destination. Can return: Bookmark, HyperlinkTextDestination or HyperlinkPageDestination. |
| anchorName | string | readonly | The anchor name. |
| behaviorEvent | BehaviorEvents: BehaviorEvents.MOUSE_UP BehaviorEvents.MOUSE_DOWN BehaviorEvents.MOUSE_ENTER BehaviorEvents.MOUSE_EXIT BehaviorEvents.ON_FOCUS BehaviorEvents.ON_BLUR |
r/w | The event which triggers the behavior. |
| enableBehavior | bool | r/w | If true, the behavior is enabled. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| filePath | File string |
r/w | The file path (colon delimited on the Mac OS). Can also accept: File. |
| id | number | readonly | The unique ID of the GotoAnchorBehavior. |
| index | number | readonly | The index of the GotoAnchorBehavior within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | readonly | The name of the GotoAnchorBehavior. |
| parent | Button | readonly | The parent of the GotoAnchorBehavior (a Button). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| zoomSetting | GoToZoomOptions: GoToZoomOptions.INHERIT_ZOOM GoToZoomOptions.FIT_WINDOW GoToZoomOptions.FIT_WIDTH GoToZoomOptions.FIT_VISIBLE GoToZoomOptions.ACTUAL_SIZE |
r/w | The zoom setting. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of GotoAnchorBehavior getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the GotoAnchorBehavior.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the GotoAnchorBehavior.
string toSpecifier ()
Retrieves the object specifier.
Used in:
GotoAnchorBehavior GotoAnchorBehaviors.nextItem (obj: GotoAnchorBehavior)
GotoAnchorBehavior GotoAnchorBehaviors.previousItem (obj: GotoAnchorBehavior)
Return
Array of GotoAnchorBehavior GotoAnchorBehavior.getElements ()
GotoAnchorBehavior GotoAnchorBehaviors.[] (index: number)
GotoAnchorBehavior GotoAnchorBehaviors.add ([withProperties: Object])
GotoAnchorBehavior GotoAnchorBehaviors.anyItem ()
Array of GotoAnchorBehavior GotoAnchorBehaviors.everyItem ()
GotoAnchorBehavior GotoAnchorBehaviors.firstItem ()
GotoAnchorBehavior GotoAnchorBehaviors.item (index: varies)
GotoAnchorBehavior GotoAnchorBehaviors.itemByID (id: number)
GotoAnchorBehavior GotoAnchorBehaviors.itemByName (name: string)
Array of GotoAnchorBehavior GotoAnchorBehaviors.itemByRange (from: varies, to: varies)
GotoAnchorBehavior GotoAnchorBehaviors.lastItem ()
GotoAnchorBehavior GotoAnchorBehaviors.middleItem ()
GotoAnchorBehavior GotoAnchorBehaviors.nextItem (obj: GotoAnchorBehavior)
GotoAnchorBehavior GotoAnchorBehaviors.previousItem (obj: GotoAnchorBehavior)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |