Packagecom.adobe.indesign
Classpublic class StoryWindow
InheritanceStoryWindow Inheritance Window Inheritance CSHostObject Inheritance flash.utils.Proxy

Window



Public Properties
 PropertyDefined By
  AFTER_ACTIVATE : String
[static] [read-only] Dispatched after the StoryWindow becomes active.
StoryWindow
  AFTER_ATTRIBUTE_CHANGED : String
[static] [read-only] Dispatched when the value of a property changes on this StoryWindow.
StoryWindow
  AFTER_CLOSE : String
[static] [read-only] Dispatched when a StoryWindow is closing.
StoryWindow
  AFTER_OPEN : String
[static] [read-only] Dispatched after a StoryWindow is opened.
StoryWindow
  AFTER_SELECTION_ATTRIBUTE_CHANGED : String
[static] [read-only] Dispatched after an attribute on the active selection changes.
StoryWindow
  AFTER_SELECTION_CHANGED : String
[static] [read-only] Dispatched after the active selection changes.
StoryWindow
  BEFORE_CLOSE : String
[static] [read-only] Dispatched before a StoryWindow is closed.
StoryWindow
  BEFORE_DEACTIVATE : String
[static] [read-only] Dispatched before the StoryWindow becomes inactive.
StoryWindow
  bounds : Object
[override] The bounds of the window (specified in pixels) in the form [top, left, bottom, right].
StoryWindow
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
StoryWindow
  events : Events
[override] [read-only] A collection of events.
StoryWindow
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[override] [read-only] The index of the StoryWindow within its containing object.
StoryWindow
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
StoryWindow
  name : String
[override] [read-only] The name of the StoryWindow.
StoryWindow
  parent : Document
[override] [read-only] The parent of the StoryWindow (a Document).
StoryWindow
  properties : Object
[override] A property that allows setting of several properties at the same time.
StoryWindow
  selection : Object
[override] The selected object(s).
StoryWindow
Public Methods
 MethodDefined By
  
addEventListenerStoryWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
StoryWindow
 Inherited
addEventListenerWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Window
  
[override] Brings the object to the front.
StoryWindow
  
close():void
[override] Closes the StoryWindow.
StoryWindow
 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.
StoryWindow
 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.
StoryWindow
  
minimize():void
[override] Minimizes the window.
StoryWindow
  
removeEventListenerStoryWindow(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
StoryWindow
 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.
StoryWindow
  
select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void
[override] Selects the specified object(s).
StoryWindow
  
toSpecifier():String
[override] Retrieves the object specifier.
StoryWindow
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
AFTER_ACTIVATEproperty
AFTER_ACTIVATE:String  [read-only]

Dispatched after the StoryWindow 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 StoryWindow. 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 StoryWindow 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 StoryWindow 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 StoryWindow 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 StoryWindow 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 StoryWindow 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 StoryWindow.


Implementation
    public function get name():String
parentproperty 
parent:Document  [read-only] [override]

The parent of the StoryWindow (a Document).


Implementation
    public function get parent():Document
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
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
Method Detail
addEventListenerStoryWindow()method
public function addEventListenerStoryWindow(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 StoryWindow.

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.

removeEventListenerStoryWindow()method 
public function removeEventListenerStoryWindow(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 StoryWindow in relation to previously selected objects. (Optional)

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

Retrieves the object specifier.

Returns
String