Adobe InDesign CS6 (8.0) Object Model JS: StoryWindow

previous page next page

Class

StoryWindow

A story window. Base Class: Window

StoryWindow

Property	Type	Access	Description
bounds	Array of number	r/w	The bounds of the window (specified in pixels) in the form [top, left, bottom, right].
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
index	number	readonly	The index of the StoryWindow within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
name	string	readonly	The name of the StoryWindow.
parent	Document	readonly	The parent of the StoryWindow (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
selection	Array of NothingEnum Object Object	r/w	The selected object(s). Can also accept: Object or NothingEnum enumerator.
selectionKeyObject	NothingEnum PageItem	r/w	The key object of the selection. Can also accept: NothingEnum enumerator.

Property	Type	Access	Description
AFTER_ACTIVATE	string	readonly	Dispatched after the StoryWindow becomes active. This event bubbles. This event is not cancelable. (default: afterActivate)
AFTER_ATTRIBUTE_CHANGED	string	readonly	Dispatched when the value of a property changes on this StoryWindow. This event bubbles. This event is not cancelable. (default: afterAttributeChanged)
AFTER_CLOSE	string	readonly	Dispatched 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_OPEN	string	readonly	Dispatched after a StoryWindow is opened. This event bubbles. This event is not cancelable. (default: afterOpen)
AFTER_SELECTION_ATTRIBUTE_CHANGED	string	readonly	Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionAttributeChanged)
AFTER_SELECTION_CHANGED	string	readonly	Dispatched after the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionChanged)
BEFORE_CLOSE	string	readonly	Dispatched before a StoryWindow is closed. This event bubbles. This event is cancelable. (default: beforeClose)
BEFORE_DEACTIVATE	string	readonly	Dispatched before the StoryWindow becomes inactive. This event bubbles. This event is not cancelable. (default: beforeDeactivate)

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This 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).

Parameter	Type	Description
selectableItems	Array of Objects NothingEnum Object SelectAll	The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelection	SelectionOptions: 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)