Adobe InCopy CS5 (7.0) Object Model JS: Window

previous page next page

Class

Window

A window.

Window

Property	Type	Access	Description
activePage	Page	r/w	The front-most page.
activeSpread	MasterSpread Spread	r/w	The front-most spread. Can return: Spread or MasterSpread.
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 Window within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
name	string	readonly	The name of the Window.
parent	Document	readonly	The parent of the Window (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
screenMode	ScreenModeOptions: ScreenModeOptions.PREVIEW_OFF ScreenModeOptions.PREVIEW_TO_PAGE	r/w	The screen mode for layout view.
selection	Array of Object	r/w	The selected object(s). Can also accept: Object or NothingEnum enumerator.
viewTab	ViewTabs: ViewTabs.LAYOUT_VIEW ViewTabs.GALLEY_VIEW ViewTabs.STORY_VIEW	r/w	The view in which to display the document.
zoomPercentage	number (range: 5 - 4000)	r/w	The size (as a percentage) to which to enlarge or reduce the view of the document. (Range: 5 to 4000)

Property	Type	Access	Description
AFTER_ACTIVATE	string	readonly	Dispatched after the Window 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 Window. This event bubbles. This event is not cancelable. (default: afterAttributeChanged)
AFTER_CLOSE	string	readonly	Dispatched when a Window 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 Window 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 Window is closed. This event bubbles. This event is cancelable. (default: beforeClose)
BEFORE_DEACTIVATE	string	readonly	Dispatched before the Window 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 Window.

Array of Window 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	The selection status of the Window in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

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

string toSpecifier ()
Retrieves the object specifier.

void zoom (given: ZoomOptions)
Magnifies or reduces the window to the specified display size.

Parameter	Type	Description
given	ZoomOptions: ZoomOptions.ZOOM_IN ZoomOptions.ZOOM_OUT ZoomOptions.FIT_SPREAD ZoomOptions.FIT_PAGE ZoomOptions.SHOW_PASTEBOARD ZoomOptions.ACTUAL_SIZE	The display size.