Package adams.gui.dialog

Class AbstractReplaceDialog<T>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

adams.gui.core.BaseDialog

adams.gui.dialog.DialogWithButtons

adams.gui.dialog.ApprovalDialog

adams.gui.dialog.AbstractReplaceDialog<T>

Type Parameters:

T - the type of object to handle

All Implemented Interfaces:

CleanUpHandler, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

ReplaceFieldDialog

public abstract class AbstractReplaceDialog<T>
extends ApprovalDialog
implements CleanUpHandler

A dialog that allows the user to select a field to find and replace with another one.

Version:

$Revision$

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
protected BaseCheckBox	m_CheckBoxRecursive	the recursive checkbox.
protected JLabel	m_LabelRecursive	the recursive label.

Fields inherited from class adams.gui.dialog.ApprovalDialog

APPROVE_OPTION, CANCEL_OPTION, DISCARD_OPTION, m_ButtonApprove, m_ButtonCancel, m_ButtonDiscard, m_Option

Fields inherited from class adams.gui.dialog.DialogWithButtons

m_PanelButtons, m_PanelButtonsLeft, m_PanelButtonsRight

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

Modifier	Constructor	Description
protected	AbstractReplaceDialog(Dialog owner)	Creates a modal dialog without a title with the specified Dialog as its owner.
protected	AbstractReplaceDialog(Frame owner)	Creates a modal dialog without a title with the specified Frame as its owner.

Method Summary

Modifier and Type	Method	Description
protected abstract void	adjustLabels()	Method for adjusting the label sizes.
protected void	beforeHide()	Hook method just before the dialog is hidden.
void	cleanUp()	Cleans up data structures, frees up memory.
protected abstract String	getDefaultTitle()	Returns the title of the dialog.
abstract T	getFind()	Returns the currently set object to look for.
abstract T	getReplace()	Returns the currently set object to replace with.
protected void	initGUI()	Initializes the widgets.
boolean	isRecursive()	Returns whether the replace is to be recursive.
abstract void	setFind(T value)	Sets the object to find.
void	setRecursive(boolean value)	Sets the recursive state.
abstract void	setReplace(T value)	Sets the object to replace with.
protected abstract JPanel	setupPanel()	Creates and returns the panel that is placed in the CENTER, containing the find and replace fields.

Methods inherited from class adams.gui.dialog.ApprovalDialog

approveDialog, beforeShow, cancelDialog, checkInput, discardDialog, getApproveButton, getApproveCaption, getApproveMnemonic, getCancelButton, getCancelCaption, getCancelMnemonic, getConfirmationDialog, getConfirmationDialog, getConfirmationDialog, getConfirmationDialog, getDialog, getDialog, getDialog, getDialog, getDiscardButton, getDiscardCaption, getDiscardMnemonic, getInformationDialog, getInformationDialog, getInformationDialog, getInformationDialog, getOption, initialize, isApproveEnabled, isApproveVisible, isCancelEnabled, isCancelVisible, isDiscardEnabled, isDiscardVisible, setApproveCaption, setApproveEnabled, setApproveMnemonic, setApproveVisible, setCancelCaption, setCancelEnabled, setCancelMnemonic, setCancelVisible, setDiscardCaption, setDiscardEnabled, setDiscardMnemonic, setDiscardVisible

Methods inherited from class adams.gui.dialog.DialogWithButtons

getButtonsPanel, getButtonsPanel

Methods inherited from class adams.gui.core.BaseDialog

addAfterHideAction, addAfterShowAction, addBeforeHideAction, addBeforeShowAction, afterHide, afterShow, applyUISettings, 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

m_LabelRecursive

protected JLabel m_LabelRecursive

the recursive label.

m_CheckBoxRecursive

protected BaseCheckBox m_CheckBoxRecursive

the recursive checkbox.

Constructor Detail

AbstractReplaceDialog

protected AbstractReplaceDialog(Dialog owner)

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

Parameters:

owner - the owning dialog

AbstractReplaceDialog

protected AbstractReplaceDialog(Frame owner)

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

Parameters:

owner - the owning frame

Method Detail

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class ApprovalDialog

getDefaultTitle

protected abstract String getDefaultTitle()

Returns the title of the dialog.

Returns:

the title

setupPanel

protected abstract JPanel setupPanel()

Creates and returns the panel that is placed in the CENTER, containing the find and replace fields. The panel must use the GridLayout layout manager.

Returns:

the generated panel

adjustLabels

protected abstract void adjustLabels()

Method for adjusting the label sizes.

setFind

public abstract void setFind(T value)

Sets the object to find.

Parameters:

value - the object to find

getFind

public abstract T getFind()

Returns the currently set object to look for.

Returns:

the object, can be null

setReplace

public abstract void setReplace(T value)

Sets the object to replace with.

Parameters:

value - the object to replace with

getReplace

public abstract T getReplace()

Returns the currently set object to replace with.

Returns:

the object, can be null

setRecursive

public void setRecursive(boolean value)

Sets the recursive state.

Parameters:

value - if true then recursive will be ticked

isRecursive

public boolean isRecursive()

Returns whether the replace is to be recursive.

Returns:

true if recursive

beforeHide

protected void beforeHide()

Hook method just before the dialog is hidden.

Overrides:

beforeHide in class BaseDialog

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Default implementation does nothing.

Specified by:

cleanUp in interface CleanUpHandler