repicea.simulation.treelogger

Class TreeLoggerParametersDialog<P extends LogCategory>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

repicea.gui.REpiceaDialog

repicea.simulation.treelogger.TreeLoggerParametersDialog<P>

Type Parameters:

P - a TreeLogCategory-extended class

All Implemented Interfaces:

java.awt.event.ActionListener, 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, OwnedWindow, Refreshable, REpiceaEventFireComponent, REpiceaWindow, Resettable, SynchronizedListening, IOUserInterface

Direct Known Subclasses:

BasicTreeLoggerParametersDialog, DiameterBasedTreeLoggerParametersDialog

public abstract class TreeLoggerParametersDialog<P extends LogCategory>
extends REpiceaDialog
implements javax.swing.event.ListSelectionListener, java.awt.event.ActionListener, OwnedWindow, IOUserInterface, Resettable

The TreeLoggerParametersDialog is the abstract dialog that enables the specification of the different log grades or log categories. This class makes it possible to add or remove species and log grades. The control over this feature can be overriden in derived class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TreeLoggerParametersDialog.CustomJList
static class	TreeLoggerParametersDialog.MessageID This enum variable contains the different messages displayed by the TreeLoggerParametersDialog classes.

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
protected javax.swing.JButton	cancel
protected javax.swing.JPanel	controlPanel
protected javax.swing.JMenuItem	help
protected TreeLoggerParametersDialog.CustomJList	logCategoryList
protected javax.swing.JButton	logGradeGoDown
protected javax.swing.JButton	logGradeGoUp
protected boolean	logGradePriorityChangeEnabled
protected javax.swing.JMenu	mnEdit
protected javax.swing.JMenu	mnFile
protected javax.swing.JMenu	mnHelp
protected javax.swing.JMenu	mnLogGrade
protected javax.swing.JMenu	mnSpecies
protected javax.swing.JMenu	mnTools
protected javax.swing.JButton	ok
protected javax.swing.JPanel	panLogCategory
protected TreeLoggerParameters<P>	params
protected TreeLoggerParametersDialog.CustomJList	speciesList
protected WindowSettings	windowSettings

Fields inherited from class repicea.gui.REpiceaDialog

askUserBeforeExit, cancelOnClose

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

Modifier	Constructor and Description
protected	TreeLoggerParametersDialog(java.awt.Window window, TreeLoggerParameters<P> params) Constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent arg0)
void	cancelAction()
void	doNotListenToAnymore() This method remove the listeners.
protected javax.swing.JPanel	getControlPanel()
protected TreeLoggerParameters<P>	getTreeLoggerParameters()
Memorizable	getWindowOwner() This method returns the owner of this window which should implement the Memorizable interface
WindowSettings	getWindowSettings() This method returns the SettingMemory instance of the object if any.
protected void	initUI() This method creates the UI, i.e.
protected void	instantiateVariables(TreeLoggerParameters<P> params)
void	listenTo() This method specifies who is listening to whom.
void	okAction()
void	postLoadingAction() This method performs a particular action immediately after the parameters have been loaded.
void	postSavingAction() This method performs a particular action immediately after the parameters have been saved.
protected java.util.List<java.lang.Object>	provideSpeciesInNaturalOrder()
protected void	redefineSpeciesList()
void	reset() This method reinitializes some fields of the instance that implements this interface.
protected void	setMenuBar()
protected abstract void	settingsAction()
protected void	speciesAddAction() The basic implementation of this method assumes that the species are designated by String instance.
void	synchronizeUIWithOwner() This method ensures that the values of the components are those of the owner.
protected void	undoAction()
void	valueChanged(javax.swing.event.ListSelectionEvent evt)

Methods inherited from class repicea.gui.REpiceaDialog

askUserBeforeExit, firePropertyChange, getBufferedImage, helpAction, isCancelOnClose, refreshInterface, setCancelOnClose, setIcon, setVisible

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, 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

Methods inherited from interface repicea.gui.REpiceaWindow

askUserBeforeExit, isCancelOnClose, setTitle, setVisible

Methods inherited from interface repicea.gui.REpiceaEventFireComponent

firePropertyChange

Field Detail

params

protected TreeLoggerParameters<P extends LogCategory> params

panLogCategory

protected javax.swing.JPanel panLogCategory

logCategoryList

protected TreeLoggerParametersDialog.CustomJList logCategoryList

speciesList

protected TreeLoggerParametersDialog.CustomJList speciesList

ok

protected javax.swing.JButton ok

cancel

protected javax.swing.JButton cancel

mnFile

protected javax.swing.JMenu mnFile

mnEdit

protected javax.swing.JMenu mnEdit

mnSpecies

protected javax.swing.JMenu mnSpecies

mnLogGrade

protected javax.swing.JMenu mnLogGrade

mnTools

protected javax.swing.JMenu mnTools

mnHelp

protected javax.swing.JMenu mnHelp

help

protected javax.swing.JMenuItem help

logGradeGoUp

protected javax.swing.JButton logGradeGoUp

logGradeGoDown

protected javax.swing.JButton logGradeGoDown

controlPanel

protected javax.swing.JPanel controlPanel

logGradePriorityChangeEnabled

protected boolean logGradePriorityChangeEnabled

windowSettings

protected final WindowSettings windowSettings

Constructor Detail

TreeLoggerParametersDialog

protected TreeLoggerParametersDialog(java.awt.Window window,
                                     TreeLoggerParameters<P> params)

Constructor. To be called by derived classes.

Parameters:

window - the parent window

params - a TreeLoggerParameters instance

Method Detail

instantiateVariables

protected void instantiateVariables(TreeLoggerParameters<P> params)

okAction

public void okAction()

Specified by:

okAction in interface REpiceaWindow

Overrides:

okAction in class REpiceaDialog

getControlPanel

protected javax.swing.JPanel getControlPanel()

provideSpeciesInNaturalOrder

protected java.util.List<java.lang.Object> provideSpeciesInNaturalOrder()

redefineSpeciesList

protected final void redefineSpeciesList()

initUI

protected void initUI()

Description copied from class: REpiceaDialog

This method creates the UI, i.e. it puts the components at their proper location and so on. The components should have be previously instantiated.

Specified by:

initUI in class REpiceaDialog

setMenuBar

protected void setMenuBar()

valueChanged

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

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener

undoAction

protected void undoAction()

reset

public void reset()

Description copied from interface: Resettable

This method reinitializes some fields of the instance that implements this interface.

Specified by:

reset in interface Resettable

cancelAction

public void cancelAction()

Specified by:

cancelAction in interface REpiceaWindow

Overrides:

cancelAction in class REpiceaDialog

listenTo

public void listenTo()

Description copied from interface: SynchronizedListening

This method specifies who is listening to whom. It should be called just before the component is set to visible.

Specified by:

listenTo in interface SynchronizedListening

doNotListenToAnymore

public void doNotListenToAnymore()

Description copied from interface: SynchronizedListening

This method remove the listeners. It should be consistent with the listenTo method. It should be called just after calling the component is set to visible(false).

Specified by:

doNotListenToAnymore in interface SynchronizedListening

actionPerformed

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

Specified by:

actionPerformed in interface java.awt.event.ActionListener

settingsAction

protected abstract void settingsAction()

postLoadingAction

public void postLoadingAction()

Description copied from interface: IOUserInterface

This method performs a particular action immediately after the parameters have been loaded.

Specified by:

postLoadingAction in interface IOUserInterface

postSavingAction

public void postSavingAction()

Description copied from interface: IOUserInterface

This method performs a particular action immediately after the parameters have been saved.

Specified by:

postSavingAction in interface IOUserInterface

getWindowSettings

public WindowSettings getWindowSettings()

Description copied from interface: IOUserInterface

This method returns the SettingMemory instance of the object if any. It can be null.

Specified by:

getWindowSettings in interface IOUserInterface

Returns:

a Settings instance

speciesAddAction

protected void speciesAddAction()

The basic implementation of this method assumes that the species are designated by String instance.

getWindowOwner

public Memorizable getWindowOwner()

Description copied from interface: OwnedWindow

This method returns the owner of this window which should implement the Memorizable interface

Specified by:

getWindowOwner in interface OwnedWindow

Returns:

a Memorizable instance

getTreeLoggerParameters

protected TreeLoggerParameters<P> getTreeLoggerParameters()

synchronizeUIWithOwner

public void synchronizeUIWithOwner()

Description copied from interface: OwnedWindow

This method ensures that the values of the components are those of the owner. For instance, if the owner is somehow changed after resetting, this method should be called.

Specified by:

synchronizeUIWithOwner in interface OwnedWindow