org.ceryle.ui
Class IDDialog

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

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class IDDialog
extends JDialog

Extends JDialog providing an input for a collection and document IDs (a valid XML Name) and title. The title can either be hidden, editable, or read-only, depending on a mode set by a constructor parameter value. The result is a three item String array, obtained via getResult(), containing cid [0], nid [1], and title [2]. This is a bit of a kitchen sink class, as it's designed for various modes to enter/edit both collection and document IDs.

Since:

JDK1.3

Version:

$Id: IDDialog.java,v 3.13 2007-06-20 01:28:17 altheim Exp $

Author:

Murray Altheim

See Also:

Serialized Form

Nested Class Summary

class

IDDialog.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	CID_EDITABLE The collection ID mode indicating that the dialog is provided as a means of editing the collection ID, and that the document ID field will not be shown.
static int	CID_READONLY The collection ID mode indicating that the ID is displayed as a read-only field.
static int	CID_SELECTABLE The collection ID mode indicating that the ID is selectable.
static int	TITLE_EDITABLE The title mode indicating that no title should be displayed as an editable field.
static int	TITLE_HIDDEN The title mode indicating that no title should be displayed.
static int	TITLE_READONLY The title mode indicating that the title should be displayed as a read-only field.

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

IDDialog(IDFactory idfactory, String dlogTitle, String cid, String nid, String title)
Constructor for a dialog box for entering a document ID (an XML Name) and title.

IDDialog(IDFactory idfactory, String dlogTitle, String cid, String nid, String title, int titleMode, boolean idFromTitle, int cidMode, boolean overwrite)
Constructor for a dialog box for entering a document ID (an XML Name) and title.

Method Summary

String[]	getResult() Returns the contents of the Collection ID, Node ID and title fields.
void	setCollection(String cid) Sets the Collection to cid.
void	setIDFromTitle() Generate an ID based on the title.
void	setNextID() Generate the next ID in a sequence, based on the current ID.
void	setRandomID() Generate a random ID.
boolean	validateCID() Checks the collection ID value and enables the Okay button accordingly.
boolean	validateNID() Checks the document ID value and enables the Okay button accordingly.

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

TITLE_HIDDEN

public static final int TITLE_HIDDEN

The title mode indicating that no title should be displayed.

See Also:

Constant Field Values

TITLE_EDITABLE

public static final int TITLE_EDITABLE

The title mode indicating that no title should be displayed as an editable field.

See Also:

Constant Field Values

TITLE_READONLY

public static final int TITLE_READONLY

The title mode indicating that the title should be displayed as a read-only field.

See Also:

Constant Field Values

CID_SELECTABLE

public static final int CID_SELECTABLE

The collection ID mode indicating that the ID is selectable.

See Also:

Constant Field Values

CID_EDITABLE

public static final int CID_EDITABLE

The collection ID mode indicating that the dialog is provided as a means of editing the collection ID, and that the document ID field will not be shown.

See Also:

Constant Field Values

CID_READONLY

public static final int CID_READONLY

The collection ID mode indicating that the ID is displayed as a read-only field.

See Also:

Constant Field Values

Constructor Detail

IDDialog

public IDDialog(IDFactory idfactory,
                String dlogTitle,
                String cid,
                String nid,
                String title)

Constructor for a dialog box for entering a document ID (an XML Name) and title. If the collection ID is provided, it is not selectable. Defaults to initially setting the ID based on title.

Parameters:

idfactory - the IDFactory used to generate unique IDs

dlogTitle - the optional dialog title (if null, a default will be used)

cid - the collection ID (if null it won't be displayed)

nid - the current or default node ID (may be null)

title - the current document title

IDDialog

public IDDialog(IDFactory idfactory,
                String dlogTitle,
                String cid,
                String nid,
                String title,
                int titleMode,
                boolean idFromTitle,
                int cidMode,
                boolean overwrite)

Constructor for a dialog box for entering a document ID (an XML Name) and title.

Parameters:

idfactory - the IDFactory used to generate unique IDs.

dlogTitle - the optional dialog title (if null, a default will be used).

cid - the collection ID (if null it won't be displayed).

nid - the current or default node ID (may be null).

title - the current document title.

titleMode - three modes: TITLE_HIDDEN, TITLE_EDITABLE, TITLE_READONLY.

idFromTitle - when true and the title is non-null, initially sets the ID based on the title, if false, uses nid value.

cidMode - the dialog mode for the collection ID.

overwrite - when true, permits overwrite of existing document

Method Detail

getResult

public String[] getResult()

Returns the contents of the Collection ID, Node ID and title fields. If the Document ID field is not valid, returns null. The title field will return a null if empty or composed only of whitespace.

setRandomID

public void setRandomID()

Generate a random ID.

setIDFromTitle

public void setIDFromTitle()

Generate an ID based on the title.

setNextID

public void setNextID()

Generate the next ID in a sequence, based on the current ID.

See Also:

IDFactory.getUniqueID(String,Collection,int)

setCollection

public void setCollection(String cid)

Sets the Collection to cid. This updates the stored list of proscribed document IDs to the new Collection.

validateCID

public boolean validateCID()

Checks the collection ID value and enables the Okay button accordingly. Returns true if the ID is valid and unused.

validateNID

public boolean validateNID()

Checks the document ID value and enables the Okay button accordingly. Returns true if the ID is valid and unused.