gui.dialog
Interface JAPDialog.ILinkedInformation

All Known Implementing Classes:

JAPDialog.AbstractLinkedURLAdapter, JAPDialog.LinkedCheckBox, JAPDialog.LinkedHelpContext, JAPDialog.LinkedInformation, JAPDialog.LinkedInformationAdapter, JAPDialog.LinkedURLCheckBox, JapHtmlPane.PageLoader.ExternalLinkedInformation, JAPInternalHelpViewer.HtmlPane.PageLoader.ExternalLinkedInformation

Enclosing class:

JAPDialog

public static interface JAPDialog.ILinkedInformation

Classes of this type are used to append a clickable and/or selectable message at the end of a dialog message. You may define any after-click-action that you want, for example open a help window. If an ILinkedInformation implements the interface JAPHelpContext.IHelpContext, a help button is shown that opens the specified help context on clicking.

Field Summary

static java.lang.String	MSG_MORE_INFO
static int	TYPE_CHECKBOX_FALSE Shows a checkbox and (!!) a help button if JAPHelpContext.IHelpContext is implemented
static int	TYPE_CHECKBOX_TRUE Shows a checkbox and (!!) a help button if JAPHelpContext.IHelpContext is implemented
static int	TYPE_DEFAULT Shows a clickable link or a help button if JAPHelpContext.IHelpContext is implemented
static int	TYPE_LINK Shows a clickable link and (!!) a help button if JAPHelpContext.IHelpContext is implemented
static int	TYPE_SELECTABLE_LINK Shows a selectable link and (!!) a help button if JAPHelpContext.IHelpContext is implemented

Method Summary

void	clicked(boolean a_bState) Performs an action when the link is clicked, for example opening a browser window, an E-Mail client or a help page.
java.lang.String	getMessage() Returns the information message.
java.lang.String	getTooltipText()
int	getType() Returns the type the the linked information.
boolean	isApplicationModalityForced() Returns if the dialog should block all other windows.
boolean	isCloseWindowActive() Returns if a click on the close button of the dialog closes the window.
boolean	isModal()
boolean	isOnTop() Returns if this dialog should be on top of all other windows in the system.

Field Detail

MSG_MORE_INFO

static final java.lang.String MSG_MORE_INFO

TYPE_DEFAULT

static final int TYPE_DEFAULT

Shows a clickable link or a help button if JAPHelpContext.IHelpContext is implemented

See Also:

Constant Field Values

TYPE_LINK

static final int TYPE_LINK

Shows a clickable link and (!!) a help button if JAPHelpContext.IHelpContext is implemented

See Also:

Constant Field Values

TYPE_SELECTABLE_LINK

static final int TYPE_SELECTABLE_LINK

Shows a selectable link and (!!) a help button if JAPHelpContext.IHelpContext is implemented

See Also:

Constant Field Values

TYPE_CHECKBOX_TRUE

static final int TYPE_CHECKBOX_TRUE

Shows a checkbox and (!!) a help button if JAPHelpContext.IHelpContext is implemented

See Also:

Constant Field Values

TYPE_CHECKBOX_FALSE

static final int TYPE_CHECKBOX_FALSE

Shows a checkbox and (!!) a help button if JAPHelpContext.IHelpContext is implemented

See Also:

Constant Field Values

Method Detail

getMessage

java.lang.String getMessage()

Returns the information message. This must be normal text, HTML is not allowed and tags are filtered out. If the message is null or empty, no linked information will be displayed.

Returns:

the information message

clicked

void clicked(boolean a_bState)

Performs an action when the link is clicked, for example opening a browser window, an E-Mail client or a help page.

Parameters:

a_bState - sets the current state if the linked information is defined as a checkbox.

getType

int getType()

Returns the type the the linked information. It may be a simple link in HTML style (TYPE_LINK), a selectable link that may be copied to the clipboard (TYPE_SELECTABLE_LINK) or a checkbox (TYPE_CHECKBOX_TRUE or TYPE_CHECKBOX_FALSE). In case of a checkbox, the clicked method is called with the state of the checkbox. You may initialise the checkbox with true (TYPE_CHECKBOX_TRUE) or false (TYPE_CHECKBOX_FALSE).

Returns:

if the user is allowed to copy the link text

isApplicationModalityForced

boolean isApplicationModalityForced()

Returns if the dialog should block all other windows. This should not be the default behaviour as, for example, no help window would be accessible.

Returns:

if the dialog should block all other windows

isOnTop

boolean isOnTop()

Returns if this dialog should be on top of all other windows in the system.

Returns:

if this dialog should be on top of all other windows in the system

isModal

boolean isModal()

isCloseWindowActive

boolean isCloseWindowActive()

Returns if a click on the close button of the dialog closes the window.

Returns:

if a click on the close button of the dialog closes the window

getTooltipText

java.lang.String getTooltipText()