gui.dialog
Class JAPDialog.LinkedHelpContext

java.lang.Object
  gui.dialog.JAPDialog.LinkedInformationAdapter
      gui.dialog.JAPDialog.LinkedHelpContext

All Implemented Interfaces:

JAPDialog.ILinkedInformation, JAPHelpContext.IHelpContext

Direct Known Subclasses:

JAPDialog.LinkedCheckBox

Enclosing class:

JAPDialog

public static class JAPDialog.LinkedHelpContext
extends JAPDialog.LinkedInformationAdapter
implements JAPHelpContext.IHelpContext

This implementation of ILinkedInformation registers a help context in the dialog and displays a help button that opens this context. Subclasses may override it to show an additional link or a checkbox.

Field Summary

private JAPHelpContext.IHelpContext

m_helpContext

Fields inherited from interface gui.dialog.JAPDialog.ILinkedInformation

MSG_MORE_INFO, TYPE_CHECKBOX_FALSE, TYPE_CHECKBOX_TRUE, TYPE_DEFAULT, TYPE_LINK, TYPE_SELECTABLE_LINK

Constructor Summary

JAPDialog.LinkedHelpContext(JAPHelpContext.IHelpContext a_helpContext)

JAPDialog.LinkedHelpContext(java.lang.String a_strHelpContext)

Method Summary

void	clicked(boolean a_bState) Does nothing.
java.lang.String	getHelpContext()
java.awt.Component	getHelpExtractionDisplayContext()
java.lang.String	getMessage() Returns null as no message is needed.
int	getType() Returns TYPE_DEFAULT.
boolean	isApplicationModalityForced() Returns false as otherwise the help window would not be accessible.

Methods inherited from class gui.dialog.JAPDialog.LinkedInformationAdapter

getTooltipText, isCloseWindowActive, isModal, isOnTop

Methods inherited from class java.lang.Object

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

Field Detail

m_helpContext

private JAPHelpContext.IHelpContext m_helpContext

Constructor Detail

JAPDialog.LinkedHelpContext

public JAPDialog.LinkedHelpContext(JAPHelpContext.IHelpContext a_helpContext)

JAPDialog.LinkedHelpContext

public JAPDialog.LinkedHelpContext(java.lang.String a_strHelpContext)

Method Detail

getHelpContext

public final java.lang.String getHelpContext()

Specified by:

getHelpContext in interface JAPHelpContext.IHelpContext

getHelpExtractionDisplayContext

public java.awt.Component getHelpExtractionDisplayContext()

Specified by:

getHelpExtractionDisplayContext in interface JAPHelpContext.IHelpContext

getMessage

public java.lang.String getMessage()

Returns null as no message is needed.

Specified by:

getMessage in interface JAPDialog.ILinkedInformation

Overrides:

getMessage in class JAPDialog.LinkedInformationAdapter

Returns:

null

clicked

public void clicked(boolean a_bState)

Does nothing.

Specified by:

clicked in interface JAPDialog.ILinkedInformation

Overrides:

clicked in class JAPDialog.LinkedInformationAdapter

Parameters:

a_bState - is ignored

getType

public int getType()

Returns TYPE_DEFAULT.

Specified by:

getType in interface JAPDialog.ILinkedInformation

Overrides:

getType in class JAPDialog.LinkedInformationAdapter

Returns:

TYPE_DEFAULT

isApplicationModalityForced

public final boolean isApplicationModalityForced()

Returns false as otherwise the help window would not be accessible.

Specified by:

isApplicationModalityForced in interface JAPDialog.ILinkedInformation

Overrides:

isApplicationModalityForced in class JAPDialog.LinkedInformationAdapter

Returns:

false