Package | com.adobe.indesign |
Class | public class Window |
Inheritance | Window ![]() ![]() |
Subclasses | LayoutWindow, StoryWindow |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
AFTER_ACTIVATE : String [static] [read-only]
Dispatched after the Window becomes active. | Window | ||
AFTER_ATTRIBUTE_CHANGED : String [static] [read-only]
Dispatched when the value of a property changes on this Window. | Window | ||
AFTER_CLOSE : String [static] [read-only]
Dispatched when a Window is closing. | Window | ||
AFTER_OPEN : String [static] [read-only]
Dispatched after a Window is opened. | Window | ||
AFTER_SELECTION_ATTRIBUTE_CHANGED : String [static] [read-only]
Dispatched after an attribute on the active selection changes. | Window | ||
AFTER_SELECTION_CHANGED : String [static] [read-only]
Dispatched after the active selection changes. | Window | ||
BEFORE_CLOSE : String [static] [read-only]
Dispatched before a Window is closed. | Window | ||
BEFORE_DEACTIVATE : String [static] [read-only]
Dispatched before the Window becomes inactive. | Window | ||
bounds : Object
The bounds of the window (specified in pixels) in the form [top, left, bottom, right]. | Window | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Window | ||
events : Events [read-only]
A collection of events. | Window | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
index : Number [read-only]
The index of the Window within its containing object. | Window | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Window | ||
name : String [read-only]
The name of the Window. | Window | ||
parent : Document [read-only]
The parent of the Window (a Document). | Window | ||
properties : Object
A property that allows setting of several properties at the same time. | Window | ||
selection : Object
The selected object(s). | Window |
Method | Defined By | ||
---|---|---|---|
addEventListenerWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Window | ||
bringToFront():void
Brings the object to the front. | Window | ||
close():void
Closes the Window. | Window | ||
![]() | 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
Resolves the object specifier, creating an array of object references. | Window | ||
![]() | 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
Maximizes the window. | Window | ||
minimize():void
Minimizes the window. | Window | ||
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
Restores the window. | Window | ||
select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void
Selects the specified object(s). | Window | ||
toSpecifier():String
Retrieves the object specifier. | Window | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
AFTER_ACTIVATE | property |
AFTER_ACTIVATE:String
[read-only] Since : | CS5 |
Dispatched after the Window 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 Window. 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 Window 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 Window 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 Window 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 Window becomes inactive. This event bubbles. This event is not cancelable.
public static function get BEFORE_DEACTIVATE():String
bounds | property |
bounds:Object
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] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Window within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
name | property |
name:String
[read-only] Since : | CS5 |
The name of the Window.
public function get name():String
parent | property |
parent:Document
[read-only] Since : | CS5 |
The parent of the Window (a Document).
public function get parent():Document
properties | property |
properties:Object
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
selection | property |
selection:Object
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
addEventListenerWindow | () | method |
public function addEventListenerWindow(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 |
public function bringToFront():void
Since : | CS5 |
Brings the object to the front.
close | () | method |
public function close():void
Since : | CS5 |
Closes the Window.
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
maximize | () | method |
public function maximize():void
Since : | CS5 |
Maximizes the window.
minimize | () | method |
public function minimize():void
Since : | CS5 |
Minimizes the window.
removeEventListenerWindow | () | method |
public function removeEventListenerWindow(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 |
public function restore():void
Since : | CS5 |
Restores the window.
select | () | method |
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 Window in relation to previously selected objects. (Optional)
|
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |