repicea.gui

Class REpiceaDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

repicea.gui.REpiceaDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, Refreshable, REpiceaEventFireComponent, REpiceaWindow, SynchronizedListening

Direct Known Subclasses:

BiomassParametersDialog, CancellableWarningMessage, CATScenarioComparisonDialog, CATSensitivityAnalysisSettingsDlg, CATSpeciesSelectionDialog, ExportToolDialog, GenericChooseFileDialog, ImportFieldManagerDialog, ProcessorInternalDialog, ProcessorLinkLineSlider, REpiceaExportToolDialog, REpiceaGenericShowDialog, REpiceaMatchSelectorDialog, REpiceaProgressBarDialog, REpiceaSimpleListDialog, SystemManagerDialog, TreeLoggerParametersDialog

public abstract class REpiceaDialog
extends javax.swing.JDialog
implements REpiceaWindow, Refreshable

A generic modal dialog that ensures that the method cancelAction is called when the dialog can be closed. If any action must be done when closing the dialog, the method cancelAction should be overriden in the derived class.

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
protected boolean	askUserBeforeExit
protected boolean	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	REpiceaDialog() Constructor 2 with no parent at all.
protected	REpiceaDialog(java.awt.Window parent) Constructor 1 with a Window parent.

Method Summary

Modifier and Type	Method and Description
boolean	askUserBeforeExit()
void	cancelAction()
void	firePropertyChange(REpiceaAWTProperty property, java.lang.Object obj1, java.lang.Object obj2) This method fires an event when the parameters are loaded or saved
protected java.awt.Image	getBufferedImage() This method reads the image that serves as icon for the frame.
protected void	helpAction()
protected abstract void	initUI() This method creates the UI, i.e.
boolean	isCancelOnClose()
void	okAction()
void	refreshInterface() This method refreshes the content of the Container instance that implements this interface.
protected void	setCancelOnClose(boolean bool) This method defines the action to be undertaken when the window is closed by clicking on the "x".
protected void	setIcon() This method sets the Icon of the frame.
void	setVisible(boolean bool) This method overrides the method of the super class JFrame.

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

setTitle

Methods inherited from interface repicea.gui.SynchronizedListening

doNotListenToAnymore, listenTo

Field Detail

cancelOnClose

protected boolean cancelOnClose

askUserBeforeExit

protected boolean askUserBeforeExit

Constructor Detail

REpiceaDialog

protected REpiceaDialog(java.awt.Window parent)

Constructor 1 with a Window parent.

Parameters:

parent - a Window parent (can be null if there is no parent)

REpiceaDialog

protected REpiceaDialog()

Constructor 2 with no parent at all.

Method Detail

setIcon

protected void setIcon()

This method sets the Icon of the frame.

setVisible

public void setVisible(boolean bool)

This method overrides the method of the super class JFrame. It first memorizes what should be memorized in the memorize() method and then adds or remove this instance as window listener.

Specified by:

setVisible in interface REpiceaWindow

Overrides:

setVisible in class java.awt.Dialog

getBufferedImage

protected java.awt.Image getBufferedImage()

This method reads the image that serves as icon for the frame. By default, the Rouge Epicea logo is read. Just override this method to get another icon.

Returns:

a Image instance

cancelAction

public void cancelAction()

Specified by:

cancelAction in interface REpiceaWindow

okAction

public void okAction()

Specified by:

okAction in interface REpiceaWindow

helpAction

protected final void helpAction()

setCancelOnClose

protected final void setCancelOnClose(boolean bool)

This method defines the action to be undertaken when the window is closed by clicking on the "x". If true, the action is interpreted as a cancel. If false, the action is interpreted as an ok. BY DEFAULT, the value is true.

Parameters:

bool - a boolean

initUI

protected abstract void initUI()

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.

refreshInterface

public void refreshInterface()

Description copied from interface: Refreshable

This method refreshes the content of the Container instance that implements this interface.

Specified by:

refreshInterface in interface Refreshable

firePropertyChange

public final void firePropertyChange(REpiceaAWTProperty property,
                                     java.lang.Object obj1,
                                     java.lang.Object obj2)

Description copied from interface: REpiceaEventFireComponent

This method fires an event when the parameters are loaded or saved

Specified by:

firePropertyChange in interface REpiceaEventFireComponent

Parameters:

property - a REpiceaAWTProperty enum

obj1 - the first parameter

obj2 - the second parameter

isCancelOnClose

public final boolean isCancelOnClose()

Specified by:

isCancelOnClose in interface REpiceaWindow

askUserBeforeExit

public final boolean askUserBeforeExit()

Specified by:

askUserBeforeExit in interface REpiceaWindow