LayoutWindow

Methods:

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

Objects:

AnchorPoint, Boolean, EventListeners, Events, Layer, MasterSpread, NothingEnum, Number, Object, Page, PageItem, ProofingType, ScreenModeOptions, Spread, String, ViewDisplaySettings

Hierarchy:

Superclass: Window

Class: LayoutWindow

Property Listing

Property	Type	Access	Description
activeLayer	Layer String	read/write	The active layer. Can also accept: String.
activePage	Page	read/write	The front-most page.
activeSpread	Spread MasterSpread	read/write	The front-most spread. Can return: Spread or MasterSpread.
bounds	Array of Number	read/write	The bounds of the window (specified in pixels) in the form [top, left, bottom, right].
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
index	Number	readonly	The index of the LayoutWindow within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
name	String	readonly	The name of the LayoutWindow.
overprintPreview	Boolean	read/write	If true, display a simulation of overprinting.
parent	Document	readonly	The parent of the LayoutWindow (a Document).
preserveColorNumbers	Boolean	read/write	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	read/write	The profile used for proofing colors.
proofingType	ProofingType ProofingType.CUSTOM ProofingType.DOCUMENT_CMYK ProofingType.PROOF_OFF ProofingType.WORKING_CMYK	read/write	The method of proofing colors.
properties	Object	read/write	A property that allows setting of several properties at the same time.
screenMode	ScreenModeOptions ScreenModeOptions.PRESENTATION_PREVIEW ScreenModeOptions.PREVIEW_OFF ScreenModeOptions.PREVIEW_TO_BLEED ScreenModeOptions.PREVIEW_TO_PAGE ScreenModeOptions.PREVIEW_TO_SLUG	read/write	The screen mode for layout view.
selection	Array of Object NothingEnum.NOTHING	read/write	The selected object(s). Can also accept: Object or NothingEnum enumerator.
selectionKeyObject	PageItem NothingEnum.NOTHING	read/write	The key object of the selection. Can also accept: NothingEnum enumerator.
simulateInkBlack	Boolean	read/write	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	Boolean	read/write	If true, simulates the dingy white of real paper, according to the proofing profile. Note: Valid only when proofing type is custom.
transformReferencePoint	AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR Array of 2 Units.	read/write	The default anchor point around which to transform objects. Can return: AnchorPoint enumerator or Array of 2 Units.
viewDisplaySetting	ViewDisplaySettings ViewDisplaySettings.HIGH_QUALITY ViewDisplaySettings.OPTIMIZED ViewDisplaySettings.TYPICAL	read/write	The display performance preferences override for the view.
zoomPercentage	Number (range 5 - 4000)	read/write	The size (as a percentage) to which to enlarge or reduce the view of the document. (Range: 5 to 4000)

Constants/Events

Name	Type	Access	Description
AFTER_ACTIVATE	String	readonly	Dispatched after the LayoutWindow becomes active. This event bubbles. This event is not cancelable.
AFTER_ATTRIBUTE_CHANGED	String	readonly	Dispatched when the value of a property changes on this LayoutWindow. This event bubbles. This event is not cancelable.
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.
AFTER_OPEN	String	readonly	Dispatched after a LayoutWindow is opened. This event bubbles. This event is not cancelable.
AFTER_SELECTION_ATTRIBUTE_CHANGED	String	readonly	Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable.
AFTER_SELECTION_CHANGED	String	readonly	Dispatched after the active selection changes. This event bubbles. This event is not cancelable.
BEFORE_CLOSE	String	readonly	Dispatched before a LayoutWindow is closed. This event bubbles. This event is cancelable.
BEFORE_DEACTIVATE	String	readonly	Dispatched before the LayoutWindow becomes inactive. This event bubbles. This event is not cancelable.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined bringToFront ()

Brings the object to the front.

undefined close ()

Closes the LayoutWindow.

LayoutWindow getElements ()

Resolves the object specifier, creating an array of object references.

undefined maximize ()

Maximizes the window.

undefined minimize ()

Minimizes the window.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined restore ()

Restores the window.

undefined select (selectableItems:Array of Varies Objects NothingEnum Object SelectAll, [existingSelection:SelectionOptions=SelectionOptions])

Selects the specified object(s).

Parameter	Type	Description
selectableItems	Array of Objects NothingEnum.NOTHING Object SelectAll SelectAll.ALL	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)

Parameter

Type

Description

selectableItems

Array of Objects

NothingEnum.NOTHING

Object

SelectAll

SelectAll.ALL

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.

undefined zoom (given:ZoomOptions)

Magnifies or reduces the window to the specified display size.

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

Parameter

Type

Description

given

ZoomOptions

ZoomOptions.ACTUAL_SIZE

ZoomOptions.FIT_PAGE

ZoomOptions.FIT_SPREAD

ZoomOptions.SHOW_PASTEBOARD

ZoomOptions.ZOOM_IN

ZoomOptions.ZOOM_OUT

The display size.