K4 InDesign Javascript API Documentation

Interactive ElementsState

A state (states define the display of the field in an exported PDF or SWF).

Instance Properties

Name Description Access
active bool If true, the state is active in the exported PDF. read-write
enabled bool If true, the state is enabled in PDF documents. read-write
endnoteTextFrames EndnoteTextFrames A collection of endnote text frames. read-only
epss EPSs A collection of EPS files. read-only
epstexts EPSTexts EPSTexts read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
graphicLines GraphicLines A collection of graphic lines. read-only
graphics Graphics A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). read-only
groups Groups A collection of groups. read-only
id number The unique ID of the State. read-only
images Images A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). read-only
index number The index of the State 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 State. read-write
ovals Ovals A collection of ellipses. read-only
pageItems PageItems The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. read-only
parent The parent of the State (a Button, MultiStateObject, CheckBox or RadioButton). read-only
pdfs PDFs A collection of PDF files. read-only
picts PICTs A collection of PICT graphics. read-only
polygons Polygons A collection of polygons. read-only
properties Object A property that allows setting of several properties at the same time. read-write
rectangles Rectangles A collection of rectangles. read-only
splineItems SplineItems The spline items collection. read-only
statetype For a button, the type of user action that dictates the object's appearance. For a MultiStateObject, which has no user actions associated with states, this property is a numeric value uniquely identifying the state. Can return: StateTypes enumerator or Long Integer. read-write
textFrames TextFrames A collection of text frames. read-only
wmfs WMFs A collection of WMF graphics. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
addItemsToState(
pageitems)
getElements(
)
  → State
move(
newPosition)
releaseAsObject(
)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
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)
addItemsToState(
pageitems)
Adds page items to this state.
pageitems Array<PageItem> One or more page items to add to this state.
getElements(
)
  → State
Resolves the object specifier, creating an array of object references.
move(
newPosition)
Moves the state to a new position in its parent collection.
newPosition number the index to move the state to in its parent collection
releaseAsObject(
)
Releases this state's appearance as a page item, removing the state from its parent object.
remove(
)
Deletes the State.
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)
toSource(
)
  → string
Generates a string which, if executed, will return the State.
toSpecifier(
)
  → string
Retrieves the object specifier.