A section within an index.
Go to Property Listing | Method Listing
insertLabel, extractLabel, toSource, getElements, toSpecifier, addEventListener, removeEventListener
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
allTopics |
readonly |
The topics in the specified index section. |
|
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
id |
readonly |
The unique ID of the IndexSection. |
|
|
index |
readonly |
The index of the IndexSection within its containing object. |
|
|
isValid |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
label |
read/write |
A property that can be set to any string. |
|
|
name |
readonly |
The name of the IndexSection. |
|
|
parent |
Index |
readonly |
The parent of the IndexSection (a Index). |
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
|
|
topics |
readonly |
A collection of index topics. |
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
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.
Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
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.