Package adams.gui.visualization.container

Class FilterDialog<T extends DataContainer>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

adams.gui.core.BaseDialog

adams.gui.visualization.container.FilterDialog<T>

Type Parameters:

T - the type of data the filters handle

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class FilterDialog<T extends DataContainer>
extends BaseDialog

A dialog that lets the user select a filter and also choose whether to overlay the original data or not.

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 BaseButton	m_ButtonCancel	the Cancel button.
protected BaseButton	m_ButtonOK	the OK button.
protected BaseCheckBox	m_CheckboxOverlay	the checkbox for whether the filtered data is to be overlayed over the original data.
protected Filter<T>	m_CurrentFilter	the current filter.
protected FilterListener	m_FilterListener	the listener.
protected GenericObjectEditorPanel	m_PanelFilter	the panel with the filter.

Fields inherited from class adams.gui.core.BaseDialog

m_AfterHideActions, m_AfterShowActions, m_BeforeHideActions, m_BeforeShowActions, m_DisposeCalled, m_LocationBeforeMaximize, m_SizeBeforeMaximize, 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
FilterDialog(Dialog owner)	Creates a modeless dialog without a title with the specified Dialog as its owner.
FilterDialog(Frame owner)	Creates a modeless dialog without a title with the specified Frame as its owner.

Method Summary

Modifier and Type	Method	Description
protected void	beforeShow()	Hook method just before the dialog is made visible.
protected GenericObjectEditorPanel	createGOEPanel()	Creates the GenericObjectEditor panel to use.
protected Filter<T>	getDefaultFilter()	Returns the default filter.
Filter<T>	getFilter()	Returns the current filter.
FilterListener	getFilterListener()	Returns the listener to use.
boolean	getOverlayOriginalData()	Returns whether the filtered data is to be overlayed with the original data.
protected void	initGUI()	For initializing the GUI.
protected void	initialize()	For initializing members.
void	setFilter(Filter<T> value)	Sets the filter to use.
void	setFilterListener(FilterListener value)	Sets the listener to use.
void	setOverlayOriginalData(boolean value)	Sets whether to overlay the filtered data with the original data.

Methods inherited from class adams.gui.core.BaseDialog

addAfterHideAction, addAfterShowAction, addBeforeHideAction, addBeforeShowAction, afterHide, afterShow, applyUISettings, beforeHide, canMaximize, canMinimize, dispose, executeAfterHideActions, executeAfterShowActions, executeBeforeHideActions, executeBeforeShowActions, finishInit, getUISettingsApplied, getUISettingsPrefix, maximize, minimize, 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_CurrentFilter

protected Filter<T extends DataContainer> m_CurrentFilter

the current filter.

m_PanelFilter

protected GenericObjectEditorPanel m_PanelFilter

the panel with the filter.

m_ButtonOK

protected BaseButton m_ButtonOK

the OK button.

m_ButtonCancel

protected BaseButton m_ButtonCancel

the Cancel button.

m_CheckboxOverlay

protected BaseCheckBox m_CheckboxOverlay

the checkbox for whether the filtered data is to be overlayed over the original data.

m_FilterListener

protected FilterListener m_FilterListener

the listener.

Constructor Detail

FilterDialog

public FilterDialog(Dialog owner)

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

Parameters:

owner - the owning dialog

FilterDialog

public FilterDialog(Frame owner)

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

Parameters:

owner - the owning frame

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

getDefaultFilter

protected Filter<T> getDefaultFilter()

Returns the default filter.

Returns:

the filter

createGOEPanel

protected GenericObjectEditorPanel createGOEPanel()

Creates the GenericObjectEditor panel to use.

Returns:

the panel

setFilter

public void setFilter(Filter<T> value)

Sets the filter to use.

Parameters:

value - the filter

getFilter

public Filter<T> getFilter()

Returns the current filter.

Returns:

the filter

setOverlayOriginalData

public void setOverlayOriginalData(boolean value)

Sets whether to overlay the filtered data with the original data.

Parameters:

value - if true then the data will be overlayed

getOverlayOriginalData

public boolean getOverlayOriginalData()

Returns whether the filtered data is to be overlayed with the original data.

Returns:

true if data should be overlayed

setFilterListener

public void setFilterListener(FilterListener value)

Sets the listener to use.

Parameters:

value - the listener

getFilterListener

public FilterListener getFilterListener()

Returns the listener to use.

Returns:

the listener

beforeShow

protected void beforeShow()

Hook method just before the dialog is made visible.

Overrides:

beforeShow in class BaseDialog