TypefiElementDefinition

Methods:

addEventListener, apply, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, ParagraphStyle, String, TypefiElementType, TypefiElementVariantDefinitions,

Property Listing

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
externalParagraphStyle	ParagraphStyle String	read/write	External paragraph style. Can return: ParagraphStyle or String.
id	Number	readonly	The unique ID of the TypefiElementDefinition.
index	Number	readonly	The index of the TypefiElementDefinition within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
keepOrder	Boolean	read/write	Keep order
label	String	read/write	A property that can be set to any string.
name	String	read/write	The name of the TypefiElementDefinition.
parent	Document	readonly	The parent of the TypefiElementDefinition (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
type	TypefiElementType TypefiElementType.ANCHOR TypefiElementType.FIXED_ELEMENT TypefiElementType.FLOATING_ELEMENT TypefiElementType.INLINE_ELEMENT TypefiElementType.NONE	read/write	The element type
typefiElementVariantDefinitions	TypefiElementVariantDefinitions TypefiElementVariantDefinition	readonly	A list of Typefi element variant definitions
writerParagraphStyle	ParagraphStyle String	read/write	Writer paragraph style. Can return: ParagraphStyle or String.

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)

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)

TypefiElementVariantDefinition apply (pageItem:PageItem)

Applies element to page item

Parameter	Type	Description
pageItem	PageItem	The page item that needs to be assigned the element type

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

TypefiElementDefinition getElements ()

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

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

undefined remove ()

Deletes the TypefiElementDefinition.

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)