gui.dialog
Class JAPDialog.LinkedCheckBox

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

All Implemented Interfaces:

JAPDialog.ILinkedInformation, JAPHelpContext.IHelpContext

Direct Known Subclasses:

JAPDialog.LinkedURLCheckBox

Enclosing class:

JAPDialog

public static class JAPDialog.LinkedCheckBox
extends JAPDialog.LinkedHelpContext

Shows a checkbox with a message on the dialog window.

Field Summary

private boolean	m_bDefault
private boolean	m_bState
private java.lang.String	m_strMessage
static java.lang.String	MSG_DO_NOT_SHOW_AGAIN
static java.lang.String	MSG_REMEMBER_ANSWER

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.LinkedCheckBox(boolean a_bDefault)
Creates a new linked checkbox with the default message MSG_DO_NOT_SHOW_AGAIN.

JAPDialog.LinkedCheckBox(boolean a_bDefault, JAPHelpContext.IHelpContext a_helpContext)
Creates a new linked checkbox with the default message MSG_DO_NOT_SHOW_AGAIN.

JAPDialog.LinkedCheckBox(boolean a_bDefault, java.lang.String a_strHelpContext)
Creates a new linked checkbox with the default message MSG_DO_NOT_SHOW_AGAIN.

JAPDialog.LinkedCheckBox(java.lang.String a_strMessage, boolean a_bDefault)
Creates a new linked checkbox.

JAPDialog.LinkedCheckBox(java.lang.String a_strMessage, boolean a_bDefault, JAPHelpContext.IHelpContext a_helpContext)
Creates a new linked checkbox.

JAPDialog.LinkedCheckBox(java.lang.String a_strMessage, boolean a_bDefault, java.lang.String a_strHelpContext)
Creates a new linked checkbox.

Method Summary

void	clicked(boolean a_bState) Updates the state when the checkbox is clicked.
java.lang.String	getMessage() Returns the information message of the checkbox.
boolean	getState() Returns the state of the checkbox.
int	getType() Returns, depending on the default value, either TYPE_CHECKBOX_TRUE or TYPE_CHECKBOX_FALSE.

Methods inherited from class gui.dialog.JAPDialog.LinkedHelpContext

getHelpContext, getHelpExtractionDisplayContext, isApplicationModalityForced

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

MSG_REMEMBER_ANSWER

public static final java.lang.String MSG_REMEMBER_ANSWER

MSG_DO_NOT_SHOW_AGAIN

public static final java.lang.String MSG_DO_NOT_SHOW_AGAIN

m_strMessage

private java.lang.String m_strMessage

m_bDefault

private boolean m_bDefault

m_bState

private boolean m_bState

Constructor Detail

JAPDialog.LinkedCheckBox

public JAPDialog.LinkedCheckBox(boolean a_bDefault)

Creates a new linked checkbox with the default message MSG_DO_NOT_SHOW_AGAIN.

Parameters:

a_bDefault - the default value of the checkbox

JAPDialog.LinkedCheckBox

public JAPDialog.LinkedCheckBox(boolean a_bDefault,
                                JAPHelpContext.IHelpContext a_helpContext)

Creates a new linked checkbox with the default message MSG_DO_NOT_SHOW_AGAIN.

Parameters:

a_bDefault - the default value of the checkbox

a_helpContext - the help context that is opened when the help button is clicked

JAPDialog.LinkedCheckBox

public JAPDialog.LinkedCheckBox(boolean a_bDefault,
                                java.lang.String a_strHelpContext)

Creates a new linked checkbox with the default message MSG_DO_NOT_SHOW_AGAIN.

Parameters:

a_bDefault - the default value of the checkbox

a_strHelpContext - the help context that is opened when the help button is clicked

JAPDialog.LinkedCheckBox

public JAPDialog.LinkedCheckBox(java.lang.String a_strMessage,
                                boolean a_bDefault)

Creates a new linked checkbox.

Parameters:

a_strMessage - a message to be displayed with the checkbox

a_bDefault - the default value of the checkbox

JAPDialog.LinkedCheckBox

public JAPDialog.LinkedCheckBox(java.lang.String a_strMessage,
                                boolean a_bDefault,
                                java.lang.String a_strHelpContext)

Creates a new linked checkbox.

Parameters:

a_strMessage - a message to be displayed with the checkbox

a_bDefault - the default value of the checkbox

a_strHelpContext - the help context that is opened when the help button is clicked

JAPDialog.LinkedCheckBox

public JAPDialog.LinkedCheckBox(java.lang.String a_strMessage,
                                boolean a_bDefault,
                                JAPHelpContext.IHelpContext a_helpContext)

Creates a new linked checkbox.

Parameters:

a_strMessage - a message to be displayed with the checkbox

a_bDefault - the default value of the checkbox

a_helpContext - the help context that is opened when the help button is clicked

Method Detail

getMessage

public java.lang.String getMessage()

Returns the information message of the checkbox.

Specified by:

getMessage in interface JAPDialog.ILinkedInformation

Overrides:

getMessage in class JAPDialog.LinkedHelpContext

Returns:

the information message of the checkbox

clicked

public void clicked(boolean a_bState)

Updates the state when the checkbox is clicked.

Specified by:

clicked in interface JAPDialog.ILinkedInformation

Overrides:

clicked in class JAPDialog.LinkedHelpContext

Parameters:

a_bState - sets the current state of the checkbox

getState

public final boolean getState()

Returns the state of the checkbox.

Returns:

the state of the checkbox

getType

public final int getType()

Returns, depending on the default value, either TYPE_CHECKBOX_TRUE or TYPE_CHECKBOX_FALSE.

Specified by:

getType in interface JAPDialog.ILinkedInformation

Overrides:

getType in class JAPDialog.LinkedHelpContext

Returns:

if the user is allowed to copy the link text