ui.accessibility

Class HelpAction

java.lang.Object

javax.swing.AbstractAction

ui.accessibility.HelpAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

public class HelpAction
extends javax.swing.AbstractAction

Help Action

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
HelpAction(java.lang.String newid, java.lang.String name, java.lang.Boolean isContextual) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
void	resetTOC(java.lang.Boolean isContextualHelp) tidies the table of content
java.lang.String	toHTML(java.lang.String s) replaces special characters (except <, >, ", &)

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpAction

public HelpAction(java.lang.String newid,
          java.lang.String name,
          java.lang.Boolean isContextual)

Constructor

Parameters:

newid - : ID of the help page

name - : name of the help page (if context)

isContextual - : false if from main window, true otherwise

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Parameters:

e - : action event

resetTOC

public void resetTOC(java.lang.Boolean isContextualHelp)

tidies the table of content

Parameters:

isContextualHelp - : true if contextual (creates html file)

toHTML

public java.lang.String toHTML(java.lang.String s)

replaces special characters (except <, >, ", &)

Parameters:

s - string with special characters

Returns:

string with html characters