Adobe InCopy CS5 (7.0) Object Model JS: GotoAnchorBehavior

InCopy CS5

Class

GotoAnchorBehavior

 A behavior object that jumps to an anchor. Base Class: Behavior

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, removeEventListener, toSource, toSpecifier

Hierarchy

Button
Behavior
GotoAnchorBehavior
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
anchorNamestring readonlyThe anchor name.
behaviorEventBehaviorEvents:
BehaviorEvents.MOUSE_UP
BehaviorEvents.MOUSE_DOWN
BehaviorEvents.MOUSE_ENTER
BehaviorEvents.MOUSE_EXIT
BehaviorEvents.ON_FOCUS
BehaviorEvents.ON_BLUR
readonlyThe event which triggers the behavior.
enableBehaviorbool readonlyIf true, the behavior is enabled.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
filePathstring readonlyThe file path (colon delimited on the Mac OS). Can also accept: File.
idnumber readonlyThe unique ID of the GotoAnchorBehavior.
indexnumber readonlyThe index of the GotoAnchorBehavior within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring readonlyThe name of the GotoAnchorBehavior.
parentButton readonlyThe parent of the GotoAnchorBehavior (a Button).
propertiesObject r/wA property that allows setting of several properties at the same time.
zoomSettingGoToZoomOptions:
GoToZoomOptions.INHERIT_ZOOM
GoToZoomOptions.FIT_WINDOW
GoToZoomOptions.FIT_WIDTH
GoToZoomOptions.FIT_VISIBLE
GoToZoomOptions.ACTUAL_SIZE
readonlyThe zoom setting.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.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, 23-Mar-2011 v3.0.3dContents :: Index