File 'lib/azIndex.cls' (part of 'AutoDOC')

Description (short): Management of indices with a letter bar (a-z) above them.
Written by: Andreas Kupries
Description: Management of indices with a letter bar (a-z) above them.
Keywords: alphabetically structured index

Class 'azIndex'

Description

A derivation of the standard index structuring its output into alphabetically. The first letter of the name of an indexed object is used to categorize it.

Superclasses

indexBase

Methods

public: GenerateLetterBar ()
addItem (object)
clear ()
writeIndexBody ()

Membervariables

public: initial

Methods

GenerateLetterBar ()

Internal method. Generates a jump bar containing the letter of the alphabet. Letters having objects associated to them are build as hyperlinks to the appropriate section of the page.

addItem (object)

Overrides indexBase:addItem
Adds the specified object to the index. Overrides the definition in the baseclass to additionally maintain the mapping from letters to objects.

Argument: object The handle of the object added to the index.

clear ()

Overrides indexBase:clear
Resets state information.

writeIndexBody ()

Overrides indexBase:writeIndexBody
Called by the base class to write out the main section of the index. Overrides the base class definition to generate the additional alphabetical sectioning.

Membervariables

initial: This variable is used to maintain a mapping from the first letter in the name of an object to its handle. These lists are used later to generate the index page.

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,

GenerateLetterBar ()
Internal method. Generates a jump bar containing the letter of the alphabet. Letters having objects associated to them are build as hyperlinks to the appropriate section of the page.

addItem (object)
Overrides indexBase:addItem Adds the specified object to the index. Overrides the definition in the baseclass to additionally maintain the mapping from letters to objects.
Argument: object	The handle of the object added to the index.

writeIndexBody ()
Overrides indexBase:writeIndexBody Called by the base class to write out the main section of the index. Overrides the base class definition to generate the additional alphabetical sectioning.