org.acm.seguin.tools.install
Class SettingPanel

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.acm.seguin.tools.install.SettingPanel
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
Direct Known Subclasses:
IndexedPanel, MultilineSettingPanel, OptionPanel, SortSettingPanel, TagEditorSettingPanel, TextPanel, TogglePanel

public abstract class SettingPanel
extends javax.swing.JPanel

Generic base class containing the setting panel

Author:
Chris Seguin
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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected static FileSettings bundle
          The file settings
protected static java.awt.Font teletype
          Description of the Field
 
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
SettingPanel()
          Constructor for the SettingPanel object
 
Method Summary
 void addCodeDescription(java.lang.String value)
          Adds a feature to the Description attribute of the SettingPanel object
protected  void addCodeDescription(java.lang.String value, boolean show)
          Adds a feature to the Description attribute of the SettingPanel object
protected  void addCodeLabel(java.lang.String value)
          Adds a feature to the Label attribute of the SettingPanel object
 void addDescription(java.lang.String value)
          Adds a feature to the Description attribute of the SettingPanel object
protected  void addDescription(java.lang.String value, boolean show)
          Adds a feature to the Description attribute of the SettingPanel object
protected  void addLabel(java.lang.String value)
          Adds a feature to the Label attribute of the SettingPanel object
 void generateSetting(java.io.PrintWriter output)
          Generate the settings file for this particular setting
 java.lang.String getDefaultValue()
          Gets the DefaultValue attribute of the SettingPanel object
protected abstract  java.lang.String getInitialValue()
          Gets the initial value if it is not defined
abstract  java.lang.String getKey()
          Gets the Key attribute of the SettingPanel object
 java.lang.String getValue()
          Gets the Value attribute of the SettingPanel object
protected  void incrItems()
          Increment the number of items in the grid
protected  void printDescription(java.io.PrintWriter output)
          Description of the Method
abstract  void reload()
          Reload the value from the pretty.settings file
 
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, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

bundle

protected static FileSettings bundle
The file settings


teletype

protected static java.awt.Font teletype
Description of the Field

Constructor Detail

SettingPanel

public SettingPanel()
Constructor for the SettingPanel object

Method Detail

getKey

public abstract java.lang.String getKey()
Gets the Key attribute of the SettingPanel object

Returns:
The Key value

getValue

public java.lang.String getValue()
Gets the Value attribute of the SettingPanel object

Returns:
The Value value

getDefaultValue

public java.lang.String getDefaultValue()
Gets the DefaultValue attribute of the SettingPanel object

Returns:
The DefaultValue value

addDescription

public void addDescription(java.lang.String value)
Adds a feature to the Description attribute of the SettingPanel object

Parameters:
value - The feature to be added to the Description attribute

addCodeDescription

public void addCodeDescription(java.lang.String value)
Adds a feature to the Description attribute of the SettingPanel object

Parameters:
value - The feature to be added to the Description attribute

generateSetting

public void generateSetting(java.io.PrintWriter output)
Generate the settings file for this particular setting

Parameters:
output - the output stream

getInitialValue

protected abstract java.lang.String getInitialValue()
Gets the initial value if it is not defined

Returns:
The InitialValue value

addDescription

protected void addDescription(java.lang.String value,
                              boolean show)
Adds a feature to the Description attribute of the SettingPanel object

Parameters:
value - The feature to be added to the Description attribute
show - true if this should be displayed

addCodeDescription

protected void addCodeDescription(java.lang.String value,
                                  boolean show)
Adds a feature to the Description attribute of the SettingPanel object

Parameters:
value - The feature to be added to the Description attribute
show - true if this should be displayed

incrItems

protected void incrItems()
Increment the number of items in the grid


printDescription

protected void printDescription(java.io.PrintWriter output)
Description of the Method

Parameters:
output - Description of Parameter

addLabel

protected void addLabel(java.lang.String value)
Adds a feature to the Label attribute of the SettingPanel object

Parameters:
value - The feature to be added to the Label attribute

addCodeLabel

protected void addCodeLabel(java.lang.String value)
Adds a feature to the Label attribute of the SettingPanel object

Parameters:
value - The feature to be added to the Label attribute

reload

public abstract void reload()
Reload the value from the pretty.settings file