org.acm.seguin.tools.install
Class SortSettingPanel

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
                      extended by org.acm.seguin.tools.install.SortSettingPanel
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
Direct Known Subclasses:
GetterSetterOrderPanel, SortOptionPanel, TypeOrderPanel

public abstract class SortSettingPanel
extends SettingPanel

Holds a sort setting

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  java.awt.GridBagConstraints constraints
          The constraints
 
Fields inherited from class org.acm.seguin.tools.install.SettingPanel
bundle, teletype
 
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
SortSettingPanel()
          Constructor for the SortSettingPanel object
 
Method Summary
protected  void add(javax.swing.JComponent comp, java.awt.GridBagConstraints constraints)
          Description of the Method
protected  void addLabel(java.lang.String value)
          Adds a feature to the Label attribute of the SortSettingPanel object
protected  void addListener()
          Adds a feature to the Listener attribute of the SortSettingPanel object
abstract  void generateSetting(java.io.PrintWriter output, int index)
          Description of the Method
protected  void generateSetting(java.io.PrintWriter output, int index, java.lang.String key)
          Generates the section of the setting file described by this list.
protected  java.lang.String getInitialValue()
          Gets the initial value if it is not defined
 java.lang.String getKey()
          Gets the Key attribute of the SortSettingPanel object
 int getOrder()
          Gets the Order attribute of the SortSettingPanel object
protected abstract  java.lang.String getSortName()
          Gets the SortName attribute of the SortSettingPanel object
 boolean isSortEnabled()
          Determines if the sort is enabled
protected  void setOrder(int value)
          Sets the Order attribute of the SortSettingPanel object
protected  void setSortEnabled(boolean way)
          Sets the SortEnabled attribute of the SortSettingPanel object
 java.lang.String toString()
          Returns a string representing this item
 
Methods inherited from class org.acm.seguin.tools.install.SettingPanel
addCodeDescription, addCodeDescription, addCodeLabel, addDescription, addDescription, generateSetting, getDefaultValue, getValue, incrItems, printDescription, reload
 
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, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

constraints

protected java.awt.GridBagConstraints constraints
The constraints

Constructor Detail

SortSettingPanel

public SortSettingPanel()
Constructor for the SortSettingPanel object

Method Detail

isSortEnabled

public boolean isSortEnabled()
Determines if the sort is enabled

Returns:
The SortEnabled value

getKey

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

Specified by:
getKey in class SettingPanel
Returns:
The Key value

getOrder

public int getOrder()
Gets the Order attribute of the SortSettingPanel object

Returns:
The Order value

generateSetting

public abstract void generateSetting(java.io.PrintWriter output,
                                     int index)
Description of the Method

Parameters:
output - Description of Parameter
index - Description of Parameter

setSortEnabled

protected void setSortEnabled(boolean way)
Sets the SortEnabled attribute of the SortSettingPanel object

Parameters:
way - The new SortEnabled value

setOrder

protected void setOrder(int value)
Sets the Order attribute of the SortSettingPanel object

Parameters:
value - The new Order value

getSortName

protected abstract java.lang.String getSortName()
Gets the SortName attribute of the SortSettingPanel object

Returns:
The SortName value

toString

public java.lang.String toString()
Returns a string representing this item

Overrides:
toString in class java.awt.Component
Returns:
the string

addLabel

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

Overrides:
addLabel in class SettingPanel
Parameters:
value - The feature to be added to the Label attribute

add

protected void add(javax.swing.JComponent comp,
                   java.awt.GridBagConstraints constraints)
Description of the Method

Parameters:
comp - Description of Parameter
constraints - Description of Parameter

addListener

protected void addListener()
Adds a feature to the Listener attribute of the SortSettingPanel object


generateSetting

protected void generateSetting(java.io.PrintWriter output,
                               int index,
                               java.lang.String key)
Generates the section of the setting file described by this list.

Parameters:
output - the output stream
index - the index
key - the key

getInitialValue

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

Specified by:
getInitialValue in class SettingPanel
Returns:
The InitialValue value