Adobe InCopy CS6 (8.0) Object Model JS: ViewZoomBehavior

InCopy CS6

Class

ViewZoomBehavior

 A view zoom behavior object. Base Class: Behavior

QuickLinks

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

Hierarchy

Button | CheckBox | ComboBox | ListBox | RadioButton | SignatureField | TextBox
Behavior
ViewZoomBehavior
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
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 EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the ViewZoomBehavior.
indexnumber readonlyThe index of the ViewZoomBehavior 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 ViewZoomBehavior.
parentButton
CheckBox
ComboBox
ListBox
RadioButton
SignatureField
TextBox
readonlyThe parent of the ViewZoomBehavior (a Button, CheckBox, ComboBox, ListBox, RadioButton, TextBox or SignatureField).
propertiesObject r/wA property that allows setting of several properties at the same time.
viewZoomStyleViewZoomStyle:
ViewZoomStyle.FULL_SCREEN
ViewZoomStyle.ZOOM_IN
ViewZoomStyle.ZOOM_OUT
ViewZoomStyle.FIT_PAGE
ViewZoomStyle.ACTUAL_SIZE
ViewZoomStyle.FIT_WIDTH
ViewZoomStyle.FIT_VISIBLE
ViewZoomStyle.SINGLE_PAGE
ViewZoomStyle.ONE_COLUMN
ViewZoomStyle.TWO_COLUMN
readonlyThe view zoom style.

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 ViewZoomBehavior 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 ViewZoomBehavior.

string toSpecifier ()
Retrieves the object specifier.

Used in:

ViewZoomBehavior ViewZoomBehaviors.nextItem (obj: ViewZoomBehavior)

ViewZoomBehavior ViewZoomBehaviors.previousItem (obj: ViewZoomBehavior)

Return

Array of ViewZoomBehavior ViewZoomBehavior.getElements ()

ViewZoomBehavior ViewZoomBehaviors.[] (index: number)

ViewZoomBehavior ViewZoomBehaviors.anyItem ()

Array of ViewZoomBehavior ViewZoomBehaviors.everyItem ()

ViewZoomBehavior ViewZoomBehaviors.firstItem ()

ViewZoomBehavior ViewZoomBehaviors.item (index: varies)

ViewZoomBehavior ViewZoomBehaviors.itemByID (id: number)

ViewZoomBehavior ViewZoomBehaviors.itemByName (name: string)

Array of ViewZoomBehavior ViewZoomBehaviors.itemByRange (from: varies, to: varies)

ViewZoomBehavior ViewZoomBehaviors.lastItem ()

ViewZoomBehavior ViewZoomBehaviors.middleItem ()

ViewZoomBehavior ViewZoomBehaviors.nextItem (obj: ViewZoomBehavior)

ViewZoomBehavior ViewZoomBehaviors.previousItem (obj: ViewZoomBehavior)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index