pub.vlsolutions.swing.docking

Class DockingSelectorDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

pub.vlsolutions.swing.docking.DockingSelectorDialog

All Implemented Interfaces:

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

public class DockingSelectorDialog
extends javax.swing.JDialog

A Helper class providing information about the visibility of user components.

This dialog shows which user components are docked, auto-hidden, not visible, and is capable of dynamicaly altering the dockingpanel layout on user selection (for example, to show an unvisible component).

User components shown are those which are already docked and those which have been registered with the registerDockableComponent() method of DockingPanel.

Example of usage :

 Frame f = ...  // frame containing the docking panel
 DockingPanel dockingPanel = ...
 DockingSelectorDialog dlg = new DockingSelectorDialog(f);
 dlg.setDockingPanel(dockingPanel);
 dlg.pack();
 dlg.setLocationRelativeTo(f);
 dlg.setVisible(true); // modal

 // optional
 if (dlg.getClosingState() == DockingSelectorDialog.CONFIRM){
    // do something more
 }
 

Version:

1.0

Author:

Lilian Chamontin, vlsolutions.

See Also:

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

Modifier and Type	Field and Description
static int	CANCEL Closing state of the dialog when the user has selected the cancel option
static int	CONFIRM Closing state of the dialog when the user has selected the confirm option

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
DockingSelectorDialog() Default constructor.
DockingSelectorDialog(java.awt.Dialog owner) Constructor for Dialog parent window.
DockingSelectorDialog(java.awt.Frame owner) Constructor for Frame parent window.

Method Summary

Methods

Modifier and Type	Method and Description
int	getClosingState() Returns the users close choice as CONFIRM or CANCEL (remember this dialog is modal).
void	setCancelButtonText(java.lang.String text) Change the cancel button text (hook for i18n)
void	setCancelButtonTooltipText(java.lang.String text) Change the cancel button tootip text (hook for i18n)
void	setConfirmButtonText(java.lang.String text) Change the confirm button text (hook for i18n)
void	setConfirmButtonTooltipText(java.lang.String text) Change the confirm button tooltip text (hook for i18n)
void	setDockingDesktop(DockingDesktop desktop) Requiered to initialize this dialog.
void	setWizardLabelText(java.lang.String wizardLabelText) Change the wizard label text (an explanation of the behaviour of this dialog).

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, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, 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

Field Detail

CONFIRM

public static final int CONFIRM

Closing state of the dialog when the user has selected the confirm option

See Also:

getClosingState(), Constant Field Values

CANCEL

public static final int CANCEL

Closing state of the dialog when the user has selected the cancel option

See Also:

getClosingState(), Constant Field Values

Constructor Detail

DockingSelectorDialog

public DockingSelectorDialog()

Default constructor.

modal dialog with DISPOSE_ON_CLOSE option, needs a pack() and setVisible(true) after creation

DockingSelectorDialog

public DockingSelectorDialog(java.awt.Dialog owner)

Constructor for Dialog parent window.

modal dialog with DISPOSE_ON_CLOSE option, needs a pack() and setVisible(true) after creation.

DockingSelectorDialog

public DockingSelectorDialog(java.awt.Frame owner)

Constructor for Frame parent window.

modal dialog with DISPOSE_ON_CLOSE option, needs a pack() and setVisible(true) after creation.

Method Detail

setConfirmButtonText

public void setConfirmButtonText(java.lang.String text)

Change the confirm button text (hook for i18n)

setCancelButtonText

public void setCancelButtonText(java.lang.String text)

Change the cancel button text (hook for i18n)

setConfirmButtonTooltipText

public void setConfirmButtonTooltipText(java.lang.String text)

Change the confirm button tooltip text (hook for i18n)

setCancelButtonTooltipText

public void setCancelButtonTooltipText(java.lang.String text)

Change the cancel button tootip text (hook for i18n)

setWizardLabelText

public void setWizardLabelText(java.lang.String wizardLabelText)

Change the wizard label text (an explanation of the behaviour of this dialog).

HTML format is supported like in any JLabel.

setDockingDesktop

public void setDockingDesktop(DockingDesktop desktop)

Requiered to initialize this dialog.

Invoke this method before packing the dialog.

getClosingState

public int getClosingState()

Returns the users close choice as CONFIRM or CANCEL (remember this dialog is modal).

Use this method if you need to know how is was closed. If the used has confirmed, the docking panel is automaticaly updated by the confirm button action.