qflib 0.99

de.qfs.lib.option
Class SimpleOptionEdit

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.SimpleOptionEdit
All Implemented Interfaces:
javax.accessibility.Accessible, java.util.EventListener, java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.event.MouseListener, java.io.Serializable
Direct Known Subclasses:
EditorOptionEdit, IntegerOptionEdit, SelectorOptionEdit, StringOptionEdit, TextOptionEdit

public class SimpleOptionEdit
extends OptionEdit
implements java.awt.event.FocusListener, java.awt.event.MouseListener

Common baseclass for similar kinds of OptionEdits that are built from a JLabel and a JTextComponent.

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  boolean canFocus
          Whether a FOCUS_GAINED event can cause a selection.
protected  javax.swing.JLabel label
          The label of the component.
protected  boolean selectOnFocus
          Whether to select everything on a FOCUS_GAINED event.
protected  javax.swing.text.JTextComponent text
          The text of the component.
 
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
protected SimpleOptionEdit()
          Create a new SimpleOptionEdit.
 
Method Summary
 boolean checkValue()
          Check the currently entered value of the OptionEdit.
 void focusGained(java.awt.event.FocusEvent event)
          Notify the edit of a FOCUS_GAINED event.
 void focusLost(java.awt.event.FocusEvent event)
          Notify the edit of a FOCUS_LOST event.
 java.lang.String getText()
          Get the text of the SimpleOptionEdit.
 void init()
          Initialize the OptionEdit.
 boolean isEnabled()
          Query whether the SimpleOptionEdit 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 mouseClicked(java.awt.event.MouseEvent event)
          Maybe reset the selection.
 void mouseEntered(java.awt.event.MouseEvent event)
          Noop.
 void mouseExited(java.awt.event.MouseEvent event)
          Noop.
 void mousePressed(java.awt.event.MouseEvent event)
          Noop.
 void mouseReleased(java.awt.event.MouseEvent event)
          Noop.
 void readValue()
          Read the currently entered value and store it in the Option.
 void requestFocus()
          Request the focus for the SimpleOptionEdit.
 void setEnabled(boolean enabled)
          Enable or disable the SimpleOptionEdit.
 void setText(java.lang.String text)
          Set the text of the SimpleOptionEdit.
 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.


text

protected javax.swing.text.JTextComponent text
The text of the component.


selectOnFocus

protected boolean selectOnFocus
Whether to select everything on a FOCUS_GAINED event.


canFocus

protected boolean canFocus
Whether a FOCUS_GAINED event can cause a selection.

Constructor Detail

SimpleOptionEdit

protected SimpleOptionEdit()
Create a new SimpleOptionEdit. Don't call this directly, use OptionEdit.makeEdit.

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.

getText

public java.lang.String getText()
Get the text of the SimpleOptionEdit.

Returns:
The text of the SimpleOptionEdit.

setText

public void setText(java.lang.String text)
Set the text of the SimpleOptionEdit.

Parameters:
text - The text to set.
Since:
0.98.1

focusGained

public void focusGained(java.awt.event.FocusEvent event)
Notify the edit of a FOCUS_GAINED event. Can cause a selection of the whole text.

Specified by:
focusGained in interface java.awt.event.FocusListener
Parameters:
event - The event.
Since:
0.99.0

focusLost

public void focusLost(java.awt.event.FocusEvent event)
Notify the edit of a FOCUS_LOST event. If the event is permanent, reset the focus so it can cause a selection again.

Specified by:
focusLost in interface java.awt.event.FocusListener
Parameters:
event - The event.
Since:
0.99.0

mousePressed

public void mousePressed(java.awt.event.MouseEvent event)
Noop.

Specified by:
mousePressed in interface java.awt.event.MouseListener
Parameters:
event - Ignored.
Since:
0.99.0

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent event)
Noop.

Specified by:
mouseReleased in interface java.awt.event.MouseListener
Parameters:
event - Ignored.
Since:
0.99.0

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent event)
Maybe reset the selection.

Specified by:
mouseClicked in interface java.awt.event.MouseListener
Parameters:
event - Ignored.
Since:
0.99.0

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent event)
Noop.

Specified by:
mouseEntered in interface java.awt.event.MouseListener
Parameters:
event - Ignored.
Since:
0.99.0

mouseExited

public void mouseExited(java.awt.event.MouseEvent event)
Noop.

Specified by:
mouseExited in interface java.awt.event.MouseListener
Parameters:
event - Ignored.
Since:
0.99.0

setEnabled

public void setEnabled(boolean enabled)
Enable or disable the SimpleOptionEdit.

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

isEnabled

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

Returns:
True if it is enabled.

requestFocus

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


qflib 0.99