Extends
Static Properties
Name | Description |
---|---|
AFTER_ACTIVATE = "afterActivate" | string Dispatched after the LayoutWindow becomes active. This event bubbles. This event is not cancelable. |
AFTER_ATTRIBUTE_CHANGED = "afterAttributeChanged" | string Dispatched when the value of a property changes on this LayoutWindow. This event bubbles. This event is not cancelable. |
AFTER_CLOSE = "afterClose" | string 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 = "afterOpen" | string Dispatched after a LayoutWindow is opened. This event bubbles. This event is not cancelable. |
AFTER_SELECTION_ATTRIBUTE_CHANGED = "afterSelectionAttributeChanged" | string Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable. |
AFTER_SELECTION_CHANGED = "afterSelectionChanged" | string Dispatched after the active selection changes. This event bubbles. This event is not cancelable. |
BEFORE_CLOSE = "beforeClose" | string Dispatched before a LayoutWindow is closed. This event bubbles. This event is cancelable. |
BEFORE_DEACTIVATE = "beforeDeactivate" | string Dispatched before the LayoutWindow becomes inactive. This event bubbles. This event is not cancelable. |
Instance Properties
Name | Description | Access |
---|---|---|
activeLayer | Layer The active layer. Can also accept: String. | read-write |
activePage | Page The front-most page. | read-write |
activeSpread | The front-most spread. Can return: Spread or MasterSpread. | read-write |
bounds | number The bounds of the window (specified in pixels) in the form [top, left, bottom, right]. | read-write |
eventListeners | EventListeners A collection of event listeners. | read-only |
events | Events A collection of events. | read-only |
index | number The index of the LayoutWindow within its containing object. | read-only |
isValid | bool Returns true if the object specifier resolves to valid objects. | read-only |
name | string The name of the LayoutWindow. | read-only |
overprintPreview | bool If true, display a simulation of overprinting. | read-write |
parent | Document The parent of the LayoutWindow (a Document). | read-only |
preserveColorNumbers | bool 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 |
proofingProfile | string The profile used for proofing colors. | read-write |
proofingType | ProofingType The method of proofing colors. | read-write |
properties | Object A property that allows setting of several properties at the same time. | read-write |
screenMode | ScreenModeOptions The screen mode for layout view. | read-write |
selection | Object The selected object(s). Can also accept: Object or NothingEnum enumerator. | read-write |
selectionKeyObject | PageItem The key object of the selection. Can also accept: NothingEnum enumerator. | read-write |
simulateInkBlack | bool 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 |
simulatePaperWhite | bool If true, simulates the dingy white of real paper, according to the proofing profile. Note: Valid only when proofing type is custom. | read-write |
transformReferencePoint | The default anchor point around which to transform objects. Can return: AnchorPoint enumerator or Array of 2 Units. | read-write |
viewDisplaySetting | ViewDisplaySettings The display performance preferences override for the view. | read-write |
zoomPercentage | number The size (as a percentage) to which to enlarge or reduce the view of the document. (Range: 5 to 4000) | read-write |
Methods
addEventListener( | eventType, handler [, captures]) |
→ EventListener |
bringToFront( | ) |
close( | ) |
getElements( | ) |
→ LayoutWindow |
maximize( | ) |
minimize( | ) |
removeEventListener( | eventType, handler [, captures]) |
→ bool |
restore( | ) |
select( | selectableItems [, existingSelection]) |
toSource( | ) |
→ string |
toSpecifier( | ) |
→ string |
zoom( | given) |
-
addEventListener( eventType, handler [, captures=false])→ EventListener -
Adds an event listener.
eventType
string The event type. handler
The event handler. Can accept: File or JavaScript Function. captures
bool This parameter is obsolete. (Optional) -
bringToFront( ) -
Brings the object to the front.
-
close( ) -
Closes the LayoutWindow.
-
getElements( )→ LayoutWindow -
Resolves the object specifier, creating an array of object references.
-
maximize( ) -
Maximizes the window.
-
minimize( ) -
Minimizes the window.
-
removeEventListener( eventType, handler [, captures=false])→ bool -
Removes the event listener.
eventType
string The registered event type. handler
The registered event handler. Can accept: File or JavaScript Function. captures
bool This parameter is obsolete. (Optional) -
restore( ) -
Restores the window.
-
select( selectableItems [, existingSelection=SelectionOptions.REPLACE_WITH]) -
Selects the specified object(s).
selectableItems
The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. existingSelection
SelectionOptions The selection status of the LayoutWindow in relation to previously selected objects. (Optional) -
toSource( )→ string -
Generates a string which, if executed, will return the LayoutWindow.
-
toSpecifier( )→ string -
Retrieves the object specifier.
-
zoom( given) -
Magnifies or reduces the window to the specified display size.
given
ZoomOptions The display size.