Packagecom.adobe.indesign
Classpublic class LayoutWindow
InheritanceLayoutWindow Inheritance Window Inheritance CSHostObject Inheritance flash.utils.Proxy

Window



Public Properties
 PropertyDefined By
  activeLayer : Layer
The active layer.
LayoutWindow
  activePage : Page
The front-most page.
LayoutWindow
  activeSpread : Object
The front-most spread.
LayoutWindow
  AFTER_ACTIVATE : String
[static] [read-only] Dispatched after the LayoutWindow becomes active.
LayoutWindow
  AFTER_ATTRIBUTE_CHANGED : String
[static] [read-only] Dispatched when the value of a property changes on this LayoutWindow.
LayoutWindow
  AFTER_CLOSE : String
[static] [read-only] Dispatched when a LayoutWindow is closing.
LayoutWindow
  AFTER_OPEN : String
[static] [read-only] Dispatched after a LayoutWindow is opened.
LayoutWindow
  AFTER_SELECTION_ATTRIBUTE_CHANGED : String
[static] [read-only] Dispatched after an attribute on the active selection changes.
LayoutWindow
  AFTER_SELECTION_CHANGED : String
[static] [read-only] Dispatched after the active selection changes.
LayoutWindow
  BEFORE_CLOSE : String
[static] [read-only] Dispatched before a LayoutWindow is closed.
LayoutWindow
  BEFORE_DEACTIVATE : String
[static] [read-only] Dispatched before the LayoutWindow becomes inactive.
LayoutWindow
  bounds : Object
[override] The bounds of the window (specified in pixels) in the form [top, left, bottom, right].
LayoutWindow
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
LayoutWindow
  events : Events
[override] [read-only] A collection of events.
LayoutWindow
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[override] [read-only] The index of the LayoutWindow within its containing object.
LayoutWindow
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
LayoutWindow
  name : String
[override] [read-only] The name of the LayoutWindow.
LayoutWindow
  overprintPreview : Boolean
If true, display a simulation of overprinting.
LayoutWindow
  parent : Document
[override] [read-only] The parent of the LayoutWindow (a Document).
LayoutWindow
  preserveColorNumbers : Boolean
If true, leaves color values unchanged for CMYK objects without embedded profiles and native objects such as line art or type.
LayoutWindow
  proofingProfile : String
The profile used for proofing colors.
LayoutWindow
  proofingType : ProofingType
The method of proofing colors.
LayoutWindow
  properties : Object
[override] A property that allows setting of several properties at the same time.
LayoutWindow
  screenMode : ScreenModeOptions
The screen mode for layout view.
LayoutWindow
  selection : Object
[override] The selected object(s).
LayoutWindow
  simulateInkBlack : Boolean
If true, simulates the dark gray produced by many printers in place of solid black, according to the proofing profile.
LayoutWindow
  simulatePaperWhite : Boolean
If true, simulates the dingy white of real paper, according to the proofing profile.
LayoutWindow
  transformReferencePoint : Object
The default anchor point around which to transform objects.
LayoutWindow
  viewDisplaySetting : ViewDisplaySettings
The display performance preferences override for the view.
LayoutWindow
  zoomPercentage : Number
The size (as a percentage) to which to enlarge or reduce the view of the document.
LayoutWindow
Public Methods
 MethodDefined By
  
addEventListenerLayoutWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
LayoutWindow
 Inherited
addEventListenerWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Window
  
[override] Brings the object to the front.
LayoutWindow
  
close():void
[override] Closes the LayoutWindow.
LayoutWindow
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
LayoutWindow
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
maximize():void
[override] Maximizes the window.
LayoutWindow
  
minimize():void
[override] Minimizes the window.
LayoutWindow
  
removeEventListenerLayoutWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
LayoutWindow
 Inherited
removeEventListenerWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Window
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
restore():void
[override] Restores the window.
LayoutWindow
  
select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void
[override] Selects the specified object(s).
LayoutWindow
  
toSpecifier():String
[override] Retrieves the object specifier.
LayoutWindow
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
  
zoom(givenParam:ZoomOptions = null):void
Magnifies or reduces the window to the specified display size.
LayoutWindow
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
activeLayerproperty
activeLayer:Layer

The active layer. Can also accept: String.


Implementation
    public function get activeLayer():Layer
    public function set activeLayer(value:Layer):void
activePageproperty 
activePage:Page

The front-most page.


Implementation
    public function get activePage():Page
    public function set activePage(value:Page):void
activeSpreadproperty 
activeSpread:Object

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


Implementation
    public function get activeSpread():Object
    public function set activeSpread(value:Object):void
AFTER_ACTIVATEproperty 
AFTER_ACTIVATE:String  [read-only]

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


Implementation
    public static function get AFTER_ACTIVATE():String
AFTER_ATTRIBUTE_CHANGEDproperty 
AFTER_ATTRIBUTE_CHANGED:String  [read-only]

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


Implementation
    public static function get AFTER_ATTRIBUTE_CHANGED():String
AFTER_CLOSEproperty 
AFTER_CLOSE:String  [read-only]

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.


Implementation
    public static function get AFTER_CLOSE():String
AFTER_OPENproperty 
AFTER_OPEN:String  [read-only]

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


Implementation
    public static function get AFTER_OPEN():String
AFTER_SELECTION_ATTRIBUTE_CHANGEDproperty 
AFTER_SELECTION_ATTRIBUTE_CHANGED:String  [read-only]

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


Implementation
    public static function get AFTER_SELECTION_ATTRIBUTE_CHANGED():String
AFTER_SELECTION_CHANGEDproperty 
AFTER_SELECTION_CHANGED:String  [read-only]

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


Implementation
    public static function get AFTER_SELECTION_CHANGED():String
BEFORE_CLOSEproperty 
BEFORE_CLOSE:String  [read-only]

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


Implementation
    public static function get BEFORE_CLOSE():String
BEFORE_DEACTIVATEproperty 
BEFORE_DEACTIVATE:String  [read-only]

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


Implementation
    public static function get BEFORE_DEACTIVATE():String
boundsproperty 
bounds:Object[override]

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


Implementation
    public function get bounds():Object
    public function set bounds(value:Object):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
indexproperty 
index:Number  [read-only] [override]

The index of the LayoutWindow within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
nameproperty 
name:String  [read-only] [override]

The name of the LayoutWindow.


Implementation
    public function get name():String
overprintPreviewproperty 
overprintPreview:Boolean

If true, display a simulation of overprinting.


Implementation
    public function get overprintPreview():Boolean
    public function set overprintPreview(value:Boolean):void
parentproperty 
parent:Document  [read-only] [override]

The parent of the LayoutWindow (a Document).


Implementation
    public function get parent():Document
preserveColorNumbersproperty 
preserveColorNumbers:Boolean

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.


Implementation
    public function get preserveColorNumbers():Boolean
    public function set preserveColorNumbers(value:Boolean):void
proofingProfileproperty 
proofingProfile:String

The profile used for proofing colors.


Implementation
    public function get proofingProfile():String
    public function set proofingProfile(value:String):void
proofingTypeproperty 
proofingType:ProofingType

The method of proofing colors.


Implementation
    public function get proofingType():ProofingType
    public function set proofingType(value:ProofingType):void
propertiesproperty 
properties:Object[override]

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


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
screenModeproperty 
screenMode:ScreenModeOptions

The screen mode for layout view.


Implementation
    public function get screenMode():ScreenModeOptions
    public function set screenMode(value:ScreenModeOptions):void
selectionproperty 
selection:Object[override]

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


Implementation
    public function get selection():Object
    public function set selection(value:Object):void
simulateInkBlackproperty 
simulateInkBlack:Boolean

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.


Implementation
    public function get simulateInkBlack():Boolean
    public function set simulateInkBlack(value:Boolean):void
simulatePaperWhiteproperty 
simulatePaperWhite:Boolean

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


Implementation
    public function get simulatePaperWhite():Boolean
    public function set simulatePaperWhite(value:Boolean):void
transformReferencePointproperty 
transformReferencePoint:Object

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


Implementation
    public function get transformReferencePoint():Object
    public function set transformReferencePoint(value:Object):void
viewDisplaySettingproperty 
viewDisplaySetting:ViewDisplaySettings

The display performance preferences override for the view.


Implementation
    public function get viewDisplaySetting():ViewDisplaySettings
    public function set viewDisplaySetting(value:ViewDisplaySettings):void
zoomPercentageproperty 
zoomPercentage:Number

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


Implementation
    public function get zoomPercentage():Number
    public function set zoomPercentage(value:Number):void
Method Detail
addEventListenerLayoutWindow()method
public function addEventListenerLayoutWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
bringToFront()method 
override public function bringToFront():void

Brings the object to the front.

close()method 
override public function close():void

Closes the LayoutWindow.

getElements()method 
override public function getElements():Object

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

Returns
Object
maximize()method 
override public function maximize():void

Maximizes the window.

minimize()method 
override public function minimize():void

Minimizes the window.

removeEventListenerLayoutWindow()method 
public function removeEventListenerLayoutWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
restore()method 
override public function restore():void

Restores the window.

select()method 
override public function select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void

Selects the specified object(s).

Parameters

selectableItemsParam:Object (default = null) — (Object) The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
 
existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the LayoutWindow in relation to previously selected objects. (Optional)

toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String
zoom()method 
public function zoom(givenParam:ZoomOptions = null):void

Magnifies or reduces the window to the specified display size.

Parameters

givenParam:ZoomOptions (default = null) — (ZoomOptions) The display size.