org.brains2b.swingext.preference
Class PreferencePane

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.brains2b.swingext.preference.PreferencePane
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, org.brains2b.swingext.form.Form

public class PreferencePane
extends javax.swing.JPanel
implements org.brains2b.swingext.form.Form

Default property dialog for application properties Sets fields on basis of properties, overwrite initValues() to set up your own content and properties.
Only use the getComponent() function[s] to set the properties, otherwise properties will not not be set

Since:
2006-11-28
Version:
0.52
Author:
dennis
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static int COLOR
           
static int FILE
           
static int FONT
           
static int LIST
           
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
PreferencePane(java.util.Properties prop)
           
 
Method Summary
 void addIgnorePattern(java.lang.String pattern)
           
 void addTab(java.lang.String forPrefix, java.lang.String label)
           
protected  void addTabPane(javax.swing.JPanel pnl, java.lang.String title, javax.swing.Icon icon)
           
protected  void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
           
static java.lang.String[] getList(java.lang.String s)
           
protected  java.lang.String getResourceValue(java.lang.String key, java.lang.String defaultValue)
          returns the String from the resource bundle for a given key.
protected  void initValues()
           
 boolean isAutoTab()
           
 boolean isChanged()
          Gets the changed.
protected  void makeTabs(java.util.TreeSet s)
           
 void performApply()
           
 void performCancel()
           
 void performOk()
           
 void performUndo()
           
 void registerResourceBundle(java.util.ResourceBundle resource)
          Registers a resourceBundle for this component.
 void setAutoTab(boolean b)
           
protected  void setCheckBox(javax.swing.JPanel p, java.awt.GridBagConstraints gbc, java.lang.String key, java.lang.String value, java.lang.String label)
           
protected  void setColorPanel(javax.swing.JPanel p, java.awt.GridBagConstraints gbc, java.lang.String key, java.lang.String value, java.lang.String label)
           
protected  void setComboBox(javax.swing.JPanel p, java.awt.GridBagConstraints gbc, java.lang.String key, java.lang.String value, java.lang.String label)
           
protected  void setComponent(javax.swing.JPanel p, java.awt.GridBagConstraints gbc, java.lang.String key, java.lang.String value, java.lang.String label)
           
protected  void setFilePanel(javax.swing.JPanel p, java.awt.GridBagConstraints gbc, java.lang.String key, java.lang.String value, java.lang.String label)
           
protected  void setFontPanel(javax.swing.JPanel p, java.awt.GridBagConstraints gbc, java.lang.String key, java.lang.String value, java.lang.String label)
           
 void setIgnorePattern(java.lang.String pattern)
           
protected  void setListPanel(javax.swing.JPanel p, java.awt.GridBagConstraints gbc, java.lang.String key, java.lang.String value, java.lang.String label)
           
 void setOptionsFor(java.lang.String key, java.util.Hashtable t)
           
 void setOptionsFor(java.lang.String key, java.lang.String[] options)
           
 void setOptionsFor(java.lang.String key, java.lang.String[][] options)
           
 void setPropertyType(java.lang.String key, int type)
           
protected  void setTextField(javax.swing.JPanel p, java.awt.GridBagConstraints gbc, java.lang.String key, java.lang.String value, java.lang.String label)
           
static java.util.Properties showDialog(java.awt.Component parent, java.util.Properties p)
           
static java.util.Properties showInternalDialog(java.awt.Component parent, java.util.Properties p, java.lang.String title, javax.swing.Icon icon)
           
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
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, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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
 
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, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.brains2b.swingext.form.Form
getRootPane
 

Field Detail

COLOR

public static final int COLOR
See Also:
Constant Field Values

FONT

public static final int FONT
See Also:
Constant Field Values

FILE

public static final int FILE
See Also:
Constant Field Values

LIST

public static final int LIST
See Also:
Constant Field Values
Constructor Detail

PreferencePane

public PreferencePane(java.util.Properties prop)
Method Detail

initValues

protected void initValues()

performApply

public void performApply()
Specified by:
performApply in interface org.brains2b.swingext.form.Form

performOk

public void performOk()
Specified by:
performOk in interface org.brains2b.swingext.form.Form

performUndo

public void performUndo()
Specified by:
performUndo in interface org.brains2b.swingext.form.Form

performCancel

public void performCancel()
Specified by:
performCancel in interface org.brains2b.swingext.form.Form

addTabPane

protected void addTabPane(javax.swing.JPanel pnl,
                          java.lang.String title,
                          javax.swing.Icon icon)

setComponent

protected void setComponent(javax.swing.JPanel p,
                            java.awt.GridBagConstraints gbc,
                            java.lang.String key,
                            java.lang.String value,
                            java.lang.String label)

setTextField

protected void setTextField(javax.swing.JPanel p,
                            java.awt.GridBagConstraints gbc,
                            java.lang.String key,
                            java.lang.String value,
                            java.lang.String label)

setColorPanel

protected void setColorPanel(javax.swing.JPanel p,
                             java.awt.GridBagConstraints gbc,
                             java.lang.String key,
                             java.lang.String value,
                             java.lang.String label)

setFilePanel

protected void setFilePanel(javax.swing.JPanel p,
                            java.awt.GridBagConstraints gbc,
                            java.lang.String key,
                            java.lang.String value,
                            java.lang.String label)

setListPanel

protected void setListPanel(javax.swing.JPanel p,
                            java.awt.GridBagConstraints gbc,
                            java.lang.String key,
                            java.lang.String value,
                            java.lang.String label)

setFontPanel

protected void setFontPanel(javax.swing.JPanel p,
                            java.awt.GridBagConstraints gbc,
                            java.lang.String key,
                            java.lang.String value,
                            java.lang.String label)

setCheckBox

protected void setCheckBox(javax.swing.JPanel p,
                           java.awt.GridBagConstraints gbc,
                           java.lang.String key,
                           java.lang.String value,
                           java.lang.String label)

setComboBox

protected void setComboBox(javax.swing.JPanel p,
                           java.awt.GridBagConstraints gbc,
                           java.lang.String key,
                           java.lang.String value,
                           java.lang.String label)

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)
Overrides:
firePropertyChange in class java.awt.Component

isChanged

public boolean isChanged()
Gets the changed.

Returns:
Returns a boolean

setIgnorePattern

public void setIgnorePattern(java.lang.String pattern)

addIgnorePattern

public void addIgnorePattern(java.lang.String pattern)

setPropertyType

public void setPropertyType(java.lang.String key,
                            int type)

setOptionsFor

public void setOptionsFor(java.lang.String key,
                          java.util.Hashtable t)

setOptionsFor

public void setOptionsFor(java.lang.String key,
                          java.lang.String[] options)

setOptionsFor

public void setOptionsFor(java.lang.String key,
                          java.lang.String[][] options)

registerResourceBundle

public void registerResourceBundle(java.util.ResourceBundle resource)
Registers a resourceBundle for this component.

This resource bundle will be used to set the labels for the individual preferences in this screen. The key of the resource bundle should be the same as the key for the preference.

The title of the General tab can be changed by supplying a key named Preference.generalTitle
The Choose... button can be set by Preference.btnChoose

This resourceBundle is passed to the FormAction component used here to use with the labels on the buttons. Look at FormAction for key names and content

Parameters:
resource, - ResourceBundle
Since:
Framework 0.31
See Also:
org.brains2b.model.gui.FormAction

getResourceValue

protected java.lang.String getResourceValue(java.lang.String key,
                                            java.lang.String defaultValue)
returns the String from the resource bundle for a given key.

Returns the defaultValue if no resource bundle was registered or if the key cannot be found in the resource bundle.

Parameters:
key - String, the key to find in the resource bundle
defaultValue - String, the default value if no bundle or key was defined
Returns:
String, the Value found in the resourcebundle or the defaultValue
Since:
Framework 0.31

getList

public static final java.lang.String[] getList(java.lang.String s)

isAutoTab

public boolean isAutoTab()
Returns:

setAutoTab

public void setAutoTab(boolean b)
Parameters:
b -

addTab

public void addTab(java.lang.String forPrefix,
                   java.lang.String label)

makeTabs

protected void makeTabs(java.util.TreeSet s)

showDialog

public static java.util.Properties showDialog(java.awt.Component parent,
                                              java.util.Properties p)

showInternalDialog

public static java.util.Properties showInternalDialog(java.awt.Component parent,
                                                      java.util.Properties p,
                                                      java.lang.String title,
                                                      javax.swing.Icon icon)