LayoutWindow
A layout window.
Go to Property Listing | Method Listing
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 |
|---|---|---|---|
|
read/write |
The active layer. Can also accept: String. |
||
|
read/write |
The front-most page. |
||
|
read/write |
The front-most spread. Can return: Spread or MasterSpread. |
||
|
read/write |
The bounds of the window (specified in pixels) in the form [top, left, bottom, right]. |
||
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
The index of the LayoutWindow within its containing object. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
readonly |
The name of the LayoutWindow. |
||
|
read/write |
If true, display a simulation of overprinting. |
||
|
readonly |
The parent of the LayoutWindow (a Document). |
||
|
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. |
||
|
read/write |
The profile used for proofing colors. |
||
|
read/write |
The method of proofing colors. |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
read/write |
The screen mode for layout view. |
||
|
read/write |
The selected object(s). Can also accept: Object or NothingEnum enumerator. |
||
|
read/write |
The key object of the selection. Can also accept: NothingEnum enumerator. |
||
|
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. |
||
|
read/write |
If true, simulates the dingy white of real paper, according to the proofing profile. Note: Valid only when proofing type is custom. |
||
|
Array of 2 Units. |
read/write |
The default anchor point around which to transform objects. Can return: AnchorPoint enumerator or Array of 2 Units. |
|
|
read/write |
The display performance preferences override for the view. |
||
|
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 |
|---|---|---|---|
|
readonly |
Dispatched after the LayoutWindow becomes active. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched when the value of a property changes on this LayoutWindow. This event bubbles. This event is not cancelable. |
||
|
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. |
||
|
readonly |
Dispatched after a LayoutWindow is opened. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched after the active selection changes. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched before a LayoutWindow is closed. This event bubbles. This event is cancelable. |
||
|
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 |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
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 |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
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 |
The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. |
|
existingSelection |
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 |
The display size. |
Object of
Application.activeWindow
Event.parent
EventListener.parent
MutationEvent.parent