Edit in GitHubLog an issue

IndexSection

A section within an index.

Instance

Read Only

Topic allTopics

The topics in the specified index section.


Read Only

String name

The name of the IndexSection.


Read Only

Number id

The unique ID of the IndexSection.


Read Only

Boolean isValid

Returns true if the object specifier resolves to valid objects.


Read Only

Index parent

The parent of the IndexSection (a Index).


Read Only

Number index

The index of the IndexSection within its containing object.


Read Only

Events events

A collection of events.


Read Only

EventListeners eventListeners

A collection of event listeners.


Read Only

Topics topics

A collection of index topics.


String label

A property that can be set to any string.


Object properties

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

Methods

insertLabel( String key, String value )

Sets the label to the value associated with the specified key.

Parameters

TypeNameDescription
String
key
The key.
String
value
The value.

String extractLabel( String key )

Gets the label value associated with the specified key.

Parameters

TypeNameDescription
String
key
The key.

String toSource()

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


IndexSection getElements()

Resolves the object specifier, creating an array of object references.


String toSpecifier()

Retrieves the object specifier.


EventListener addEventListener( String eventType, Mixed handler, Boolean captures )

Adds an event listener.

Parameters

TypeNameDescription
String
eventType
The event type.
Mixed
handler
The event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)

Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )

Removes the event listener.

Parameters

TypeNameDescription
String
eventType
The registered event type.
Mixed
handler
The registered event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)
Was this helpful?
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2023 Adobe. All rights reserved.