org.trianacode.gui.windows

Class ParameterWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.trianacode.gui.windows.ParameterWindow

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.ContainerListener, java.awt.event.ItemListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, ParameterWindowInterface

Direct Known Subclasses:

ScrollerWindow

public class ParameterWindow
extends javax.swing.JDialog
implements java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.event.ContainerListener, ParameterWindowInterface

ParamaterWindow in Version 3 of Triana is a simple window for containing ParameterPanels. It inherits from JDialog and provides default buttons for OK, CANCEL & APPLY.

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 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
ParameterWindow() Deprecated.
ParameterWindow(byte buttons) Constructs a window with the specified button set
ParameterWindow(java.awt.Component parent, byte buttons, boolean modal) Constructs a window with the specified button set and the specified modal status

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Invoked when an action occurs i.e.
void	addParameterWindowListener(ParameterWindowListener listener) Adds a listener to be notified when the window is hidden
void	closeWindow() Close the window
void	componentAdded(java.awt.event.ContainerEvent e)
void	componentRemoved(java.awt.event.ContainerEvent e)
void	dispose()
static java.awt.Frame	getFrame(java.awt.Component comp)
ParameterPanel	getParameterPanel()
java.awt.Window	getWindow()
boolean	isAccepted()
boolean	isAutoCommit()
boolean	isAutoCommitVisible()
boolean	isAutoDispose()
void	itemStateChanged(java.awt.event.ItemEvent event) Calls apply clicked on the parameter panel when auto commit is selected
void	removeParameterWindowListener(ParameterWindowListener listener) Removes a listener from this window
void	setAutoCommit(boolean state) Sets whether the panel is auto commit
void	setAutoCommitVisible(boolean state) Sets whether auto commit is visible
void	setAutoDispose(boolean state) Sets whether the panel is automatically disposed when ok/canel are chosen (true by default)
void	setParameterPanel(ParameterPanel paramPanel) Sets the targets for this ParameterWindow to the particular task which has the following parameter panel (i.e.
void	setVisible(boolean state) Resets the accepted flag.
void	showHelp()

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

Constructor Detail

ParameterWindow

public ParameterWindow()

Deprecated.

Default constructor

ParameterWindow

public ParameterWindow(byte buttons)

Constructs a window with the specified button set

ParameterWindow

public ParameterWindow(java.awt.Component parent,
               byte buttons,
               boolean modal)

Constructs a window with the specified button set and the specified modal status

Method Detail

getFrame

public static java.awt.Frame getFrame(java.awt.Component comp)

addParameterWindowListener

public void addParameterWindowListener(ParameterWindowListener listener)

Adds a listener to be notified when the window is hidden

removeParameterWindowListener

public void removeParameterWindowListener(ParameterWindowListener listener)

Removes a listener from this window

setParameterPanel

public void setParameterPanel(ParameterPanel paramPanel)

Sets the targets for this ParameterWindow to the particular task which has the following parameter panel (i.e. the Customizer) and which displays a default title on the top of the window. This function also creates the relevant menu items relevant to UnitPanelWindows and lays out the window by putting the customizing panel in the window with an OK on the bottom.

getParameterPanel

public ParameterPanel getParameterPanel()

Returns:

the parameter panel contained in this window

isAutoCommit

public boolean isAutoCommit()

Specified by:

isAutoCommit in interface ParameterWindowInterface

Returns:

true if the parameter panel is to automatically commit parameter changes

setAutoCommit

public void setAutoCommit(boolean state)

Sets whether the panel is auto commit

isAutoCommitVisible

public boolean isAutoCommitVisible()

Returns:

true if auto commit is visible

setAutoCommitVisible

public void setAutoCommitVisible(boolean state)

Sets whether auto commit is visible

isAutoDispose

public boolean isAutoDispose()

Returns:

true if the panel is automatically disposed when ok/canel are chosen (true by default)

setAutoDispose

public void setAutoDispose(boolean state)

Sets whether the panel is automatically disposed when ok/canel are chosen (true by default)

getWindow

public java.awt.Window getWindow()

Specified by:

getWindow in interface ParameterWindowInterface

Returns:

the window (Frame/Dialog) for the panel

closeWindow

public void closeWindow()

Close the window

Specified by:

closeWindow in interface ParameterWindowInterface

isAccepted

public boolean isAccepted()

Returns:

true if the ok button was pressed

showHelp

public void showHelp()

setVisible

public void setVisible(boolean state)

Resets the accepted flag.

Overrides:

setVisible in class java.awt.Dialog

actionPerformed

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

Invoked when an action occurs i.e. either a help or a OldUnit Properties menu option may have been chosen.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent event)

Calls apply clicked on the parameter panel when auto commit is selected

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

componentAdded

public void componentAdded(java.awt.event.ContainerEvent e)

Specified by:

componentAdded in interface java.awt.event.ContainerListener

componentRemoved

public void componentRemoved(java.awt.event.ContainerEvent e)

Specified by:

componentRemoved in interface java.awt.event.ContainerListener

dispose

public void dispose()

Overrides:

dispose in class java.awt.Window