K4 InDesign Javascript API Documentation

BasicsStoryWindow

A story window.

Extends

Static Properties

Name Description
AFTER_ACTIVATE = "afterActivate" string Dispatched after the StoryWindow becomes active. This event bubbles. This event is not cancelable.
AFTER_ATTRIBUTE_CHANGED = "afterAttributeChanged" string Dispatched when the value of a property changes on this StoryWindow. This event bubbles. This event is not cancelable.
AFTER_CLOSE = "afterClose" string 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 = "afterOpen" string Dispatched after a StoryWindow is opened. This event bubbles. This event is not cancelable.
AFTER_SELECTION_ATTRIBUTE_CHANGED = "afterSelectionAttributeChanged" string Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable.
AFTER_SELECTION_CHANGED = "afterSelectionChanged" string Dispatched after the active selection changes. This event bubbles. This event is not cancelable.
BEFORE_CLOSE = "beforeClose" string Dispatched before a StoryWindow is closed. This event bubbles. This event is cancelable.
BEFORE_DEACTIVATE = "beforeDeactivate" string Dispatched before the StoryWindow becomes inactive. This event bubbles. This event is not cancelable.

Instance Properties

Name Description Access
bounds number The bounds of the window (specified in pixels) in the form [top, left, bottom, right]. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the StoryWindow within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
name string The name of the StoryWindow. read-only
parent Document The parent of the StoryWindow (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
selection Object The selected object(s). Can also accept: Object or NothingEnum enumerator. read-write
selectionKeyObject PageItem The key object of the selection. Can also accept: NothingEnum enumerator. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
bringToFront(
)
close(
)
getElements(
)
  → StoryWindow
maximize(
)
minimize(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
restore(
)
select(
selectableItems ​[, existingSelection])
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
bringToFront(
)
Brings the object to the front.
close(
)
Closes the StoryWindow.
getElements(
)
  → StoryWindow
Resolves the object specifier, creating an array of object references.
maximize(
)
Maximizes the window.
minimize(
)
Minimizes the window.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
restore(
)
Restores the window.
select(
selectableItems ​[, existingSelection=SelectionOptions.REPLACE_WITH])
Selects the specified object(s).
selectableItems The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelection SelectionOptions The selection status of the StoryWindow in relation to previously selected objects. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the StoryWindow.
toSpecifier(
)
  → string
Retrieves the object specifier.