StoryWindow

A story window.

Methods:

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

Objects:

Boolean, NothingEnum, Number, Object, 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].

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.

Method Listing

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.

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

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

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()