Class

GotoStateBehavior

 A goto state behavior. Base Class: Behavior

QuickLinks

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

Hierarchy

Button
Behavior
GotoStateBehavior
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
associatedMultiStateObjectMultiStateObject r/wThe associated multi-state object page item.
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 readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
goBackOnRollOffbool r/wIf true, will automatically go back to the prior state on roll off of the rollover event.
idnumber readonlyThe unique ID of the GotoStateBehavior.
indexnumber readonlyThe index of the GotoStateBehavior 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 GotoStateBehavior.
parentButton readonlyThe parent of the GotoStateBehavior (a Button).
propertiesObject r/wA property that allows setting of several properties at the same time.
stateNamestring r/wThe name of the state in the associated multi-state object.

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

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

GotoStateBehavior GotoStateBehaviors.nextItem (obj: GotoStateBehavior)

GotoStateBehavior GotoStateBehaviors.previousItem (obj: GotoStateBehavior)

Return

Array of GotoStateBehavior GotoStateBehavior.getElements ()

GotoStateBehavior GotoStateBehaviors.[] (index: number)

GotoStateBehavior GotoStateBehaviors.add ([withProperties: Object])

GotoStateBehavior GotoStateBehaviors.anyItem ()

Array of GotoStateBehavior GotoStateBehaviors.everyItem ()

GotoStateBehavior GotoStateBehaviors.firstItem ()

GotoStateBehavior GotoStateBehaviors.item (index: varies)

GotoStateBehavior GotoStateBehaviors.itemByID (id: number)

GotoStateBehavior GotoStateBehaviors.itemByName (name: string)

Array of GotoStateBehavior GotoStateBehaviors.itemByRange (from: varies, to: varies)

GotoStateBehavior GotoStateBehaviors.lastItem ()

GotoStateBehavior GotoStateBehaviors.middleItem ()

GotoStateBehavior GotoStateBehaviors.nextItem (obj: GotoStateBehavior)

GotoStateBehavior GotoStateBehaviors.previousItem (obj: GotoStateBehavior)

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