Edit in GitHubLog an issue

LayoutWindow

A layout window.

Class

Read Only

String AFTER_SELECTION_CHANGED = afterSelectionChanged

Dispatched after the active selection changes. This event bubbles. This event is not cancelable.


Read Only

String AFTER_SELECTION_ATTRIBUTE_CHANGED = afterSelectionAttributeChanged

Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable.


Read Only

String BEFORE_DEACTIVATE = beforeDeactivate

Dispatched before the LayoutWindow becomes inactive. This event bubbles. This event is not cancelable.


Read Only

String AFTER_ACTIVATE = afterActivate

Dispatched after the LayoutWindow becomes active. This event bubbles. This event is not cancelable.


Read Only

String AFTER_ATTRIBUTE_CHANGED = afterAttributeChanged

Dispatched when the value of a property changes on this LayoutWindow. This event bubbles. This event is not cancelable.


Read Only

String AFTER_OPEN = afterOpen

Dispatched after a LayoutWindow is opened. This event bubbles. This event is not cancelable.


Read Only

String BEFORE_CLOSE = beforeClose

Dispatched before a LayoutWindow is closed. This event bubbles. This event is cancelable.


Read Only

String AFTER_CLOSE = afterClose

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.

Instance

Read Only

String name

The name of the LayoutWindow.


Read Only

Boolean isValid

Returns true if the object specifier resolves to valid objects.


Read Only

Document parent

The parent of the LayoutWindow (a Document).


Read Only

Number index

The index of the LayoutWindow within its containing object.


Read Only

Events events

A collection of events.


Read Only

EventListeners eventListeners

A collection of event listeners.


Boolean overprintPreview

If true, display a simulation of overprinting.


String proofingProfile

The profile used for proofing colors.


ProofingType proofingType

The method of proofing colors.


Boolean simulateInkBlack

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.


Boolean simulatePaperWhite

If true, simulates the dingy white of real paper, according to the proofing profile. Note: Valid only when proofing type is custom.


Boolean preserveColorNumbers

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.


ViewDisplaySettings viewDisplaySetting

The display performance preferences override for the view.


Mixed transformReferencePoint

The default anchor point around which to transform objects. Can return: AnchorPoint enumerator or Array of 2 Units.


Layer activeLayer

The active layer. Can also accept: String.


Number zoomPercentage

The size (as a percentage) to which to enlarge or reduce the view of the document. (Range: 5 to 4000)


Mixed activeSpread

The front-most spread. Can return: Spread or MasterSpread.


Page activePage

The front-most page.


ScreenModeOptions screenMode

The screen mode for layout view.


Object selection

The selected object(s). Can also accept: Object or NothingEnum enumerator.


Number bounds

The bounds of the window (specified in pixels) in the form [top, left, bottom, right].


PageItem selectionKeyObject

The key object of the selection. Can also accept: NothingEnum enumerator.


Object properties

A property that allows setting of several properties at the same time.

Methods

zoom( ZoomOptions given )

Magnifies or reduces the window to the specified display size.

Parameters

TypeNameDescription
ZoomOptions
given
The display size.

select( Mixed selectableItems, SelectionOptions existingSelection )

Selects the specified object(s).

Parameters

TypeNameDescription
Mixed
selectableItems
The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
SelectionOptions
existingSelection
The selection status of the LayoutWindow in relation to previously selected objects. (Optional)

close()

Closes the LayoutWindow.


maximize()

Maximizes the window.


minimize()

Minimizes the window.


restore()

Restores the window.


bringToFront()

Brings the object to the front.


String toSource()

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


LayoutWindow getElements()

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


String toSpecifier()

Retrieves the object specifier.


EventListener addEventListener( String eventType, Mixed handler, Boolean captures )

Adds an event listener.

Parameters

TypeNameDescription
String
eventType
The event type.
Mixed
handler
The event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)

Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )

Removes the event listener.

Parameters

TypeNameDescription
String
eventType
The registered event type.
Mixed
handler
The registered event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)
Was this helpful?
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2023 Adobe. All rights reserved.