Package | com.adobe.indesign |
Class | public class LayoutWindow |
Inheritance | LayoutWindow ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerLayoutWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | LayoutWindow | ||
![]() | addEventListenerWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Window | |
bringToFront():void [override]
Brings the object to the front. | LayoutWindow | ||
close():void [override]
Closes the LayoutWindow. | LayoutWindow | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | ||
![]() | removeEventListenerWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Window | |
![]() | 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 | ||
![]() | 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 |
activeLayer | property |
activeLayer:Layer
Since : | CS5 |
The active layer. Can also accept: String.
public function get activeLayer():Layer
public function set activeLayer(value:Layer):void
activePage | property |
activePage:Page
Since : | CS5 |
The front-most page.
public function get activePage():Page
public function set activePage(value:Page):void
activeSpread | property |
activeSpread:Object
Since : | CS5 |
The front-most spread. Can return: Spread or MasterSpread.
public function get activeSpread():Object
public function set activeSpread(value:Object):void
AFTER_ACTIVATE | property |
AFTER_ACTIVATE:String
[read-only] Since : | CS5 |
Dispatched after the LayoutWindow becomes active. This event bubbles. This event is not cancelable.
public static function get AFTER_ACTIVATE():String
AFTER_ATTRIBUTE_CHANGED | property |
AFTER_ATTRIBUTE_CHANGED:String
[read-only] Since : | CS5 |
Dispatched when the value of a property changes on this LayoutWindow. This event bubbles. This event is not cancelable.
public static function get AFTER_ATTRIBUTE_CHANGED():String
AFTER_CLOSE | property |
AFTER_CLOSE:String
[read-only] Since : | CS5 |
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.
public static function get AFTER_CLOSE():String
AFTER_OPEN | property |
AFTER_OPEN:String
[read-only] Since : | CS5 |
Dispatched after a LayoutWindow is opened. This event bubbles. This event is not cancelable.
public static function get AFTER_OPEN():String
AFTER_SELECTION_ATTRIBUTE_CHANGED | property |
AFTER_SELECTION_ATTRIBUTE_CHANGED:String
[read-only] Since : | CS5 |
Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable.
public static function get AFTER_SELECTION_ATTRIBUTE_CHANGED():String
AFTER_SELECTION_CHANGED | property |
AFTER_SELECTION_CHANGED:String
[read-only] Since : | CS5 |
Dispatched after the active selection changes. This event bubbles. This event is not cancelable.
public static function get AFTER_SELECTION_CHANGED():String
BEFORE_CLOSE | property |
BEFORE_CLOSE:String
[read-only] Since : | CS5 |
Dispatched before a LayoutWindow is closed. This event bubbles. This event is cancelable.
public static function get BEFORE_CLOSE():String
BEFORE_DEACTIVATE | property |
BEFORE_DEACTIVATE:String
[read-only] Since : | CS5 |
Dispatched before the LayoutWindow becomes inactive. This event bubbles. This event is not cancelable.
public static function get BEFORE_DEACTIVATE():String
bounds | property |
bounds:Object
[override] Since : | CS5 |
The bounds of the window (specified in pixels) in the form [top, left, bottom, right].
public function get bounds():Object
public function set bounds(value:Object):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
index | property |
index:Number
[read-only] [override] Since : | CS5 |
The index of the LayoutWindow within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
name | property |
name:String
[read-only] [override] Since : | CS5 |
The name of the LayoutWindow.
public function get name():String
overprintPreview | property |
overprintPreview:Boolean
Since : | CS5 |
If true, display a simulation of overprinting.
public function get overprintPreview():Boolean
public function set overprintPreview(value:Boolean):void
parent | property |
parent:Document
[read-only] [override] Since : | CS5 |
The parent of the LayoutWindow (a Document).
public function get parent():Document
preserveColorNumbers | property |
preserveColorNumbers:Boolean
Since : | CS5 |
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.
public function get preserveColorNumbers():Boolean
public function set preserveColorNumbers(value:Boolean):void
proofingProfile | property |
proofingProfile:String
Since : | CS5 |
The profile used for proofing colors.
public function get proofingProfile():String
public function set proofingProfile(value:String):void
proofingType | property |
proofingType:ProofingType
Since : | CS5 |
The method of proofing colors.
public function get proofingType():ProofingType
public function set proofingType(value:ProofingType):void
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
screenMode | property |
screenMode:ScreenModeOptions
Since : | CS5 |
The screen mode for layout view.
public function get screenMode():ScreenModeOptions
public function set screenMode(value:ScreenModeOptions):void
selection | property |
selection:Object
[override] Since : | CS5 |
The selected object(s). Can also accept: Object or NothingEnum enumerator.
public function get selection():Object
public function set selection(value:Object):void
simulateInkBlack | property |
simulateInkBlack:Boolean
Since : | CS5 |
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.
public function get simulateInkBlack():Boolean
public function set simulateInkBlack(value:Boolean):void
simulatePaperWhite | property |
simulatePaperWhite:Boolean
Since : | CS5 |
If true, simulates the dingy white of real paper, according to the proofing profile. Note: Valid only when proofing type is custom.
public function get simulatePaperWhite():Boolean
public function set simulatePaperWhite(value:Boolean):void
transformReferencePoint | property |
transformReferencePoint:Object
Since : | CS5 |
The default anchor point around which to transform objects. Can return: AnchorPoint enumerator or Array of 2 Units.
public function get transformReferencePoint():Object
public function set transformReferencePoint(value:Object):void
viewDisplaySetting | property |
viewDisplaySetting:ViewDisplaySettings
Since : | CS5 |
The display performance preferences override for the view.
public function get viewDisplaySetting():ViewDisplaySettings
public function set viewDisplaySetting(value:ViewDisplaySettings):void
zoomPercentage | property |
zoomPercentage:Number
Since : | CS5 |
The size (as a percentage) to which to enlarge or reduce the view of the document. (Range: 5 to 4000)
public function get zoomPercentage():Number
public function set zoomPercentage(value:Number):void
addEventListenerLayoutWindow | () | method |
public function addEventListenerLayoutWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
bringToFront | () | method |
override public function bringToFront():void
Since : | CS5 |
Brings the object to the front.
close | () | method |
override public function close():void
Since : | CS5 |
Closes the LayoutWindow.
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
maximize | () | method |
override public function maximize():void
Since : | CS5 |
Maximizes the window.
minimize | () | method |
override public function minimize():void
Since : | CS5 |
Minimizes the window.
removeEventListenerLayoutWindow | () | method |
public function removeEventListenerLayoutWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
restore | () | method |
override public function restore():void
Since : | CS5 |
Restores the window.
select | () | method |
override public function select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void
Since : | CS5 |
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
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
zoom | () | method |
public function zoom(givenParam:ZoomOptions = null):void
Since : | CS5 |
Magnifies or reduces the window to the specified display size.
Parameters
givenParam:ZoomOptions (default = null ) — (ZoomOptions) The display size.
|