com.luciad.lucy

LuciadLightspeedClass ALcyHelpManager

java.lang.Object

com.luciad.lucy.ALcyHelpManager

public abstract class ALcyHelpManager
extends Object

A help manager is responsible for offering the possibility to context sensitive help. One can register a string to a component and can later on retrieve that string, given the component. With this string one can retrieve and show the correct help file. So one can retrieve the help file, given the component, which is exactly what we mean by context sensitive help.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HELP_ID_KEY This string can be used as a key for storing help id's.

Constructor Summary

Constructors

Constructor and Description
ALcyHelpManager()

Method Summary

Modifier and Type	Method and Description
abstract String	getHelpIDString(Component aComponent) Returns a previously registered help id for the given component
abstract void	putHelpIDString(Component aComponent, String aHelpID) Registers a help identifier to a component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HELP_ID_KEY

public static final String HELP_ID_KEY

This string can be used as a key for storing help id's. Target usage is to give an action a help id (= String value) via the putValue mechanism. Also note that your help id's should also work after obfuscation, so don't use class.getName() or things like that.

See Also:

Constant Field Values

Constructor Detail

ALcyHelpManager

public ALcyHelpManager()

Method Detail

getHelpIDString

public abstract String getHelpIDString(Component aComponent)

Returns a previously registered help id for the given component

Parameters:

aComponent - The component to retrieve the help id from

Returns:

The help id for the given component, or null if no help id was previously registered to that component.

See Also:

putHelpIDString(java.awt.Component, java.lang.String)

putHelpIDString

public abstract void putHelpIDString(Component aComponent,
                                     String aHelpID)

Registers a help identifier to a component. This is used to retrieve context sensitive help for that component.

Parameters:

aComponent - The component to associate the help id with

aHelpID - The help id to associate to the given component

See Also:

getHelpIDString(java.awt.Component)