Adobe InDesign CS6 Server (8.0) Object Model JS: ShowHideFieldsBehavior

InDesign Server CS6

Class

ShowHideFieldsBehavior

 A show/hide fields behavior object. Base Class: Behavior

QuickLinks

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

Hierarchy

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

Properties

PropertyTypeAccessDescription
behaviorEventBehaviorEvents:
BehaviorEvents.MOUSE_UP
BehaviorEvents.MOUSE_DOWN
BehaviorEvents.MOUSE_ENTER
BehaviorEvents.MOUSE_EXIT
BehaviorEvents.ON_FOCUS
BehaviorEvents.ON_BLUR
r/wThe event which triggers the behavior.
enableBehaviorbool r/wIf true, the behavior is enabled.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
fieldsToHideArray of
Buttons
CheckBoxes
ComboBoxes
ListBoxes
RadioButtons
SignatureFields
TextBoxes
r/wThe hidden interactive objects. Can return: Array of Buttons, CheckBoxes, ComboBoxes, ListBoxes, RadioButtons, TextBoxes or SignatureFields.
fieldsToShowArray of
Buttons
CheckBoxes
ComboBoxes
ListBoxes
RadioButtons
SignatureFields
TextBoxes
r/wThe visible interactive objects. Can return: Array of Buttons, CheckBoxes, ComboBoxes, ListBoxes, RadioButtons, TextBoxes or SignatureFields.
idnumber readonlyThe unique ID of the ShowHideFieldsBehavior.
indexnumber readonlyThe index of the ShowHideFieldsBehavior 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 ShowHideFieldsBehavior.
parentButton
CheckBox
ComboBox
ListBox
RadioButton
SignatureField
TextBox
readonlyThe parent of the ShowHideFieldsBehavior (a Button, CheckBox, ComboBox, ListBox, RadioButton, TextBox or SignatureField).
propertiesObject r/wA property that allows setting of several properties at the same time.

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

void remove ()
Deletes the ShowHideFieldsBehavior.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

ShowHideFieldsBehavior ShowHideFieldsBehaviors.nextItem (obj: ShowHideFieldsBehavior)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.previousItem (obj: ShowHideFieldsBehavior)

Return

Array of ShowHideFieldsBehavior ShowHideFieldsBehavior.getElements ()

ShowHideFieldsBehavior ShowHideFieldsBehaviors.[] (index: number)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.add ([withProperties: Object])

ShowHideFieldsBehavior ShowHideFieldsBehaviors.anyItem ()

Array of ShowHideFieldsBehavior ShowHideFieldsBehaviors.everyItem ()

ShowHideFieldsBehavior ShowHideFieldsBehaviors.firstItem ()

ShowHideFieldsBehavior ShowHideFieldsBehaviors.item (index: varies)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.itemByID (id: number)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.itemByName (name: string)

Array of ShowHideFieldsBehavior ShowHideFieldsBehaviors.itemByRange (from: varies, to: varies)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.lastItem ()

ShowHideFieldsBehavior ShowHideFieldsBehaviors.middleItem ()

ShowHideFieldsBehavior ShowHideFieldsBehaviors.nextItem (obj: ShowHideFieldsBehavior)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.previousItem (obj: ShowHideFieldsBehavior)

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