TypefiPageItemSettings

Typefi settings on the page item level

Go to Property Listing | Method Listing

Hierarchy:

Class: TypefiPageItemSettings

Property Listing

Property	Type	Access	Description
anchor	TypefiElementAnchor	readonly	Element anchor
anchorType	TypefiAnchorType TypefiAnchorType.ELEMENT TypefiAnchorType.NONE	readonly	Anchor type
element	TypefiElementPageItem	readonly	Typefi element
elementType	TypefiElementType TypefiElementType.ANCHOR TypefiElementType.FIXED_ELEMENT TypefiElementType.FLOATING_ELEMENT TypefiElementType.INLINE_ELEMENT TypefiElementType.NONE	readonly	Element type
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
frame	TypefiFrameItem	readonly	Typdefi frame
frameType	TypefiFrameType TypefiFrameType.AUDIO TypefiFrameType.CONTENT TypefiFrameType.ENDNOTE TypefiFrameType.FOOTNOTE TypefiFrameType.IMAGE TypefiFrameType.INDEX TypefiFrameType.MAIN_STORY TypefiFrameType.NONE TypefiFrameType.TOC TypefiFrameType.VIDEO	readonly	The Typefi frame type
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
parent	Button CheckBox ComboBox EPS EPSText EndnoteTextFrame FormField Graphic GraphicLine Group HtmlItem Image ImportedPage ListBox MediaItem Movie MultiStateObject Oval PDF PICT Polygon RadioButton Rectangle SignatureField Sound SplineItem TextBox TextFrame WMF PageItem TextPath	readonly	The parent of the TypefiPageItemSettings (a PageItem, HtmlItem, FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, EndnoteTextFrame or TextPath).
preferences	Preferences Preference	readonly	A collection of preferences objects.
properties	Object	read/write	A property that allows setting of several properties at the same time.

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)

undefined applyAudioFrameData ()

Apply the associated Typefi audio frame data on the page item

undefined applyImageFrameData ()

Apply the associated Typefi image frame data on the page item

undefined applyPoster ()

Apply poster to the associated audio or video on the page item

undefined applyVideoFrameData ()

Apply the associated Typefi video frame data on the page item

undefined clearElement ()

Reset the Typefi element information, i.e. the page item is no longer a Typefi Element

undefined clearFrame ()

Reset the Tyefi frame type information to 'none'

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 (object:Varies TypefiElementAnchor TypefiElementPageItem PageItem, [anchorPoint:AnchorPoint=AnchorPoint])

Create an association between this Typefi page item and another Typefi page item

Parameter	Type	Description
object	TypefiElementAnchor TypefiElementPageItem PageItem	The Typefi object. Can accept: TypefiElementAnchor, TypefiElementPageItem 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

object

TypefiElementAnchor

TypefiElementPageItem

PageItem

The Typefi object. Can accept: TypefiElementAnchor, TypefiElementPageItem 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)

TypefiPageItemSettings getElements ()

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

String getFieldValue (name:String)

Get the value of a field of TypefiPageItemSettings

Parameter	Type	Description
name	String	The name of the field

PageItem getNextFreeImageFrame (storyOffset:InsertionPoint)

Get the next free Typefi Image Frame object searching from the the given position

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

Boolean isAnchor ()

Test whether the object is a Typefi Element Anchor

Boolean isElement ()

Test whether the object is a Typefi Element page item

Boolean isFrame ()

Test whether the object is a Typefi Frame page item

Boolean isMaster ()

Test whether the object is a Typefi Master Element page item

undefined makeAudioFrame (mediaFittingOption:TypefiMediaFitOptions, playOnPageTurn:Boolean, stopOnPageTurn:Boolean, loop:Boolean, posterType:TypefiPosterTypes)

Make the page item a Typefi element audio frame

Parameter	Type	Description
mediaFittingOption	TypefiMediaFitOptions TypefiMediaFitOptions.CENTER_CONTENT TypefiMediaFitOptions.CONTENT_TO_FRAME TypefiMediaFitOptions.FILL_PROPORTIONALLY TypefiMediaFitOptions.FRAME_TO_CONTENT TypefiMediaFitOptions.NONE TypefiMediaFitOptions.PROPORTIONALLY	Media fitting option. Default is 'None' (Optional)
playOnPageTurn	Boolean	Enable play on page turn for Typefi audio. Default is 'false' (Optional)
stopOnPageTurn	Boolean	Enable stop on page turn for Typefi audio. Default is 'false' (Optional)
loop	Boolean	Enable looping for Typefi audio. Default is 'false' (Optional)
posterType	TypefiPosterTypes TypefiPosterTypes.FROM_MOVIE TypefiPosterTypes.NONE TypefiPosterTypes.PROXY_IMAGE TypefiPosterTypes.STANDARD	Typefi poster type. Default is 'None' (Optional)

undefined makeContentFrame (style:ParagraphStyle)

Make the page item a Typefi element content frame

Parameter	Type	Description
style	ParagraphStyle	The optional first paragraph style (Optional)

undefined makeElement (type:Varies String TypefiElementDefinition TypefiElementVariantDefinition TypefiElementInstance, elementInstance:Varies String TypefiElementInstance)

Make the page item a Typefi element

Parameter	Type	Description
type	String TypefiElementDefinition TypefiElementVariantDefinition TypefiElementInstance	An element definition reference, an element variant object, or an element instance object. Can accept: String, TypefiElementDefinition, TypefiElementVariantDefinition or TypefiElementInstance.
elementInstance	String TypefiElementInstance	Optionally specify an element instance. Can accept: String or TypefiElementInstance. (Optional)

Parameter

Type

Description

type

String

TypefiElementDefinition

TypefiElementVariantDefinition

TypefiElementInstance

An element definition reference, an element variant object, or an element instance object. Can accept: String, TypefiElementDefinition, TypefiElementVariantDefinition or TypefiElementInstance.

elementInstance

String

TypefiElementInstance

Optionally specify an element instance. Can accept: String or TypefiElementInstance. (Optional)

undefined makeEndnoteFrame ()

Make the page item a Typefi Endnote frame

undefined makeImageFrame (fittingOption:TypefiFitOptions, anchorPoint:AnchorPoint, spineRelative:Boolean, [expansionLimit:Varies Real(>=0) TypefiLimitType=Varies Real(>=0) TypefiLimitType], [reductionLimit:Varies Real(>=0) TypefiLimitType=Varies Real(>=0) TypefiLimitType])

Make the page item a Typefi (element) image frame

Parameter	Type	Description
fittingOption	TypefiFitOptions TypefiFitOptions.CONTENT_THEN_FRAME_PROPORTIONALLY TypefiFitOptions.CONTENT_TO_FRAME TypefiFitOptions.FILL_PROPORTIONALLY TypefiFitOptions.FRAME_TO_CONTENT TypefiFitOptions.NONE TypefiFitOptions.PROPORTIONALLY	Fitting option
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 anchor point to expand an image from
spineRelative	Boolean	Treat the anchor point spine relative. Default is 'false' (Optional)
expansionLimit	Real(>=0) TypefiLimitType TypefiLimitType.NO_LIMIT	Optional expansion limit. Default is NO_LIMIT. Can accept: Real (>= 0) or TypefiLimitType enumerator. (Optional) (default: TypefiLimitType.NO_LIMIT)
reductionLimit	Real(>=0) TypefiLimitType TypefiLimitType.NO_LIMIT	Optional reduction limit. Default is NO_LIMIT. Can accept: Real (>= 0) or TypefiLimitType enumerator. (Optional) (default: TypefiLimitType.NO_LIMIT)

undefined makeIndexFrame ()

Make the page item a Typefi index frame

undefined makeMainStoryFrame (style:ParagraphStyle)

Make the page item a Typefi main story frame

Parameter	Type	Description
style	ParagraphStyle	The optional first paragraph style (Optional)

undefined makeTOCFrame (style:TOCStyle)

Make the page item a Typefi TOC frame

Parameter	Type	Description
style	TOCStyle	The TOC style. If not provided, the InDesign default TOC style will be used (Optional)

undefined makeVideoFrame (mediaFittingOption:TypefiMediaFitOptions, playOnPageTurn:Boolean, loop:Boolean, posterType:TypefiPosterTypes, controllerSkin:Boolean, showController:Boolean)

Make the page item a Typefi element video frame

Parameter	Type	Description
mediaFittingOption	TypefiMediaFitOptions TypefiMediaFitOptions.CENTER_CONTENT TypefiMediaFitOptions.CONTENT_TO_FRAME TypefiMediaFitOptions.FILL_PROPORTIONALLY TypefiMediaFitOptions.FRAME_TO_CONTENT TypefiMediaFitOptions.NONE TypefiMediaFitOptions.PROPORTIONALLY	Media fitting option (Optional)
playOnPageTurn	Boolean	Enable play on page turn for Typefi video. Default is 'false' (Optional)
loop	Boolean	Enable looping for Typefi video. Default is 'false' (Optional)
posterType	TypefiPosterTypes TypefiPosterTypes.FROM_MOVIE TypefiPosterTypes.NONE TypefiPosterTypes.PROXY_IMAGE TypefiPosterTypes.STANDARD	Typefi poster type. Default is 'None' (Optional)
controllerSkin	Boolean	Enable controller skin for Typefi video. Default is 'false' and it sets controller skin as 'None'. If 'true', it setscontroller skin as 'SkinOverAll' (Optional)
showController	Boolean	Show controller on rollover for Typefi video. Default is 'false'. Only valid when 'controllerSkin' is true. (Optional)

undefined removeAssociation (object:Varies PageItem TypefiElementAnchor TypefiElementPageItem)

Remove the association between this Typefi page item object and another Typefi page item

Parameter	Type	Description
object	PageItem TypefiElementAnchor TypefiElementPageItem	A page item, a Typefi anchor page item or a Typefi element page item representation. Can accept: PageItem, TypefiElementAnchor or TypefiElementPageItem. (Optional)

Parameter

Type

Description

object

PageItem

TypefiElementAnchor

TypefiElementPageItem

A page item, a Typefi anchor page item or a Typefi element page item representation. Can accept: PageItem, TypefiElementAnchor or TypefiElementPageItem. (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 TypefiPageItemSettings to the default values

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

Set the value of a field of TypefiPageItemSettings

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 TypefiPageItemSettings.

String toSpecifier ()

Retrieves the object specifier.