KinsokuTable

The kinsoku table.

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, String

Property Listing

Property

Type

Access

Description

cantBeSeparatedChars

String

read/write

The characters in the kinsoku set that cannot be separated.

cantBeginLineChars

String

read/write

The characters in the kinsoku set that cannot begin lines.

cantEndLineChars

String

read/write

That characters in the kinsoku set that cannot end lines.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

hangingPunctuationChars

String

read/write

The hanging punctuation characters in the kinsoku set.

id

Number

readonly

The unique ID of the KinsokuTable.

index

Number

readonly

The index of the KinsokuTable within its containing object.

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.

name

String

read/write

The name of the KinsokuTable.

parent

Application

Document

readonly

The parent of the KinsokuTable (a Document or Application).

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)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

KinsokuTable 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 remove ()

Deletes the KinsokuTable.

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)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

TextDefault.kinsokuSet

Text.kinsokuSet

Character.kinsokuSet

Word.kinsokuSet

Line.kinsokuSet

TextColumn.kinsokuSet

Paragraph.kinsokuSet

TextStyleRange.kinsokuSet

InsertionPoint.kinsokuSet

Story.kinsokuSet

ParagraphStyle.kinsokuSet

XmlStory.kinsokuSet

FindTextPreference.kinsokuSet

FindGrepPreference.kinsokuSet

FindTransliteratePreference.kinsokuSet

ChangeTextPreference.kinsokuSet

ChangeGrepPreference.kinsokuSet

ChangeTransliteratePreference.kinsokuSet

Event.parent

EventListener.parent

MutationEvent.parent

Return

KinsokuTables.add()

KinsokuTable.getElements()

KinsokuTables.anyItem()

KinsokuTables.everyItem()

KinsokuTables.nextItem()

KinsokuTables.previousItem()

KinsokuTables.itemByID()

KinsokuTables.item()

KinsokuTables.[]()

KinsokuTables.itemByName()

KinsokuTables.itemByRange()

KinsokuTables.firstItem()

KinsokuTables.lastItem()

KinsokuTables.middleItem()