TypefiFrameItem

Typefi frame item

Methods:

addEventListener, getElements, removeEventListener, resetAllToDefaults, toSource, toSpecifier

Objects:

AnchorPoint, Boolean, EventListeners, Events, Object, ParagraphStyle, String, TOCStyle, TypefiFitOptions, TypefiFrameType, TypefiLimitType, TypefiPosterTypes,

Hierarchy:

Superclass: Preference

Class: TypefiFrameItem

Property Listing

Property

Type

Access

Description

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 acnhor point to expand an image from

controllerSkin

Boolean

read/write

Enable controller skin for Typefi video

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

expansionLimit

Real(>=0)

TypefiLimitType

TypefiLimitType.NO_LIMIT

read/write

Expansion limit. Can return: Real (>= 0) or TypefiLimitType enumerator.

fittingOption

TypefiFitOptions

TypefiFitOptions.CONTENT_THEN_FRAME_PROPORTIONALLY

TypefiFitOptions.CONTENT_TO_FRAME

TypefiFitOptions.FILL_PROPORTIONALLY

TypefiFitOptions.FRAME_TO_CONTENT

TypefiFitOptions.NONE

TypefiFitOptions.PROPORTIONALLY

read/write

Fitting option

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

loop

Boolean

read/write

Enable looping for Typefi audio and video

parent

TypefiPageItemSettings

readonly

The parent of the TypefiFrameItem (a TypefiPageItemSettings).

playOnPageTurn

Boolean

read/write

Enable play on page turn for Typefi audio and video

posterType

TypefiPosterTypes

TypefiPosterTypes.FROM_MOVIE

TypefiPosterTypes.NONE

TypefiPosterTypes.PROXY_IMAGE

TypefiPosterTypes.STANDARD

read/write

Typefi poster type

properties

Object

read/write

A property that allows setting of several properties at the same time.

reductionLimit

Real(>=0)

TypefiLimitType

TypefiLimitType.NO_LIMIT

read/write

Reduction limit. Can return: Real (>= 0) or TypefiLimitType enumerator.

showController

Boolean

read/write

Show controller on rollover for Typefi video

spineRelative

Boolean

read/write

Determine if the anchor point is spine relative

stopOnPageTurn

Boolean

read/write

Enable stop on page turn for Typefi audio

style

ParagraphStyle

TOCStyle

String

read/write

Style. Can return: ParagraphStyle, TOCStyle or String.

type

TypefiFrameType

TypefiFrameType.AUDIO

TypefiFrameType.CONTENT

TypefiFrameType.ENDNOTE

TypefiFrameType.FOOTNOTE

TypefiFrameType.IMAGE

TypefiFrameType.INDEX

TypefiFrameType.MAIN_STORY

TypefiFrameType.NONE

TypefiFrameType.TOC

TypefiFrameType.VIDEO

read/write

The frame type

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)

TypefiFrameItem getElements ()

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

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)

undefined resetAllToDefaults ()

Reset the Typefi specific data of TypefiFrameItem to the default values

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

TypefiPageItemSettings.frame

Return

TypefiFrameItem.getElements()