com.tensegrity.gui.swing.dialog
Class FormatDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.tensegrity.gui.swing.dialog.FormatDialog

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

Direct Known Subclasses:

FontFormatDialog, MarkerFormatDialog, PaintFormatDialog, StrokeFormatDialog

public abstract class FormatDialog

extends javax.swing.JDialog

Class FormatDialog acts as a base class for all format related dialogs. The class extends a JDialog and provides a basic layout, where the format panel is placed in the center of the dialog and a button bar at the bottom of the dialog. In between this two components a panel providing a preview on the edited format is embedded.

Version:

$Id: FormatDialog.java,v 1.29 2005/09/06 15:52:23 BurkhardWick Exp $

Author:

Gilles Iachelini

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected AbstractPreview	preview Instance of the preview for this format panel dialog.
protected UIManager	uiManager The UIManager of the underlying application.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

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

FormatDialog(UIManager uiManager, java.awt.Frame owner, int type)
Creates a new FormatDialog with the given frame as owner and the a Preview based on the parameter type.

FormatDialog(UIManager uiManager, javax.swing.JDialog owner, int type)
Creates a new FormatDialog with the given dialog as owner and the a Preview based on the parameter type.

Method Summary

protected javax.swing.JPanel	createPreview(int type) Creates a wrapper Preview Panel according to the given type and wrapps it into a separate JPanel.
protected abstract AbstractFormat	getFormatPanel() Returns the Format Panel.
protected abstract AbstractFormat	getFormatPanel(javax.swing.JPanel preview) The default Format Panel ignores this call.
protected AbstractPreview	getPreview(int type) Returns the Preview according to the given type.
protected void	init(UIManager uiManager, int type) Initializes the dialog by creating the formatpanel and button bar and packing the dialog.
protected boolean	usesDefaultLayout() Subclasses must overwrite this method and return true to indicate, that they want to use the default layout (FormatPanel at NORTH, Preview in the CENTER).
protected abstract boolean	validateFormat() Called whenever the user selects the OK button.
boolean	wasCancelled() Indicates whether the dialog was cancelled or closed.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

preview

protected AbstractPreview preview

Instance of the preview for this format panel dialog.

uiManager

protected UIManager uiManager

The UIManager of the underlying application.

Constructor Detail

FormatDialog

public FormatDialog(UIManager uiManager,
                    javax.swing.JDialog owner,
                    int type)

Creates a new FormatDialog with the given dialog as owner and the a Preview based on the parameter type.

Parameters:

uiManager - The UIManager to obtain strings from.

owner - Owner of this dialog (as JDialog)

type - the type of this Dialog.

FormatDialog

public FormatDialog(UIManager uiManager,
                    java.awt.Frame owner,
                    int type)

Creates a new FormatDialog with the given frame as owner and the a Preview based on the parameter type.

Parameters:

uiManager - The UIManager to obtain strings from.

owner - Owner of this dialog (as JFrame)

type - the type of this Dialog.

Method Detail

init

protected void init(UIManager uiManager,
                    int type)

Initializes the dialog by creating the formatpanel and button bar and packing the dialog.

Parameters:

uiManager - The UIManager to obtain strings from.

type - the type of this Dialog.

wasCancelled

public boolean wasCancelled()

Indicates whether the dialog was cancelled or closed.

Returns:

boolean true, if dialog was cancelled.

getPreview

protected AbstractPreview getPreview(int type)

Returns the Preview according to the given type.

Parameters:

type - the type of preview panel you want to receive.

Returns:

instance of DefaultPreview.

See Also:

DefaultPreview.PREVIEW_FONT, DefaultPreview.PREVIEW_STROKE, DefaultPreview.PREVIEW_PAINT

getFormatPanel

protected abstract AbstractFormat getFormatPanel()

Returns the Format Panel. Must be overwritten by subclasses to provide such a panel.

Returns:

Panel the Format Panel.

getFormatPanel

protected abstract AbstractFormat getFormatPanel(javax.swing.JPanel preview)

The default Format Panel ignores this call. Subclasses, which want to layout the preview on their own must return the formatpanel combined with the preview here.

Parameters:

preview - the Preview wrapped into a JPanel.

Returns:

the FormatPanel with the Preview.

usesDefaultLayout

protected boolean usesDefaultLayout()

Subclasses must overwrite this method and return true to indicate, that they want to use the default layout (FormatPanel at NORTH, Preview in the CENTER). If a FormatPanel wants to layout the Preview by itself, it should return false. Then the getFormatPanel(preview) will be called. A FormatPanel then has the opportunity to return a combined panel with the given preview panel.

Returns:

boolean true, if the default layout should be applied, otherwise false.

createPreview

protected javax.swing.JPanel createPreview(int type)

Creates a wrapper Preview Panel according to the given type and wrapps it into a separate JPanel.

Parameters:

type - the preview type.

Returns:

a JPanel containing a DefaultPreview instance.

See Also:

DefaultPreview.PREVIEW_FONT, DefaultPreview.PREVIEW_STROKE, DefaultPreview.PREVIEW_PAINT

validateFormat

protected abstract boolean validateFormat()

Called whenever the user selects the OK button. A Format Dialog should only be closed when all connected Format Panels are valid.

Returns:

true, to indicate a valid Format.