Adobe InDesign CS6 (8.0) Object Model JS: LayoutWindow

InDesign CS6

previous page next page

Class

LayoutWindow

A layout window. Base Class: Window

QuickLinks

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

Hierarchy

Document

Window

LayoutWindow

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
activeLayer	Layer String	r/w	The active layer. Can also accept: String.
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 LayoutWindow within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
name	string	readonly	The name of the LayoutWindow.
overprintPreview	bool	r/w	If true, display a simulation of overprinting.
parent	Document	readonly	The parent of the LayoutWindow (a Document).
preserveColorNumbers	bool	r/w	If true, leaves color values unchanged for CMYK objects without embedded profiles and native objects such as line art or type. Note: Converts images whose profiles differ from the profile of the simulated device. Valid only when proofing type is custom.
proofingProfile	string	r/w	The profile used for proofing colors.
proofingType	ProofingType: ProofingType.PROOF_OFF ProofingType.DOCUMENT_CMYK ProofingType.WORKING_CMYK ProofingType.CUSTOM	r/w	The method of proofing colors.
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 ScreenModeOptions.PREVIEW_TO_BLEED ScreenModeOptions.PREVIEW_TO_SLUG ScreenModeOptions.PRESENTATION_PREVIEW	r/w	The screen mode for layout view.
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.
simulateInkBlack	bool	r/w	If true, simulates the dark gray produced by many printers in place of solid black, according to the proofing profile. Note: Valid only when proofing type is custom.
simulatePaperWhite	bool	r/w	If true, simulates the dingy white of real paper, according to the proofing profile. Note: Valid only when proofing type is custom.
transformReferencePoint	AnchorPoint Array of 2 Units	r/w	The default anchor point around which to transform objects. Can return: AnchorPoint enumerator or Array of 2 Units.
viewDisplaySetting	ViewDisplaySettings: ViewDisplaySettings.HIGH_QUALITY ViewDisplaySettings.TYPICAL ViewDisplaySettings.OPTIMIZED	r/w	The display performance preferences override for the view.
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)

Class

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

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

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

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

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.