IndexSection

A section within an index.

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, String, Topic, Topics

Property Listing

Property

Type

Access

Description

allTopics

Array of Topic

readonly

The topics in the specified index section.

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

index

Number

readonly

The index of the IndexSection 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

readonly

The name of the IndexSection.

parent

Index

readonly

The parent of the IndexSection (a Index).

properties

Object

read/write

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

topics

Topics Topic

readonly

A collection of index topics.

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.

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

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Topic.parent

Return

IndexSection.getElements()

IndexSections.anyItem()

IndexSections.everyItem()

IndexSections.nextItem()

IndexSections.previousItem()

IndexSections.itemByID()

IndexSections.item()

IndexSections.[]()

IndexSections.itemByName()

IndexSections.itemByRange()

IndexSections.firstItem()

IndexSections.lastItem()

IndexSections.middleItem()