us.daveread.basicquery

Class ReorderDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

us.daveread.basicquery.ReorderDialog

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ListSelectionListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ReorderDialog
extends javax.swing.JDialog
implements java.awt.event.ActionListener, java.awt.event.WindowListener, javax.swing.event.ListSelectionListener

Title: ReorderDialog

Description: Display list of objects and allow them to be reordered.

Copyright: Copyright (c) 2004-2014, David Read

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Author:

David Read

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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
private javax.swing.JButton	cancel Cancel the dialog (ignoring any changes made)
private javax.swing.JButton	close Close the dialog (accepting any changes made)
private boolean	didReorder Detect if the order of the object was changed by the user
private javax.swing.JButton	down Move the selected item down
private static org.apache.log4j.Logger	LOGGER Logger
private static int	MAXIMUM_ROWS_TO_DISPLAY Maximum row height of the list display
private java.util.List<java.lang.Object>	ordered List of objects the user can reorder
private javax.swing.JList	reordered The reordered list of objects
private ReorderListModel<java.lang.Object>	reorderedModel The model backing the reorderable list display
private static long	serialVersionUID Serial UID for the class
private javax.swing.JButton	up Move the selected item up

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 javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ReorderDialog(javax.swing.JFrame parent, java.util.List<java.lang.Object> objects) Constructs the JDialog as a modal dialog and sets-up the components.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent evt) Depending on which option the user has invoked the appropriate action is performed
private void	cancelDialog() User canceled changes.
private void	closeDialog() User requested that the dialog be closed.
java.util.List<java.lang.Object>	getAsOrdered() Get the list that backs the model.
boolean	isReordered() Return whether or not the list was reordered from its original state.
private void	moveDown() Move the selected entry down one position (move to higher index value) which in the GUI will result in the selected line moving down one line vertically.
private void	moveUp() Move the selected entry up one position (move to lower index value) which in the GUI will result in the selected line moving up one line vertically.
private void	setup() Setup the GUI components.
void	valueChanged(javax.swing.event.ListSelectionEvent evt)
void	windowActivated(java.awt.event.WindowEvent evt)
void	windowClosed(java.awt.event.WindowEvent evt)
void	windowClosing(java.awt.event.WindowEvent evt)
void	windowDeactivated(java.awt.event.WindowEvent evt)
void	windowDeiconified(java.awt.event.WindowEvent evt)
void	windowIconified(java.awt.event.WindowEvent evt)
void	windowOpened(java.awt.event.WindowEvent evt)

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, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, 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, setLocationRelativeTo, 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, getPeer, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, 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

serialVersionUID

private static final long serialVersionUID

Serial UID for the class

See Also:

Constant Field Values

LOGGER

private static final org.apache.log4j.Logger LOGGER

Logger

MAXIMUM_ROWS_TO_DISPLAY

private static final int MAXIMUM_ROWS_TO_DISPLAY

Maximum row height of the list display

See Also:

Constant Field Values

ordered

private java.util.List<java.lang.Object> ordered

List of objects the user can reorder

didReorder

private boolean didReorder

Detect if the order of the object was changed by the user

up

private javax.swing.JButton up

Move the selected item up

down

private javax.swing.JButton down

Move the selected item down

close

private javax.swing.JButton close

Close the dialog (accepting any changes made)

cancel

private javax.swing.JButton cancel

Cancel the dialog (ignoring any changes made)

reordered

private javax.swing.JList reordered

The reordered list of objects

reorderedModel

private ReorderListModel<java.lang.Object> reorderedModel

The model backing the reorderable list display

Constructor Detail

ReorderDialog

public ReorderDialog(javax.swing.JFrame parent,
             java.util.List<java.lang.Object> objects)

Constructs the JDialog as a modal dialog and sets-up the components. Finally it makes itself visible.

Parameters:

parent - JFrame The parent JFrame that owns this dialog.

objects - List The list of data to be presented in the list.

Method Detail

setup

private void setup()

Setup the GUI components.

cancelDialog

private void cancelDialog()

User canceled changes. This method clears the reorder boolean and disposes of the dialog.

closeDialog

private void closeDialog()

User requested that the dialog be closed. The current list, which may or may not be reordered from its original state, is obtrained from the model and the dialog is closed.

moveUp

private void moveUp()

Move the selected entry up one position (move to lower index value) which in the GUI will result in the selected line moving up one line vertically.

moveDown

private void moveDown()

Move the selected entry down one position (move to higher index value) which in the GUI will result in the selected line moving down one line vertically.

getAsOrdered

public java.util.List<java.lang.Object> getAsOrdered()

Get the list that backs the model.

Returns:

List The list which may have been reordered.

isReordered

public boolean isReordered()

Return whether or not the list was reordered from its original state.

Returns:

boolean Whether the list was reordered.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent evt)

Depending on which option the user has invoked the appropriate action is performed

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

evt - Specifies the action event that has taken place

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent evt)

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener

windowActivated

public void windowActivated(java.awt.event.WindowEvent evt)

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent evt)

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowClosing

public void windowClosing(java.awt.event.WindowEvent evt)

Specified by:

windowClosing in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent evt)

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent evt)

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent evt)

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowOpened

public void windowOpened(java.awt.event.WindowEvent evt)

Specified by:

windowOpened in interface java.awt.event.WindowListener