Package adams.gui.goe

Class GenericObjectEditorDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

adams.gui.core.BaseDialog

adams.gui.goe.GenericObjectEditorDialog

All Implemented Interfaces:

UserModeSupporter, UndoHandler, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

HistogramFactory.SetupDialog

public class GenericObjectEditorDialog
extends BaseDialog
implements ActionListener, UserModeSupporter, UndoHandler

Displays a GenericObjectEditor.

Calling code needs to dispose the dialog manually or enable automatic disposal:

 GenericObjectEditorDialog dialog = new ...
 dialog.setDefaultCloseOperation(GenericObjectEditorDialog.DISPOSE_ON_CLOSE);
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow, Window.Type

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static int	APPROVE_OPTION	constant for dialog approval.
static int	CANCEL_OPTION	constant for dialog cancellation.
protected Object	m_Current	the current object.
protected PropertyEditor	m_Editor	the underlying editor.
protected int	m_Result	whether the dialog was cancelled or ok'ed.

Fields inherited from class adams.gui.core.BaseDialog

m_AfterHideActions, m_AfterShowActions, m_BeforeHideActions, m_BeforeShowActions, m_DisposeCalled, m_UISettingsApplied, m_UISettingsPrefix, m_UISettingsStored

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
GenericObjectEditorDialog(Dialog owner)	Creates a modeless dialog without a title with the specified Dialog as its owner.
GenericObjectEditorDialog(Dialog owner, Dialog.ModalityType modality)	Creates a dialog with the specified owner Dialog and modality.
GenericObjectEditorDialog(Dialog owner, String title)	Creates a modeless dialog with the specified title and with the specified owner dialog.
GenericObjectEditorDialog(Dialog owner, String title, Dialog.ModalityType modality)	Creates a dialog with the specified title, modality and the specified owner Dialog.
GenericObjectEditorDialog(Frame owner)	Creates a modeless dialog without a title with the specified Frame as its owner.
GenericObjectEditorDialog(Frame owner, boolean modal)	Creates a dialog with the specified owner Frame, modality and an empty title.
GenericObjectEditorDialog(Frame owner, String title)	Creates a modeless dialog with the specified title and with the specified owner frame.
GenericObjectEditorDialog(Frame owner, String title, boolean modal)	Creates a dialog with the specified owner Frame, modality and title.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)	Gets called when the one of the buttons in the GOE panel gets pressed.
protected void	beforeShow()	Hook method just before the dialog is made visible.
static GenericObjectEditorDialog	createDialog(Container parent)	Creates a modal dialog for the parent.
static GenericObjectEditorDialog	createDialog(Container parent, PropertyEditor editor)	Creates a modal dialog for the parent with the provided editor.
static GenericObjectEditorDialog	createDialog(Container parent, PropertyEditor editor, Object value)	Creates a modal dialog for the parent with the provided editor and initial value.
protected void	fixSize()	Ensures that the dialog doesn't get too big.
Object	getCurrent()	Returns the current object.
PropertyEditor	getEditor()	Returns the underlying editor.
GenericObjectEditor	getGOEEditor()	Returns the underlying GOE editor.
Class[]	getProposedClasses()	Returns the proposed classes (in case the editor is a GenericObjectEditor).
int	getResult()	Returns whether the dialog got cancelled or approved.
int	getResultType()	Returns whether the dialog got cancelled or approved.
Undo	getUndo()	Returns the current undo manager, can be null.
UserMode	getUserMode()	Returns the user mode.
protected void	initGUI()	For initializing the GUI.
protected void	initialize()	For initializing members.
boolean	isGOEEditor()	Returns whether the underlying editor is GenericObjectEditor.
boolean	isUndoSupported()	Returns whether an Undo manager is currently available.
static void	main(String[] args)	For testing only.
void	setCurrent(Object value)	Sets the current object.
void	setEditor(PropertyEditor value)	Sets the editor to use.
void	setProposedClasses(Class[] value)	Sets the proposed classes (in case the editor is a GenericObjectEditor).
void	setProposedClasses(Object[] value)	Sets the proposed classes based on the provided objects (in case the editor is a GenericObjectEditor).
void	setUndo(Undo value)	Sets the undo manager to use, can be null if no undo-support wanted.
void	setUserMode(UserMode value)	Sets the user mode.

Methods inherited from class adams.gui.core.BaseDialog

addAfterHideAction, addAfterShowAction, addBeforeHideAction, addBeforeShowAction, afterHide, afterShow, applyUISettings, beforeHide, dispose, executeAfterHideActions, executeAfterShowActions, executeBeforeHideActions, executeBeforeShowActions, finishInit, getUISettingsApplied, getUISettingsPrefix, pack, removeAfterHideAction, removeAfterShowAction, removeBeforeHideAction, removeBeforeShowAction, setLocationRelativeTo, setUISettingsPrefix, setUISettingsPrefix, setVisible, storeUISettings

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

CANCEL_OPTION

public static final int CANCEL_OPTION

constant for dialog cancellation.

See Also:

Constant Field Values

APPROVE_OPTION

public static final int APPROVE_OPTION

constant for dialog approval.

See Also:

Constant Field Values

m_Editor

protected PropertyEditor m_Editor

the underlying editor.

m_Current

protected Object m_Current

the current object.

m_Result

protected int m_Result

whether the dialog was cancelled or ok'ed.

Constructor Detail

GenericObjectEditorDialog

public GenericObjectEditorDialog(Dialog owner)

Creates a modeless dialog without a title with the specified Dialog as its owner.

Parameters:

owner - the owning dialog

GenericObjectEditorDialog

public GenericObjectEditorDialog(Dialog owner,
                                 Dialog.ModalityType modality)

Creates a dialog with the specified owner Dialog and modality.

Parameters:

owner - the owning dialog

modality - the type of modality

GenericObjectEditorDialog

public GenericObjectEditorDialog(Dialog owner,
                                 String title)

Creates a modeless dialog with the specified title and with the specified owner dialog.

Parameters:

owner - the owning dialog

title - the title of the dialog

GenericObjectEditorDialog

public GenericObjectEditorDialog(Dialog owner,
                                 String title,
                                 Dialog.ModalityType modality)

Creates a dialog with the specified title, modality and the specified owner Dialog.

Parameters:

owner - the owning dialog

title - the title of the dialog

modality - the type of modality

GenericObjectEditorDialog

public GenericObjectEditorDialog(Frame owner)

Creates a modeless dialog without a title with the specified Frame as its owner.

Parameters:

owner - the owning frame

GenericObjectEditorDialog

public GenericObjectEditorDialog(Frame owner,
                                 boolean modal)

Creates a dialog with the specified owner Frame, modality and an empty title.

Parameters:

owner - the owning frame

modal - whether the dialog is modal or not

GenericObjectEditorDialog

public GenericObjectEditorDialog(Frame owner,
                                 String title)

Creates a modeless dialog with the specified title and with the specified owner frame.

Parameters:

owner - the owning frame

title - the title of the dialog

GenericObjectEditorDialog

public GenericObjectEditorDialog(Frame owner,
                                 String title,
                                 boolean modal)

Creates a dialog with the specified owner Frame, modality and title.

Parameters:

owner - the owning frame

title - the title of the dialog

modal - whether the dialog is modal or not

Method Detail

initialize

protected void initialize()

For initializing members.

Overrides:

initialize in class BaseDialog

initGUI

protected void initGUI()

For initializing the GUI.

Overrides:

initGUI in class BaseDialog

setEditor

public void setEditor(PropertyEditor value)

Sets the editor to use.

Parameters:

value - the editor to use

fixSize

protected void fixSize()

Ensures that the dialog doesn't get too big.

getEditor

public PropertyEditor getEditor()

Returns the underlying editor.

Returns:

the editor in use

isGOEEditor

public boolean isGOEEditor()

Returns whether the underlying editor is GenericObjectEditor.

Returns:

true if editor is a GenericObjectEditor one

getGOEEditor

public GenericObjectEditor getGOEEditor()

Returns the underlying GOE editor.

Returns:

the GOE editor in use, or null if other editor used

beforeShow

protected void beforeShow()

Hook method just before the dialog is made visible.

Overrides:

beforeShow in class BaseDialog

setCurrent

public void setCurrent(Object value)

Sets the current object.

Parameters:

value - the current object, use null for default object

getCurrent

public Object getCurrent()

Returns the current object.

Returns:

the current object

setProposedClasses

public void setProposedClasses(Object[] value)

Sets the proposed classes based on the provided objects (in case the editor is a GenericObjectEditor).

Parameters:

value - the proposed objects

See Also:

setProposedClasses(Class[])

setProposedClasses

public void setProposedClasses(Class[] value)

Sets the proposed classes (in case the editor is a GenericObjectEditor). This call needs to happen before calling setValue(Object).

Parameters:

value - the proposed classes

getProposedClasses

public Class[] getProposedClasses()

Returns the proposed classes (in case the editor is a GenericObjectEditor). This call needs to happen before calling setValue(Object).

Returns:

the proposed classes

getResult

public int getResult()

Returns whether the dialog got cancelled or approved.

Returns:

the result

See Also:

APPROVE_OPTION, CANCEL_OPTION

getResultType

public int getResultType()

Returns whether the dialog got cancelled or approved.

Returns:

the result

See Also:

APPROVE_OPTION, CANCEL_OPTION

setUserMode

public void setUserMode(UserMode value)

Sets the user mode.

Specified by:

setUserMode in interface UserModeSupporter

Parameters:

value - the mode

getUserMode

public UserMode getUserMode()

Returns the user mode.

Specified by:

getUserMode in interface UserModeSupporter

Returns:

the mode

actionPerformed

public void actionPerformed(ActionEvent e)

Gets called when the one of the buttons in the GOE panel gets pressed.

Specified by:

actionPerformed in interface ActionListener

Parameters:

e - the event

createDialog

public static GenericObjectEditorDialog createDialog(Container parent)

Creates a modal dialog for the parent.

Parameters:

parent - the parent to make the dialog modal

Returns:

the dialog

createDialog

public static GenericObjectEditorDialog createDialog(Container parent,
                                                     PropertyEditor editor)

Creates a modal dialog for the parent with the provided editor.

Parameters:

parent - the parent to make the dialog modal

editor - the editor to use

Returns:

the dialog

createDialog

public static GenericObjectEditorDialog createDialog(Container parent,
                                                     PropertyEditor editor,
                                                     Object value)

Creates a modal dialog for the parent with the provided editor and initial value.

Parameters:

parent - the parent to make the dialog modal

editor - the editor to use, ignored if null

value - the value to use, ignored if null

Returns:

the dialog

setUndo

public void setUndo(Undo value)

Sets the undo manager to use, can be null if no undo-support wanted.

Specified by:

setUndo in interface UndoHandler

Parameters:

value - the undo manager to use

getUndo

public Undo getUndo()

Returns the current undo manager, can be null.

Specified by:

getUndo in interface UndoHandler

Returns:

the undo manager, if any

isUndoSupported

public boolean isUndoSupported()

Returns whether an Undo manager is currently available.

Specified by:

isUndoSupported in interface UndoHandler

Returns:

true if an undo manager is set

main

public static void main(String[] args)

For testing only.

Parameters:

args - ignored