Adobe InDesign CS6 (8.0) Object Model JS: State

InDesign CS6

previous page next page

Class

State

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

QuickLinks

addEventListener, addItemsToState, getElements, move, releaseAsObject, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Button | CheckBox | MultiStateObject | RadioButton

State

Properties

Property	Type	Access	Description
active	bool	r/w	If true, the state is active in the exported PDF.
enabled	bool	r/w	If true, the state is enabled in PDF documents.
epss	EPSs	readonly	A collection of EPS files.
epstexts	EPSTexts	readonly	EPSTexts
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
graphicLines	GraphicLines	readonly	A collection of graphic lines.
graphics	Graphics	readonly	A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
groups	Groups	readonly	A collection of groups.
id	number	readonly	The unique ID of the State.
images	Images	readonly	A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
index	number	readonly	The index of the State within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
name	string	r/w	The name of the State.
ovals	Ovals	readonly	A collection of ellipses.
pageItems	PageItems	readonly	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.
parent	Button CheckBox MultiStateObject RadioButton	readonly	The parent of the State (a Button, MultiStateObject, CheckBox or RadioButton).
pdfs	PDFs	readonly	A collection of PDF files.
picts	PICTs	readonly	A collection of PICT graphics.
polygons	Polygons	readonly	A collection of polygons.
properties	Object	r/w	A property that allows setting of several properties at the same time.
rectangles	Rectangles	readonly	A collection of rectangles.
splineItems	SplineItems	readonly	The spline items collection.
statetype	Long Integer StateTypes	r/w	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.
textFrames	TextFrames	readonly	A collection of text frames.
wmfs	WMFs	readonly	A collection of WMF graphics.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void addItemsToState (pageitems: Array of PageItem)
Adds page items to this state.

Parameter	Type	Description
pageitems	Array of PageItem	One or more page items to add to this state.

Array of State getElements ()
Resolves the object specifier, creating an array of object references.

void move (newPosition: number)
Moves the state to a new position in its parent collection.

Parameter	Type	Description
newPosition	number	the index to move the state to in its parent collection

void releaseAsObject ()
Releases this state's appearance as a page item, removing the state from its parent object.

void remove ()
Deletes the State.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)