TypefiSectionDefinition

Typefi section definition

Go to Property Listing | Method Listing

Methods:

addEventListener, appliedMasterAt, appliedMastersLength, applyMaster, extractLabel, getElements, insertLabel, modifyMasterAt, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, PageNumberStyle, String, TypefiResetType, TypefiSectionType,

Property Listing

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	Number	readonly	The unique ID of the TypefiSectionDefinition.
index	Number	readonly	The index of the TypefiSectionDefinition within its containing object.
isRepeating	Boolean	read/write	Indicate whether sections of this type are repeating the last masters entry
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
marker	Array of Strings Array of TypefiFieldDefinitions(0-3)	read/write	Section marker. Can return: Array of Strings or TypefiFieldDefinitions (0 - 3).
markerString	String	read/write	Section marker string
name	String	read/write	The name of the TypefiSectionDefinition.
pageNumberStyle	PageNumberStyle PageNumberStyle.ARABIC PageNumberStyle.ARABIC_ABJAD PageNumberStyle.ARABIC_ALIF_BA_TAH PageNumberStyle.DOUBLE_LEADING_ZEROS PageNumberStyle.HEBREW_BIBLICAL PageNumberStyle.HEBREW_NON_STANDARD PageNumberStyle.KANJI PageNumberStyle.LOWER_LETTERS PageNumberStyle.LOWER_ROMAN PageNumberStyle.SINGLE_LEADING_ZEROS PageNumberStyle.TRIPLE_LEADING_ZEROS PageNumberStyle.UPPER_LETTERS PageNumberStyle.UPPER_ROMAN String	read/write	The page number style. Can return: PageNumberStyle enumerator or String.
parent	Document	readonly	The parent of the TypefiSectionDefinition (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
resetType	TypefiResetType TypefiResetType.ALWAYS TypefiResetType.IF_FIRST TypefiResetType.NONE	read/write	Define the way the section handles the reset of the page number on section start
sectionPrefix	Array of Strings Array of TypefiFieldDefinitions(0-3)	read/write	Section prefix. Can return: Array of Strings or TypefiFieldDefinitions (0 - 3).
sectionPrefixString	String	read/write	Section prefix string
type	TypefiSectionType TypefiSectionType.ENDNOTE TypefiSectionType.INDEX TypefiSectionType.MAIN_STORY TypefiSectionType.TOC	read/write	The section 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)

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)

String appliedMasterAt (index:Number)

Returns an array of strings for the applied master at passed index

Parameter	Type	Description
index	Number	Index

Number appliedMastersLength ()

Returns number of applied masters in a section

undefined applyMaster (master:MasterSpread, typefiStartsOnType:TypefiPageType, useAllPages:Boolean, filler:MasterSpread)

Adds master to section

Parameter	Type	Description
master	MasterSpread	Master
typefiStartsOnType	TypefiPageType TypefiPageType.ANY_SIDE TypefiPageType.BOTH_SIDES TypefiPageType.INNER_SIDE TypefiPageType.LEFT_SIDE TypefiPageType.NONE TypefiPageType.RIGHT_SIDE	Values for Typefi starts on types
useAllPages	Boolean	Specify whether to use all master spread pages
filler	MasterSpread	Filler (Optional)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

TypefiSectionDefinition 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 modifyMasterAt (index:Number, master:MasterSpread, typefiStartsOnType:TypefiPageType, useAllPages:Boolean, filler:MasterSpread)

Modifies the master associated at Index

Parameter	Type	Description
index	Number	Index
master	MasterSpread	Master
typefiStartsOnType	TypefiPageType TypefiPageType.ANY_SIDE TypefiPageType.BOTH_SIDES TypefiPageType.INNER_SIDE TypefiPageType.LEFT_SIDE TypefiPageType.NONE TypefiPageType.RIGHT_SIDE	Values for Typefi starts on types
useAllPages	Boolean	Specify whether to use all master spread pages
filler	MasterSpread	Filler (Optional)

undefined remove ()

Deletes the TypefiSectionDefinition.

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)