qflib 0.99

de.qfs.lib.option
Class EnumOptionEdit

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byde.qfs.lib.option.OptionEdit
                      extended byde.qfs.lib.option.EnumOptionEdit
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class EnumOptionEdit
extends OptionEdit

An OptionEdit for a EnumOption. It is represented by a JComboBox and uses the following resources:

Resource name Usage
option.name.type The type of the Enum (requird, no default).
option.name.label The label for the Option (optional, default empty).
option.name.mnemonic Keyboard accelerator (optional, default none).
option.name.disabled If true, the edit will be disabled and remain so even if setEnabled(true) is called (optional, default false).
option.name.numchoices The number of choices in the edit.
option.name.choicen.label The label for the nth choice of the edit, where n is between 1 and numchoices.
option.name.choicen.value The Enum value for the nth choice of the edit, where n is between 1 and numchoices (optional, default n).

Author:
Gregor Schmid
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  java.lang.Object[] choices
          The possible choices for the JComboBox.
protected  javax.swing.JComboBox combo
          The ComboBox Component of the EnumOptionEdit.
protected  javax.swing.JLabel label
          The label of the component.
protected  java.lang.String type
          The Enum type for the option.
protected  int[] values
          The possible values for the JComboBox.
 
Fields inherited from class de.qfs.lib.option.OptionEdit
disabled, group, option
 
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
EnumOptionEdit()
          Create a new EnumOptionEdit.
 
Method Summary
 boolean checkValue()
          Check the currently entered value of the OptionEdit.
protected  void getChoices()
          Create the possible choices from the resources.
 javax.swing.JComboBox getComboBox()
          Get the JComboBox used by the EnumOptionEdit.
protected  Enum getCurrentValue()
          Get the currently selected value.
 void init()
          Initialize the OptionEdit.
 boolean isEnabled()
          Query whether the EnumOptionEdit is enabled.
 boolean isModified()
          Query whether the edit has been modified, i.e. the current value of the edit differs from the option's value.
 void readValue()
          Read the currently entered value and store it in the Option.
 void requestFocus()
          Request the focus for the EnumOptionEdit.
 void setEnabled(boolean enabled)
          Enable or diesable the EnumOptionEdit.
 void update(Option option)
          Update the display for a possibly new Option.
 
Methods inherited from class de.qfs.lib.option.OptionEdit
addPackage, getBoolean, getInt, getOption, getOptionGroup, getString, getWeight, isDisabled, makeEdit, setDisabled, setOptionGroup, update
 
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, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, 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, 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

label

protected javax.swing.JLabel label
The label of the component.


combo

protected javax.swing.JComboBox combo
The ComboBox Component of the EnumOptionEdit.


type

protected java.lang.String type
The Enum type for the option.


choices

protected java.lang.Object[] choices
The possible choices for the JComboBox.


values

protected int[] values
The possible values for the JComboBox.

Constructor Detail

EnumOptionEdit

public EnumOptionEdit()
Create a new EnumOptionEdit. Don't call this directly, use OptionEdit.makeEdit instead.

Method Detail

init

public void init()
Initialize the OptionEdit. Called from makeEdit.

Specified by:
init in class OptionEdit

isModified

public boolean isModified()
Query whether the edit has been modified, i.e. the current value of the edit differs from the option's value.

Specified by:
isModified in class OptionEdit
Returns:
True if the values in the edit and option differ.
Since:
0.99.0

checkValue

public boolean checkValue()
Check the currently entered value of the OptionEdit. If the value is not valid, request the focus.

Specified by:
checkValue in class OptionEdit
Returns:
True if the value is valid, false otherwise.

readValue

public void readValue()
Read the currently entered value and store it in the Option.

Specified by:
readValue in class OptionEdit

update

public void update(Option option)
Update the display for a possibly new Option.

Specified by:
update in class OptionEdit
Parameters:
option - The new option.

getComboBox

public javax.swing.JComboBox getComboBox()
Get the JComboBox used by the EnumOptionEdit.

Returns:
The edit's combo box.
Since:
0.98.1

setEnabled

public void setEnabled(boolean enabled)
Enable or diesable the EnumOptionEdit.

Parameters:
enabled - True to enable, false to disable.

isEnabled

public boolean isEnabled()
Query whether the EnumOptionEdit is enabled.

Returns:
True if it is enabled.

requestFocus

public void requestFocus()
Request the focus for the EnumOptionEdit.


getChoices

protected void getChoices()
Create the possible choices from the resources.


getCurrentValue

protected Enum getCurrentValue()
Get the currently selected value.

Returns:
The currently selected value.
Since:
0.99.0

qflib 0.99