com.highqsoft.fwk.dialog

Class FwkDialogPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.highqsoft.fwk.FwkPanel

com.highqsoft.fwk.dialog.FwkDialogPane

All Implemented Interfaces:

FwkCompareInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkDialogPaneInterface, FwkDOMHandlerInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPanelInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPrintableInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Pageable, java.awt.print.Printable, java.io.Serializable, java.lang.Comparable, javax.accessibility.Accessible, javax.infobus.DataItem

Direct Known Subclasses:

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

public abstract class FwkDialogPane
extends FwkPanel
implements FwkDialogPaneInterface

This class supports the creation of a chooser pane. Inherent from this class to get the basic functionality of pane brick.

Since:

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

Version:

$Revision: 1.15 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected FwkDialogInterface	fwkDialog The dialog.
protected java.lang.String	helpId The help id.
protected FwkIconInterface	icon The icon.
protected java.lang.String	ident The ident string of the pane.
protected java.lang.String	tip The tool tip text.
protected java.lang.String	title The title string of the pane.
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkPanel

bgImage, controller, descriptor, fwkItem, imgHeight, imgWidth, lineAppearance, newHeight, newWidth, pageFormat, readingDOM, text, textAppearance, xalign, yalign

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkPanelInterface

BOTTOM, CENTER, LEFT, RIGHT, TOP

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

INFOBUS_SOURCE

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
FwkDialogPane() The constructor.
FwkDialogPane(java.lang.String title) The constructor receiving the title string.

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.
java.lang.String	getParams() This function returns a string containing all parameter of the object.
java.lang.String	getTip() Get the tool tip of the panel.
java.lang.String	getTitle() Get the current title.
java.lang.String	getVersion() Return the version string of the FWK component.
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	setDefaults() This method sets all internal states to the default.
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	setTip(java.lang.String tip) Set the tool tip of the panel.
void	setTitle(java.lang.String title) Set the title of the pane.
java.lang.String	toString() This function returns a string containing the string representation of the object.

Methods inherited from class com.highqsoft.fwk.FwkPanel

addCommand, addCommand, addPropertyChangeListener, addPropertyChangeListener, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, commandsAvailable, compareTo, deleteGroup, destroyController, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getBuild, getClassName, getCommand, getCommands, getCommands, getCompany, getCompanyInternetAddress, getController, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getDescriptor, getGroup, getIcon, getIconKey, getIconKey, getInstanceDescriptor, getName, getNumberOfPages, getPageFormat, getPersistentObjectNames, getPresentationString, getPresentationString, getPrintable, getPrintJobName, getProperty, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, getPropertyGroup, getSource, getSupportEMail, getTitleName, getTransferData, getTransferDataFlavors, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, groupExists, isDataFlavorSupported, isPropertyChangeEventSuspended, lostOwnership, paintComponent, print, printPanel, readConstructor, readFromDOM, readingDOM, readingDOM, refresh, release, removeCommand, removeFromGroup, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, setAuthor, setBackgroundImage, setBuild, setClassName, setCommands, setCompany, setCompanyInternetAddress, setController, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setDescriptor, setIcon, setIconKey, setIconKey, setLineAppearance, setName, setPageFormat, setProperty, setPropertyGroup, setSource, setSupportEMail, setText, setTextAlignment, setTextAppearance, setTitleName, suspendChangeManager, suspendPropertyChangeEvents, writeConstructor, writeToDOM, writeToXML

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

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

getSelectedValue, setSelectedValue

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

release

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

add

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

title

protected java.lang.String title

The title string of the pane. This title is used e.g. for tabbed-pane labeling.

icon

protected FwkIconInterface icon

The icon.

tip

protected java.lang.String tip

The tool tip text.

ident

protected java.lang.String ident

The ident string of the pane.

helpId

protected java.lang.String helpId

The help id.

fwkDialog

protected FwkDialogInterface fwkDialog

The dialog.

Constructor Detail

FwkDialogPane

public FwkDialogPane()

The constructor.

FwkDialogPane

public FwkDialogPane(java.lang.String title)

The constructor receiving the title string.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkPanel

setTitle

public void setTitle(java.lang.String title)

Set the title of the pane.

Specified by:

setTitle in interface FwkDialogPaneInterface

Parameters:

title - The new title string.

getTitle

public java.lang.String getTitle()

Get the current title.

Specified by:

getTitle in interface FwkDescriptionInterface

Specified by:

getTitle in interface FwkDialogPaneInterface

Specified by:

getTitle in interface FwkPanelInterface

Overrides:

getTitle in class FwkPanel

Returns:

The current title or null.

setIcon

public void setIcon(FwkIconInterface icon)

Set the icon of the pane.

Specified by:

setIcon in interface FwkDescriptionInterface

Specified by:

setIcon in interface FwkDialogPaneInterface

Overrides:

setIcon in class FwkPanel

Parameters:

icon - The icon of the panel.

See Also:

#getIcon(FwkIconInterface)

getIcon

public FwkIconInterface getIcon()

Get the icon of the panel.

Specified by:

getIcon in interface FwkDescriptionInterface

Specified by:

getIcon in interface FwkDialogPaneInterface

Overrides:

getIcon in class FwkPanel

Returns:

The icon of the panel.

See Also:

FwkPanel.setIcon(FwkIconInterface)

setTip

public void setTip(java.lang.String tip)

Set the tool tip of the panel.

Specified by:

setTip in interface FwkDialogPaneInterface

Parameters:

tip - The new tool tip text.

getTip

public java.lang.String getTip()

Get the tool tip of the panel.

Specified by:

getTip in interface FwkDialogPaneInterface

Returns:

The tool tip text of the panel.

setIdent

public void setIdent(java.lang.String ident)

Set the ident string.

Specified by:

setIdent in interface FwkDialogPaneInterface

Parameters:

ident - The new ident string.

getIdent

public java.lang.String getIdent()

Get the ident string of the panel.

Specified by:

getIdent in interface FwkDialogPaneInterface

Returns:

The ident string of the panel.

setHelpID

public void setHelpID(java.lang.String id)

Set the help ID string.

Specified by:

setHelpID in interface FwkDialogPaneInterface

Parameters:

id - The new help ID.

getHelpID

public java.lang.String getHelpID()

Get the help ID of the panel.

Specified by:

getHelpID in interface FwkDialogPaneInterface

Returns:

The help ID of the panel.

setDefaults

public void setDefaults()

This method sets all internal states to the default.

getParams

public java.lang.String getParams()

This function returns a string containing all parameter of the object.

See Also:

toString

toString

public java.lang.String toString()

This function returns a string containing the string representation of the object.

Overrides:

toString in class java.awt.Component

Returns:

The string representation of the object.

See Also:

getParams

getKeyListenerArray

public FwkArrayInterface getKeyListenerArray()

Get a vector containing the registered key listeners.

Specified by:

getKeyListenerArray in interface FwkDialogPaneInterface

Returns:

The requested array.

addKeyListener

public void addKeyListener(FwkKeyListenerInterface listener)

�Add a KeyListener to the listener list.

Specified by:

addKeyListener in interface FwkDialogPaneInterface

Parameters:

listener - The key listener.

removeKeyListener

public void removeKeyListener(FwkKeyListenerInterface listener)

�Remove a KeyListener from the listener list.

Specified by:

removeKeyListener in interface FwkDialogPaneInterface

Parameters:

listener - The key listener to be removed.

fireKeyEvent

public void fireKeyEvent(FwkKeyEventInterface evt)

Fire an existing key event to any registered listeners.

Specified by:

fireKeyEvent in interface FwkDialogPaneInterface

Parameters:

evt - The message event.

isAllowedToConsume

public boolean isAllowedToConsume(java.util.EventObject evt)

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

Specified by:

isAllowedToConsume in interface FwkDialogPaneInterface

Returns:

true if the event

needsOk

public boolean needsOk()

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

Specified by:

needsOk in interface FwkDialogPaneInterface

Returns:

true if the pane needs an ok button.

needsReset

public boolean needsReset()

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

Specified by:

needsReset in interface FwkDialogPaneInterface

Returns:

true if the pane needs an reset button.

needsCancel

public boolean needsCancel()

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

Specified by:

needsCancel in interface FwkDialogPaneInterface

Returns:

true if the pane needs an cancel button.

needsClose

public boolean needsClose()

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

Specified by:

needsClose in interface FwkDialogPaneInterface

Returns:

true if the pane needs an close button.

needsHelp

public boolean needsHelp()

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

Specified by:

needsHelp in interface FwkDialogPaneInterface

Returns:

true if the pane needs an help button.

isScrollable

public boolean isScrollable()

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

Specified by:

isScrollable in interface FwkDialogPaneInterface

Returns:

true if the pane is scrollable.

dialogWillOpen

public void dialogWillOpen(FwkDialogInterface dialog)

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

Specified by:

dialogWillOpen in interface FwkDialogPaneInterface

Parameters:

dialog - the dialog.

dialogWillClose

public void dialogWillClose(FwkDialogInterface dialog)

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

Specified by:

dialogWillClose in interface FwkDialogPaneInterface

Parameters:

dialog - the dialog.

buttonCreated

public 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. When the panel will close this method will be called with null for the button parameter. This method currently does nothing. Overload it to have an effect.

Specified by:

buttonCreated in interface FwkDialogPaneInterface

Parameters:

id - The id of the button.

button - The button.

See Also:

FwkDialogInterface

okPerformed

public 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.

Specified by:

okPerformed in interface FwkDialogPaneInterface

Parameters:

ev - the button event

cancelPerformed

public 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.

Specified by:

cancelPerformed in interface FwkDialogPaneInterface

Parameters:

ev - the button event