jpicedt.graphic.toolkit

Class CustomizerDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

jpicedt.graphic.toolkit.CustomizerDialog

All Implemented Interfaces:

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

public class CustomizerDialog
extends javax.swing.JDialog

A dialog box that lays out an array of AbstractCustomizer's inside a JPanel or a JTabbedPane, depending on the number of customizers fed to the constructor. It further provides four default actions, namely : ok, cancel, load default, reload.

Since:

jPicEdt 1.3.2

Version:

$Id: CustomizerDialog.java,v 1.9.2.1 2007/09/02 11:56:28 reynal Exp $

Author:

Sylvain Reynal

See Also:

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	ALL_BUTTONS mask to display all buttons
static int	CANCEL_BUTTON mask to display the CANCEL button
static int	DEFAULT_BUTTON mask to display the DEFAULT button
static int	NO_BUTTON mask to display no button at all
static int	OK_BUTTON mask to display the OK button
static int	OK_CANCEL_BUTTONS mask to display the OK and CANCEL buttons
static int	RELOAD_BUTTON mask to display the RELOAD button

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
CustomizerDialog(AbstractCustomizer customizer) Builds a new dialog box from a single customizer. By default, clicking the OK button does not close this dialog box, this must be set separately by invoking setOkButtonClosesDialog.
CustomizerDialog(AbstractCustomizer[] customizers, java.lang.String title, int selected) Creates a new dialog box from the given array of AbstractCustomizer's, laying them out in a JTabbedPane. By default, clicking the OK button does not close this dialog box, this must be set separately by invoking setOkButtonClosesDialog.
CustomizerDialog(AbstractCustomizer[] customizers, java.lang.String title, int selected, int buttonsMask) Creates a new dialog box from the given array of AbstractCustomizer's, laying them out in a JTabbedPane. By default, clicking the OK button does not close this dialog box, this must be set separately by invoking setOkButtonClosesDialog.
CustomizerDialog(AbstractCustomizer customizer, int buttonsMask) Builds a new dialog box from a single customizer. By default, clicking the OK button does not close this dialog box, this must be set separately by invoking setOkButtonClosesDialog.

Method Summary

Modifier and Type	Method and Description
boolean	isCancelled()
void	paneActivated(AbstractCustomizer c) If this dialog was constructed with more than one inner-pane, this methods is invoked when a new pane gets activated.
void	setOkButtonClosesDialog(boolean b) Whether clicking the OK button, beside storing widgets content, also closes this dialog or not.

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

NO_BUTTON

public static final int NO_BUTTON

mask to display no button at all

See Also:

Constant Field Values

OK_BUTTON

public static final int OK_BUTTON

mask to display the OK button

See Also:

Constant Field Values

CANCEL_BUTTON

public static final int CANCEL_BUTTON

mask to display the CANCEL button

See Also:

Constant Field Values

DEFAULT_BUTTON

public static final int DEFAULT_BUTTON

mask to display the DEFAULT button

See Also:

Constant Field Values

RELOAD_BUTTON

public static final int RELOAD_BUTTON

mask to display the RELOAD button

See Also:

Constant Field Values

OK_CANCEL_BUTTONS

public static final int OK_CANCEL_BUTTONS

mask to display the OK and CANCEL buttons

See Also:

Constant Field Values

ALL_BUTTONS

public static final int ALL_BUTTONS

mask to display all buttons

See Also:

Constant Field Values

Constructor Detail

CustomizerDialog

public CustomizerDialog(AbstractCustomizer[] customizers,
                        java.lang.String title,
                        int selected)

Creates a new dialog box from the given array of AbstractCustomizer's, laying them out in a JTabbedPane.
By default, clicking the OK button does not close this dialog box, this must be set separately by invoking setOkButtonClosesDialog.

Parameters:

title - the JDialog title ; if null, we use the first customizer title.

selected - index of the selected customizer on start-up

CustomizerDialog

public CustomizerDialog(AbstractCustomizer[] customizers,
                        java.lang.String title,
                        int selected,
                        int buttonsMask)

Creates a new dialog box from the given array of AbstractCustomizer's, laying them out in a JTabbedPane.
By default, clicking the OK button does not close this dialog box, this must be set separately by invoking setOkButtonClosesDialog.

Parameters:

title - the JDialog title ; if null, we use the first customizer title.

selected - index of the selected customizer on start-up

buttonsMask - buttons to be displayed : a mask computed from predefinite masks OR'd together

CustomizerDialog

public CustomizerDialog(AbstractCustomizer customizer)

Builds a new dialog box from a single customizer.
By default, clicking the OK button does not close this dialog box, this must be set separately by invoking setOkButtonClosesDialog.

CustomizerDialog

public CustomizerDialog(AbstractCustomizer customizer,
                        int buttonsMask)

Builds a new dialog box from a single customizer.
By default, clicking the OK button does not close this dialog box, this must be set separately by invoking setOkButtonClosesDialog.

Parameters:

buttonsMask - buttons to be displayed : a mask computed from predefinite masks OR'd together

Method Detail

isCancelled

public boolean isCancelled()

Returns:

true if the user pressed the Cancel action

paneActivated

public void paneActivated(AbstractCustomizer c)

If this dialog was constructed with more than one inner-pane, this methods is invoked when a new pane gets activated.

setOkButtonClosesDialog

public void setOkButtonClosesDialog(boolean b)

Whether clicking the OK button, beside storing widgets content, also closes this dialog or not. It is valid to call this method at any time, e.g. to change behaviour once this dialog has been made visible.