org.scripthelper.swing.script

Class ScriptPropertyDialog<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.scripthelper.swing.script.ScriptPropertyDialog<T>

Type Parameters:

T - the property type

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

Direct Known Subclasses:

ScriptPropertyDialog.BooleanProperty, ScriptPropertyDialog.EnumProperty, ScriptPropertyDialog.FloatProperty, ScriptPropertyDialog.IntProperty, ScriptPropertyDialog.StringProperty

public abstract class ScriptPropertyDialog<T>
extends javax.swing.JComponent

A Dialog allowing to enter a property.

Since:

1.6.2

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScriptPropertyDialog.BooleanProperty
static class	ScriptPropertyDialog.EnumProperty
static class	ScriptPropertyDialog.FloatProperty
static class	ScriptPropertyDialog.IntProperty
static class	ScriptPropertyDialog.StringProperty

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

javax.swing.JComponent.AccessibleJComponent

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
protected javax.swing.JDialog	dialog The internal dialog.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ScriptPropertyDialog(java.lang.String desc)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addPropertyEditor(javax.swing.JPanel propPanel)
protected void	apply() Called when applying the dialog.
protected void	cancel() Called when cancelling the dialog.
protected javax.swing.JDialog	createDialog(java.awt.Component parent) Create the dialog, as a child of its parent owner.
protected javax.swing.JDialog	createDialog(java.awt.Component parent, boolean modal) Create the dialog as a JDialog, as a child of its parent owner.
protected void	createPanel() The method to implement to create the main panel of the dialog.
protected javax.swing.JPanel	createYesNoPanel() Create the Yes / No bottom Panel.
protected void	doCancel() Called when clicking the default "No" button.
protected void	doYes() Called when clicking the default "Yes" button.
javax.swing.AbstractAction	getCancelAction() Return the action associated with the default "No" button.
javax.swing.JDialog	getDialog() Return the dialog.
java.lang.String	getDialogTitle() Return the title of the Dialog.
abstract T	getProperty()
int	getReturnValue() Return the last value of the dialog return value.
javax.swing.AbstractAction	getYesAction() Return the action associated with the default "Yes" button.
int	showDialog() Show the dialog.
int	showDialog(java.awt.Component parent) Show the dialog.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, 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

dialog

protected javax.swing.JDialog dialog

The internal dialog.

Constructor Detail

ScriptPropertyDialog

public ScriptPropertyDialog(java.lang.String desc)

Method Detail

getProperty

public abstract T getProperty()

addPropertyEditor

protected abstract void addPropertyEditor(javax.swing.JPanel propPanel)

createPanel

protected void createPanel()

The method to implement to create the main panel of the dialog. Note that you should create a Yes / No Panel here. For example, here is a case where the sub-class will create a default panel with a text message, using the default Yes /No Panel:

 Container pane = dialog.getContentPane();
 pane.setLayout(new BoxLayout(pane, BoxLayout.Y_AXIS));

 pane.add(new JLabel("MyText");
 pane.add(Box.createRigidArea(new Dimension(50, 20)));

 JPanel yesnopanel = this.createYesNoPanel();

 pane.add(yesnopanel);
 

getDialogTitle

public java.lang.String getDialogTitle()

Return the title of the Dialog.

Returns:

the Dialog title

getDialog

public javax.swing.JDialog getDialog()

Return the dialog.

Returns:

the dialog

createDialog

protected javax.swing.JDialog createDialog(java.awt.Component parent)

Create the dialog, as a child of its parent owner.

Parameters:

parent - the dialog owner (may be null)

Returns:

the dialog

createDialog

protected final javax.swing.JDialog createDialog(java.awt.Component parent,
                                                 boolean modal)

Create the dialog as a JDialog, as a child of its parent owner.

Parameters:

parent - the dialog owner (may be null)

modal - true if the dialog is modal

Returns:

the dialog

createYesNoPanel

protected javax.swing.JPanel createYesNoPanel()

Create the Yes / No bottom Panel. Note that it is possible to define a completely different panel can be defined by overriding this method. It is even possible to define a panel with a completely different content, even without Yes /No buttons.

Returns:

the Yes/No Panel

getYesAction

public javax.swing.AbstractAction getYesAction()

Return the action associated with the default "Yes" button.

Returns:

the action associated with the default "Yes" button

getCancelAction

public javax.swing.AbstractAction getCancelAction()

Return the action associated with the default "No" button.

Returns:

the action associated with the default "No" button

showDialog

public int showDialog(java.awt.Component parent)

Show the dialog.

Parameters:

parent - the parent component

Returns:

the JFileChooser return value.

showDialog

public int showDialog()

Show the dialog.

Returns:

the JFileChooser return value.

getReturnValue

public final int getReturnValue()

Return the last value of the dialog return value.

Returns:

the last value of the dialog return value

apply

protected void apply()

Called when applying the dialog. Do nothing by default.

cancel

protected void cancel()

Called when cancelling the dialog. Do nothing by default.

doYes

protected void doYes()

Called when clicking the default "Yes" button.

doCancel

protected void doCancel()

Called when clicking the default "No" button.