TypefiElementPageItem

Methods:

addEventListener, createAnchor, createAssociation, getElements, getFieldValue, removeAssociation, removeEventListener, resetAllToDefaults, setField, toSource, toSpecifier

Objects:

AnchorPoint, Boolean, EventListeners, Events, Number, Object, String, TypefiElementAnchor, TypefiElementDefinition, TypefiElementInstance, TypefiElementType, TypefiElementVariantDefinition,

Hierarchy:

Superclass: Preference

Class: TypefiElementPageItem

Property Listing

Property	Type	Access	Description
anchor	TypefiElementAnchor	readonly	Element anchor
anchorPoint	AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR	read/write	The anchor point to use in the element for the display of the line to the element anchor
definition	TypefiElementDefinition	read/write	Element definition object
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
externalId	String	readonly	An optional external id string
instance	TypefiElementInstance	read/write	A reference to a Typefi element instance
isMaster	Boolean	read/write	Is master
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
name	String	readonly	The element name
parent	TypefiPageItemSettings	readonly	The parent of the TypefiElementPageItem (a TypefiPageItemSettings).
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	readonly	The element type
variantDefinition	TypefiElementVariantDefinition	read/write	Element variant definition object
variantId	Number	readonly	Variant id
variantName	String	readonly	Variant name

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)

TypefiElementAnchor createAnchor (storyOffset:InsertionPoint)

Create a Typefi element anchor at the given position

Parameter	Type	Description
storyOffset	InsertionPoint	The location within the story, specified as an insertion point

undefined createAssociation (elementAnchor:Varies TypefiElementAnchor PageItem, [anchorPoint:AnchorPoint=AnchorPoint])

Create an association between this Typefi element page item and a Typefi element anchor

Parameter	Type	Description
elementAnchor	TypefiElementAnchor PageItem	The Typefi element anchor object. Can accept: TypefiElementAnchor or PageItem.
anchorPoint	AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR	The optional anchor point to use in the element for the display of the line to the element anchor (Optional) (default: AnchorPoint.CENTER_ANCHOR)

Parameter

Type

Description

elementAnchor

TypefiElementAnchor

PageItem

The Typefi element anchor object. Can accept: TypefiElementAnchor or PageItem.

anchorPoint

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The optional anchor point to use in the element for the display of the line to the element anchor (Optional)

(default: AnchorPoint.CENTER_ANCHOR)

TypefiElementPageItem getElements ()

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

String getFieldValue (name:String)

Get the value of a field of TypefiElementPageItem

Parameter	Type	Description
name	String	The name of the field

undefined removeAssociation (elementAnchor:Varies TypefiElementAnchor PageItem)

Remove the association between this Typefi element page item and a Typefi element anchor

Parameter	Type	Description
elementAnchor	TypefiElementAnchor PageItem	The Typefi element anchor object. Can accept: TypefiElementAnchor or PageItem. (Optional)

Parameter

Type

Description

elementAnchor

TypefiElementAnchor

PageItem

The Typefi element anchor object. Can accept: TypefiElementAnchor or PageItem. (Optional)

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)

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)

undefined resetAllToDefaults ()

Reset the Typefi specific data of TypefiElementPageItem to the default values

undefined setField (name:String, [value:Varies String LongInteger=Varies String LongInteger])

Set the value of a field of TypefiElementPageItem

Parameter

Type

Description

name

String

The name of the field

value

String

LongInteger

The value of the field as string or as integer. The empty string will recompute the value of a counter field! If not specified, the field value will be reset. Can accept: String or Long Integer. (Optional)

(default: )

String toSource ()

Generates a string which, if executed, will return the TypefiElementPageItem.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

TypefiPageItemSettings.element

Return

TypefiElementPageItem.getElements()