com.antelmann.util.gui
Class JEnumField<T extends Enum<?>>

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.antelmann.util.gui.JEnumField<T>

All Implemented Interfaces:

EditableComponent, ValueRetriever<T>, ValueSetter<T>, ImageObserver, MenuContainer, Serializable

public class JEnumField<T extends Enum<?>>
extends JComponent
implements ValueRetriever<T>, ValueSetter<T>, EditableComponent

a special component that allows to select an enum constant via JRadioButton in a ButtonGroup. Use a PropertyChangeListener with 'value' as property key to listen for selection changes. Basically this provides a convenient alternative to using a JComboBox to select a constant.

Since:

22.01.2016, 22:46:29

Author:

holger

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

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

JEnumField(Class<T> type)

JEnumField(Class<T> type, LayoutOption option)

JEnumField(Class<T> type, T defaultValue)

JEnumField(Class<T> type, T defaultValue, int rows, int columns, int padding, Factory<? extends JToggleButton> factory)

JEnumField(Class<T> type, T defaultValue, LayoutOption option)

JEnumField(Class<T> type, T defaultValue, LayoutOption option, Factory<? extends JToggleButton> factory)

Method Summary

T	getRelevantValue() returns the relevant value for this instance at the time of calling
boolean	isEditable()
void	setEditable(boolean flag)
void	setRelevantValue(T value) sets the relevant value for this instance with the given value

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI

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, 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, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JEnumField

public JEnumField(Class<T> type)

JEnumField

public JEnumField(Class<T> type,
                  T defaultValue)

JEnumField

public JEnumField(Class<T> type,
                  LayoutOption option)

JEnumField

public JEnumField(Class<T> type,
                  T defaultValue,
                  LayoutOption option)

JEnumField

public JEnumField(Class<T> type,
                  T defaultValue,
                  LayoutOption option,
                  Factory<? extends JToggleButton> factory)

Parameters:

type - the Enum type that is to be used as selection values

defaultValue - the initially selected Enum constant

option - allows to customize the layout

factory - allows to customize the buttons; the EventObject uses the Enum constant as the source

JEnumField

public JEnumField(Class<T> type,
                  T defaultValue,
                  int rows,
                  int columns,
                  int padding,
                  Factory<? extends JToggleButton> factory)

Parameters:

type - the Enum type that is to be used as selection values

defaultValue - the initially selected Enum constant

rows - specifies the rows according to Menus.makeCompactSpringGrid(java.awt.Container, int, int, int)

columns - specifies the columns according to Menus.makeCompactSpringGrid(java.awt.Container, int, int, int)

padding - specifies the padding according to Menus.makeCompactSpringGrid(java.awt.Container, int, int, int)

factory - allows to customize the buttons; the EventObject uses the Enum constant as the source

Method Detail

getRelevantValue

public T getRelevantValue()

Description copied from interface: ValueRetriever

returns the relevant value for this instance at the time of calling

Specified by:

getRelevantValue in interface ValueRetriever<T extends Enum<?>>

setRelevantValue

public void setRelevantValue(T value)

Description copied from interface: ValueSetter

sets the relevant value for this instance with the given value

Specified by:

setRelevantValue in interface ValueSetter<T extends Enum<?>>

isEditable

public boolean isEditable()

Specified by:

isEditable in interface EditableComponent

setEditable

public void setEditable(boolean flag)

Specified by:

setEditable in interface EditableComponent