com.highqsoft.interfaces.fwk

Interface FwkDialogPaneInterface

All Superinterfaces:

FwkInterface, java.io.Serializable

All Known Implementing Classes:

AsamCommanderInstanceSelectorPane, FwkAuthenticationDialogPane, FwkChangePasswordDialogPane, FwkColorDialogPane, FwkDialogPane, FwkFileChooserDialogPane, FwkFileDialogPane, FwkFontDialogPane, FwkInfoBusDialogPane, FwkListDialogPane, FwkPropertyEditorDialogPane, FwkTextDialogPane, FwkTextFieldDialogPane, FwkToggleDialogPane, MEDCalculatorBasicPane, MEDInfoBusSelectionDialogPane, MEDMarkerDelete.DeletePane, MEDMarkerThreshold.ThresholdPane, MoMaXPluginDialogPane, OdsxAttributeEditorPane, OdsxColumnAssignmentPane, OdsxDebugLevelEditorPane, OdsxFilterEditorPane, OdsxInstanceCopyPane, OdsxInstanceCreatePane, OdsxInstanceEditorPane, OdsxMeasurementCreatePane, OdsxTranslateDialogPane, P2DRangeDialogPane

public interface FwkDialogPaneInterface
extends FwkInterface

The FwkDialogPaneInterface interface defines the basic methods for a chooser pane.

Since:

$Date: 2017/04/06 13:29:09 $

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
void	addKeyListener(FwkKeyListenerInterface listener) Add a KeyListener to the listener list.
void	buttonCreated(int id, javax.swing.JButton button) This method will invoke whenever the dialog was constructed.
void	cancelPerformed(java.awt.event.ActionEvent ev) This method will be called when the cancel button is pressed.
void	dialogWillClose(FwkDialogInterface dialog) This method is called by the dialog if the it will close.
void	dialogWillOpen(FwkDialogInterface dialog) This method is called by the dialog if the it will open.
void	fireKeyEvent(FwkKeyEventInterface evt) Fire an existing key event to any registered listeners.
java.lang.String	getHelpID() Get the help ID of the panel.
FwkIconInterface	getIcon() Get the icon of the panel.
java.lang.String	getIdent() Get the ident string of the panel.
FwkArrayInterface	getKeyListenerArray() Get a vector containing the registered key listeners.
FwkDialogPaneValueInterface	getSelectedValue() Get the current selected value.
java.lang.String	getTip() Get the tool tip of the panel.
java.lang.String	getTitle() Get the current title.
boolean	isAllowedToConsume(java.util.EventObject evt) This method return a boolean that indicates whether a keyboard event should be considered by an keyboard listener.
boolean	isScrollable() This method returns a boolean, if the pane is scrollable.
boolean	needsCancel() This method returns a boolean whether the pane needs a CANCEL button.
boolean	needsClose() This method returns a boolean whether the pane needs a Close button.
boolean	needsHelp() This method returns a boolean whether the pane needs a HELP button.
boolean	needsOk() This method returns a boolean whether the pane needs an OK button.
boolean	needsReset() This method returns a boolean whether the pane needs a RESET button.
void	okPerformed(java.awt.event.ActionEvent ev) This method will be called when the ok button is pressed.
void	removeKeyListener(FwkKeyListenerInterface listener) Remove a KeyListener from the listener list.
void	setHelpID(java.lang.String id) Set the help ID string.
void	setIcon(FwkIconInterface icon) Set the icon of the pane.
void	setIdent(java.lang.String ident) Set the ident string.
void	setSelectedValue(FwkDialogPaneValueInterface value) Set the selected value.
void	setTip(java.lang.String tip) Set the tool tip of the panel.
void	setTitle(java.lang.String title) Set the title of the pane.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Method Detail

getSelectedValue

FwkDialogPaneValueInterface getSelectedValue()

Get the current selected value.

setSelectedValue

void setSelectedValue(FwkDialogPaneValueInterface value)

Set the selected value.

Parameters:

value - The value to be set as selected.

setTitle

void setTitle(java.lang.String title)

Set the title of the pane.

Parameters:

title - The new title string.

getTitle

java.lang.String getTitle()

Get the current title.

Returns:

The current title or null.

setIcon

void setIcon(FwkIconInterface icon)

Set the icon of the pane.

Parameters:

icon - The icon of the panel.

getIcon

FwkIconInterface getIcon()

Get the icon of the panel.

Returns:

The icon of the panel.

setTip

void setTip(java.lang.String tip)

Set the tool tip of the panel.

Parameters:

tip - The new tool tip text.

getTip

java.lang.String getTip()

Get the tool tip of the panel.

Returns:

The tool tip text of the panel.

setIdent

void setIdent(java.lang.String ident)

Set the ident string.

Parameters:

ident - The new ident string.

getIdent

java.lang.String getIdent()

Get the ident string of the panel.

Returns:

The ident string of the panel.

setHelpID

void setHelpID(java.lang.String id)

Set the help ID string.

Parameters:

id - The new help ID.

getHelpID

java.lang.String getHelpID()

Get the help ID of the panel.

Returns:

The help ID of the panel.

getKeyListenerArray

FwkArrayInterface getKeyListenerArray()

Get a vector containing the registered key listeners.

Returns:

The requested array.

addKeyListener

void addKeyListener(FwkKeyListenerInterface listener)

Add a KeyListener to the listener list.

Parameters:

listener - The key listener.

removeKeyListener

void removeKeyListener(FwkKeyListenerInterface listener)

Remove a KeyListener from the listener list.

Parameters:

listener - The key listener to be removed.

fireKeyEvent

void fireKeyEvent(FwkKeyEventInterface evt)

Fire an existing key event to any registered listeners.

Parameters:

evt - The message event.

isAllowedToConsume

boolean isAllowedToConsume(java.util.EventObject evt)

This method return a boolean that indicates whether a keyboard event should be considered by an keyboard listener.

Returns:

true if the event

needsOk

boolean needsOk()

This method returns a boolean whether the pane needs an OK button.

Returns:

true if the pane needs an ok button.

needsReset

boolean needsReset()

This method returns a boolean whether the pane needs a RESET button.

Returns:

true if the pane needs an reset button.

needsCancel

boolean needsCancel()

This method returns a boolean whether the pane needs a CANCEL button.

Returns:

true if the pane needs an cancel button.

needsClose

boolean needsClose()

This method returns a boolean whether the pane needs a Close button.

Returns:

true if the pane needs an close button.

needsHelp

boolean needsHelp()

This method returns a boolean whether the pane needs a HELP button.

Returns:

true if the pane needs an help button.

isScrollable

boolean isScrollable()

This method returns a boolean, if the pane is scrollable.

Returns:

true if the pane is scrollable.

dialogWillOpen

void dialogWillOpen(FwkDialogInterface dialog)

This method is called by the dialog if the it will open.

Parameters:

dialog - the dialog.

dialogWillClose

void dialogWillClose(FwkDialogInterface dialog)

This method is called by the dialog if the it will close.

Parameters:

dialog - the dialog.

buttonCreated

void buttonCreated(int id,
                 javax.swing.JButton button)

This method will invoke whenever the dialog was constructed. It will receive the button ID (constants defined by FwkDialogInterface) and the button belong to that ID.

Parameters:

id - The id of the button.

button - The button.

See Also:

FwkDialogInterface

okPerformed

void okPerformed(java.awt.event.ActionEvent ev)

This method will be called when the ok button is pressed. The pane is able to throw an exception so that the dialog interrupt the internal operations.

Parameters:

ev - the button event

cancelPerformed

void cancelPerformed(java.awt.event.ActionEvent ev)

This method will be called when the cancel button is pressed. The pane is able to throw an exception so that the dialog interrupt the internal operations.

Parameters:

ev - the button event