Adobe InDesign CS6 (8.0) Object Model JS: StoryWindow

InDesign CS6

Class

StoryWindow

 A story window. Base Class: Window

QuickLinks

addEventListener, bringToFront, close, getElements, maximize, minimize, removeEventListener, restore, select, toSource, toSpecifier

Hierarchy

Document
Window
StoryWindow
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
boundsArray of number r/wThe bounds of the window (specified in pixels) in the form [top, left, bottom, right].
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the StoryWindow within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring readonlyThe name of the StoryWindow.
parentDocument readonlyThe parent of the StoryWindow (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
selectionArray of NothingEnum
Object
Object
r/wThe selected object(s). Can also accept: Object or NothingEnum enumerator.
selectionKeyObjectNothingEnum
PageItem
r/wThe key object of the selection. Can also accept: NothingEnum enumerator.

Class

PropertyTypeAccessDescription
AFTER_ACTIVATEstring readonlyDispatched after the StoryWindow becomes active. This event bubbles. This event is not cancelable. (default: afterActivate)
AFTER_ATTRIBUTE_CHANGEDstring readonlyDispatched when the value of a property changes on this StoryWindow. This event bubbles. This event is not cancelable. (default: afterAttributeChanged)
AFTER_CLOSEstring readonlyDispatched when a StoryWindow is closing. Since the close has been committed, it can no longer be canceled. This event bubbles. This event is not cancelable. (default: afterClose)
AFTER_OPENstring readonlyDispatched after a StoryWindow is opened. This event bubbles. This event is not cancelable. (default: afterOpen)
AFTER_SELECTION_ATTRIBUTE_CHANGEDstring readonlyDispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionAttributeChanged)
AFTER_SELECTION_CHANGEDstring readonlyDispatched after the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionChanged)
BEFORE_CLOSEstring readonlyDispatched before a StoryWindow is closed. This event bubbles. This event is cancelable. (default: beforeClose)
BEFORE_DEACTIVATEstring readonlyDispatched before the StoryWindow becomes inactive. This event bubbles. This event is not cancelable. (default: beforeDeactivate)

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)

void bringToFront ()
Brings the object to the front.

void close ()
Closes the StoryWindow.

Array of StoryWindow getElements ()
Resolves the object specifier, creating an array of object references.

void maximize ()
Maximizes the window.

void minimize ()
Minimizes the window.

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)

void restore ()
Restores the window.

void select (selectableItems: varies[, existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the specified object(s).

ParameterTypeDescription
selectableItemsArray of Objects
NothingEnum
Object
SelectAll
The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
SelectionOptions.SET_KEY
The selection status of the StoryWindow in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

string toSource ()
Generates a string which, if executed, will return the StoryWindow.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.activeWindow

Used in:

StoryWindow StoryWindows.nextItem (obj: StoryWindow)

StoryWindow StoryWindows.previousItem (obj: StoryWindow)

Return

StoryWindow Story.storyEdit ()

Array of StoryWindow StoryWindow.getElements ()

StoryWindow StoryWindows.[] (index: number)

StoryWindow StoryWindows.anyItem ()

Array of StoryWindow StoryWindows.everyItem ()

StoryWindow StoryWindows.firstItem ()

StoryWindow StoryWindows.item (index: varies)

StoryWindow StoryWindows.itemByName (name: string)

Array of StoryWindow StoryWindows.itemByRange (from: varies, to: varies)

StoryWindow StoryWindows.lastItem ()

StoryWindow StoryWindows.middleItem ()

StoryWindow StoryWindows.nextItem (obj: StoryWindow)

StoryWindow StoryWindows.previousItem (obj: StoryWindow)

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