com.ice.config
Class ConfigureEditor

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.ice.config.ConfigureEditor
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
ConfigArrayEditor, ConfigBooleanEditor, ConfigChoiceEditor, ConfigColorEditor, ConfigComboEditor, ConfigDimensionEditor, ConfigFontEditor, ConfigNumberEditor, ConfigPointEditor, ConfigRectangleEditor, ConfigStringEditor, ConfigTupleTableEditor, ExecCommandEditor, LookAndFeelEditor, LookAndFeelEditor

public abstract class ConfigureEditor
extends javax.swing.JPanel

See Also:
Serialized Form

Field Summary
protected  int descOffset
           
protected  javax.swing.JPanel descPan
           
protected  javax.swing.JTextArea descText
           
protected  javax.swing.JPanel editorPanel
           
protected  javax.swing.JPanel editPanel
           
protected  javax.swing.JScrollPane editScroller
           
protected  javax.swing.JButton helpButton
           
protected  boolean helpIsShowing
           
protected  javax.swing.JPanel helpPanel
           
protected  javax.swing.JTextArea helpText
           
protected  UserPrefs prefs
           
protected  ConfigureSpec spec
           
 
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
ConfigureEditor(java.lang.String type)
           
 
Method Summary
 void commit(ConfigureSpec spec, UserPrefs prefs, UserPrefs orig)
           
 void commitChanges(ConfigureSpec spec, UserPrefs prefs, UserPrefs orig)
          This will commit the changes from prefs to orig.
protected abstract  javax.swing.JPanel createEditPanel()
           
 void edit(UserPrefs prefs, ConfigureSpec spec)
           
protected  javax.swing.JPanel establishHelpPanel()
           
protected  java.lang.String getHelpButtonToolTipText()
          Override for your own tip.
 boolean isModified(ConfigureSpec spec, UserPrefs prefs, UserPrefs orig)
          This will check for changes in prefs relative to orig.
 boolean isStringArray(ConfigureSpec spec)
           
 boolean isTupleTable(ConfigureSpec spec)
           
abstract  void requestInitialFocus()
           
abstract  void saveChanges(UserPrefs prefs, ConfigureSpec spec)
           
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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
 

Field Detail

prefs

protected UserPrefs prefs

spec

protected ConfigureSpec spec

helpIsShowing

protected boolean helpIsShowing

helpPanel

protected javax.swing.JPanel helpPanel

helpText

protected javax.swing.JTextArea helpText

helpButton

protected javax.swing.JButton helpButton

editPanel

protected javax.swing.JPanel editPanel

editScroller

protected javax.swing.JScrollPane editScroller

editorPanel

protected javax.swing.JPanel editorPanel

descPan

protected javax.swing.JPanel descPan

descText

protected javax.swing.JTextArea descText

descOffset

protected int descOffset
Constructor Detail

ConfigureEditor

public ConfigureEditor(java.lang.String type)
Method Detail

saveChanges

public abstract void saveChanges(UserPrefs prefs,
                                 ConfigureSpec spec)

requestInitialFocus

public abstract void requestInitialFocus()

createEditPanel

protected abstract javax.swing.JPanel createEditPanel()

edit

public void edit(UserPrefs prefs,
                 ConfigureSpec spec)

commit

public void commit(ConfigureSpec spec,
                   UserPrefs prefs,
                   UserPrefs orig)

commitChanges

public void commitChanges(ConfigureSpec spec,
                          UserPrefs prefs,
                          UserPrefs orig)
This will commit the changes from prefs to orig. This method provides a number of default commits that will cover the majority of properties, and covers all of the default editors. You will need to override this method if your property type is not handled here.


isTupleTable

public boolean isTupleTable(ConfigureSpec spec)

isStringArray

public boolean isStringArray(ConfigureSpec spec)

isModified

public boolean isModified(ConfigureSpec spec,
                          UserPrefs prefs,
                          UserPrefs orig)
This will check for changes in prefs relative to orig. This method provides a number of default checks that will cover the majority of properties, and covers all of the default editors. You will need to override this method if your property type is not handled here.


getHelpButtonToolTipText

protected java.lang.String getHelpButtonToolTipText()
Override for your own tip.


establishHelpPanel

protected javax.swing.JPanel establishHelpPanel()


Copyright © 1997-2003, Timothy G. Endres, All Rights Reserved.