ice.ri.common.dialog.awt
Class AbstractSettingsDialogPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Panel
              ice.ri.common.dialog.awt.AbstractSettingsDialogPanel

All Implemented Interfaces:

Accessible, ActionListener, EventListener, ImageObserver, MenuContainer, Serializable, SettingsDialogInterface

Direct Known Subclasses:

PageSetupDialog.AdvancedPageSettingsPanel, PageSetupDialog.PageSettingsPanel

public abstract class AbstractSettingsDialogPanel

extends Panel

implements SettingsDialogInterface, ActionListener

An implementation of the SettingsDialogInterface to serve as a basis for implementing various kinds of display panels for setting dialogs. A panel has a name which describes the panels GUI elements. A AbstractSettingsDialogPanel can be added individually or can be grouped using a SettingsDialogPanelGroup and added to a class that implements AbstractSettingsDialog.

Since:

6.0

Version:

%I%, %G%

Author:

Patrick Corless

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.awt.Panel

Panel.AccessibleAWTPanel

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected AbstractSettingsDialog

settingsDialog

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

Constructor Summary

AbstractSettingsDialogPanel(String title, AbstractSettingsDialog settingsDialog)
Create an AbstractSettingsDialogPanel object.

Method Summary

abstract boolean	cancel() Do not save the data represented by the GUI.
boolean	hasChanged() Return the state of the change flag.
abstract boolean	save() Save the data represented by the GUI.
void	setHasChanged(boolean value) Sets the change flag.
String	toString() Return the name of the panel.

Methods inherited from class java.awt.Panel

addNotify, getAccessibleContext

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Field Detail

settingsDialog

protected AbstractSettingsDialog settingsDialog

Constructor Detail

AbstractSettingsDialogPanel

public AbstractSettingsDialogPanel(String title,
                                   AbstractSettingsDialog settingsDialog)

Create an AbstractSettingsDialogPanel object.

Parameters:

title - - title used to the describe the panel

settingsDialog - parent settings dialog

Method Detail

setHasChanged

public void setHasChanged(boolean value)

Sets the change flag. If the true the data represented by GUI has changed. If false the the data has not been changed from the last saved state.

Parameters:

value - true if the state has changed, false otherwise.

hasChanged

public boolean hasChanged()

Return the state of the change flag.

Returns:

true if the state has changed, false otherwise

toString

public String toString()

Return the name of the panel.

Returns:

name of the panel

save

public abstract boolean save()

Save the data represented by the GUI.

Specified by:

save in interface SettingsDialogInterface

Returns:

cancel

public abstract boolean cancel()

Do not save the data represented by the GUI.

Specified by:

cancel in interface SettingsDialogInterface

Returns: