StoryWindow

A story window.

Methods:

addEventListener, bringToFront, close, getElements, maximize, minimize, removeEventListener, restore, select, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, NothingEnum, Number, Object, PageItem, String

Hierarchy:

Superclass: Window

Class: StoryWindow

Property Listing

Property

Type

Access

Description

bounds

Array of Number

read/write

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

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

index

Number

readonly

The index of the StoryWindow within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

name

String

readonly

The name of the StoryWindow.

parent

Document

readonly

The parent of the StoryWindow (a Document).

properties

Object

read/write

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

selection

Array of Object

NothingEnum.NOTHING

read/write

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

selectionKeyObject

PageItem

NothingEnum.NOTHING

read/write

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

Constants/Events

Name

Type

Access

Description

AFTER_ACTIVATE

String

readonly

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

AFTER_ATTRIBUTE_CHANGED

String

readonly

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

AFTER_CLOSE

String

readonly

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.

AFTER_OPEN

String

readonly

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

AFTER_SELECTION_ATTRIBUTE_CHANGED

String

readonly

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

AFTER_SELECTION_CHANGED

String

readonly

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

BEFORE_CLOSE

String

readonly

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

BEFORE_DEACTIVATE

String

readonly

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

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined bringToFront ()

Brings the object to the front.

undefined close ()

Closes the StoryWindow.

StoryWindow getElements ()

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

undefined maximize ()

Maximizes the window.

undefined minimize ()

Minimizes the window.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined restore ()

Restores the window.

undefined select (selectableItems:Array of Varies Objects NothingEnum Object SelectAll, [existingSelection:SelectionOptions=SelectionOptions])

Selects the specified object(s).

Parameter

Type

Description

selectableItems

Array of Objects

NothingEnum.NOTHING

Object

SelectAll

SelectAll.ALL

The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

SelectionOptions.SET_KEY

The selection status of the StoryWindow in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.activeWindow

Event.parent

EventListener.parent

MutationEvent.parent

Return

Story.storyEdit()

StoryWindow.getElements()

StoryWindows.anyItem()

StoryWindows.everyItem()

StoryWindows.nextItem()

StoryWindows.previousItem()

StoryWindows.item()

StoryWindows.[]()

StoryWindows.itemByName()

StoryWindows.itemByRange()

StoryWindows.firstItem()

StoryWindows.lastItem()

StoryWindows.middleItem()