org.ceryle.ui.graph
Class ComposerDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.ceryle.ui.graph.ComposerDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class ComposerDialog
extends JDialog

A subclass of JDialog providing a dialog box devoted to planning a composition. This is called by Composer.

Since:

JDK1.4

Version:

$Id: ComposerDialog.java,v 3.10 2007-06-20 01:28:21 altheim Exp $

Author:

Murray Altheim

See Also:

Serialized Form

Nested Class Summary

class

ComposerDialog.DialogDisposer

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static int	DEFAULT_COLUMN_WIDTH The default column width (in characters) for the display list.
static int	DEFAULT_ROW_COUNT The default number of rows to show in the display list.
static int	DEFAULT_WINDOW_WIDTH Window width in pixels.
protected JLabel	fld_included
protected JLabel	fld_length
protected JLabel	fld_message

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

ComposerDialog(Composer composer, Collection reports, boolean initVisible)
Constructor for a dialog box containing a selection list.

Method Summary

protected JComponent	createCenterPanel() Returns the center panel containing the Compositors (as JPanels).
protected JPanel	createNorthPanel() Returns the northernmost panel containing the number of components.
protected JPanel	createSouthPanel() Returns the southernmost panel containing the compose, save as and close buttons.
JPanel	getReportPanel() Returns the report-containing panel, which uses a Y Box layout.
boolean	isHelpVisible()
void	setHelpText(String content) Set the help text to the String content.
protected void	setStatus(int completed, int status) Sets the overall status percentage completed and status value for the dialog.
void	setWhatNext(String comment, String description) Set the "What next?" description and comment (the short text visible even while minimized) to the provided Strings.

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, 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, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, 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, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, 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

DEFAULT_WINDOW_WIDTH

public static int DEFAULT_WINDOW_WIDTH

Window width in pixels. This defaults to 0, but this will force it to any size larger than the current width.

DEFAULT_COLUMN_WIDTH

public static int DEFAULT_COLUMN_WIDTH

The default column width (in characters) for the display list.

DEFAULT_ROW_COUNT

public static int DEFAULT_ROW_COUNT

The default number of rows to show in the display list.

fld_message

protected JLabel fld_message

fld_length

protected JLabel fld_length

fld_included

protected JLabel fld_included

Constructor Detail

ComposerDialog

public ComposerDialog(Composer composer,
                      Collection reports,
                      boolean initVisible)

Constructor for a dialog box containing a selection list. The Collection contains a list of JPanel 'reports' collected from the Compositors, which is populated by the Composer via access to the reports panel. The result is returned from the the method getSelection().

Parameters:

composer - the parent Composer

initVisible - when true, displays the dialog upon instantiation

Method Detail

getReportPanel

public JPanel getReportPanel()

Returns the report-containing panel, which uses a Y Box layout.

setStatus

protected void setStatus(int completed,
                         int status)

Sets the overall status percentage completed and status value for the dialog. The latter should be one of the STATUS_* constants from the Composer class.

isHelpVisible

public boolean isHelpVisible()

setHelpText

public void setHelpText(String content)

Set the help text to the String content.

createNorthPanel

protected JPanel createNorthPanel()

Returns the northernmost panel containing the number of components.

createCenterPanel

protected JComponent createCenterPanel()

Returns the center panel containing the Compositors (as JPanels). This also includes the north panel for resizing reasons.

setWhatNext

public void setWhatNext(String comment,
                        String description)

Set the "What next?" description and comment (the short text visible even while minimized) to the provided Strings. The description can contain HTML markup for presentation changes. Null values are ignored, so either field can be set independently.

createSouthPanel

protected JPanel createSouthPanel()

Returns the southernmost panel containing the compose, save as and close buttons.