Class

KinsokuTable

 The kinsoku table.

QuickLinks

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

Hierarchy

Application | Document
KinsokuTable
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
cantBeSeparatedCharsstring r/wThe characters in the kinsoku set that cannot be separated.
cantBeginLineCharsstring r/wThe characters in the kinsoku set that cannot begin lines.
cantEndLineCharsstring r/wThat characters in the kinsoku set that cannot end lines.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
hangingPunctuationCharsstring r/wThe hanging punctuation characters in the kinsoku set.
idnumber readonlyThe unique ID of the KinsokuTable.
indexnumber readonlyThe index of the KinsokuTable within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the KinsokuTable.
parentApplication
Document
readonlyThe parent of the KinsokuTable (a Document or Application).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of KinsokuTable getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the KinsokuTable.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the KinsokuTable.

string toSpecifier ()
Retrieves the object specifier.

Element of

ChangeGrepPreference.kinsokuSet

ChangeTextPreference.kinsokuSet

ChangeTransliteratePreference.kinsokuSet

Character.kinsokuSet

FindGrepPreference.kinsokuSet

FindTextPreference.kinsokuSet

FindTransliteratePreference.kinsokuSet

InsertionPoint.kinsokuSet

Line.kinsokuSet

Paragraph.kinsokuSet

ParagraphStyle.kinsokuSet

Story.kinsokuSet

Text.kinsokuSet

TextColumn.kinsokuSet

TextDefault.kinsokuSet

TextStyleRange.kinsokuSet

Word.kinsokuSet

XmlStory.kinsokuSet

Used in:

KinsokuTable KinsokuTables.nextItem (obj: KinsokuTable)

KinsokuTable KinsokuTables.previousItem (obj: KinsokuTable)

Return

Array of KinsokuTable KinsokuTable.getElements ()

KinsokuTable KinsokuTables.[] (index: number)

KinsokuTable KinsokuTables.add (name: string[, withProperties: Object])

KinsokuTable KinsokuTables.anyItem ()

Array of KinsokuTable KinsokuTables.everyItem ()

KinsokuTable KinsokuTables.firstItem ()

KinsokuTable KinsokuTables.item (index: varies)

KinsokuTable KinsokuTables.itemByID (id: number)

KinsokuTable KinsokuTables.itemByName (name: string)

Array of KinsokuTable KinsokuTables.itemByRange (from: varies, to: varies)

KinsokuTable KinsokuTables.lastItem ()

KinsokuTable KinsokuTables.middleItem ()

KinsokuTable KinsokuTables.nextItem (obj: KinsokuTable)

KinsokuTable KinsokuTables.previousItem (obj: KinsokuTable)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index