File 'lib/azIndex.cls' (part of 'AutoDOC')
Home | Packages | Files | Procedures | Classes | Keywords | External packages
- 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
- Membervariables
- initial
- Methods
- GenerateLetterBar, addItem, clear, writeIndexBody
- 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.
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) |
Adds the specified object to the index. Overides 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 () |
Resets state information. |
writeIndexBody () |
Called by the base class to write out the main secton of the index. Overides the base class definition to generate the additional alphabetical sectioning. |
Generated by AutoDoc 2.1 at 02/15/1999, invoked by Andreas Kupries