org.jminor.common.ui.valuemap
Class ValueChangeMapEditPanel<K,V>

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.jminor.common.ui.valuemap.ValueChangeMapEditPanel<K,V>
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
Direct Known Subclasses:
EntityEditPanel

public abstract class ValueChangeMapEditPanel<K,V>
extends JPanel

A UI class based on the ValueChangeMapEditModel.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
 
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
ValueChangeMapEditPanel(ValueChangeMapEditModel<K,V> model)
          Instantiates a new ValueChangeMapEditPanel based on the given model.
 
Method Summary
 void clearModelValues()
          Clears the values from the underlying model
 JComponent getComponent(K key)
           
 K getComponentKey(JComponent component)
           
 Collection<K> getComponentKeys()
           
 ValueChangeMapEditModel<K,V> getEditModel()
           
protected  JComponent getInitialFocusComponent()
           
 K getInitialFocusComponentKey()
           
 void prepareUI(boolean setInitialFocus, boolean clearUI)
          Prepares the UI.
 void selectComponent(K key)
           
protected  void setComponent(K key, JComponent component)
          Associates the given input component with the given property, preferably this should be called for components associated with key values.
 void setInitialFocus()
          Sets the initial focus
 JComponent setInitialFocusComponent(JComponent initialFocusComponent)
          Sets the component that should receive the focus when the UI is cleared or activated.
 void setInitialFocusComponentKey(K initialFocusComponentKey)
          Defines the component associated with the given key as the component that should recieve the initial focus in this edit panel.
 
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, 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

ValueChangeMapEditPanel

public ValueChangeMapEditPanel(ValueChangeMapEditModel<K,V> model)
Instantiates a new ValueChangeMapEditPanel based on the given model.

Parameters:
model - the model
Method Detail

getEditModel

public final ValueChangeMapEditModel<K,V> getEditModel()
Returns:
the edit model this panel is based on

prepareUI

public final void prepareUI(boolean setInitialFocus,
                            boolean clearUI)
Prepares the UI.

Parameters:
setInitialFocus - if true then the initial focus is set
clearUI - if true the UI is cleared.
See Also:
Refreshable.clear()

clearModelValues

public final void clearModelValues()
Clears the values from the underlying model


setInitialFocusComponent

public final JComponent setInitialFocusComponent(JComponent initialFocusComponent)
Sets the component that should receive the focus when the UI is cleared or activated. Overrides the value set via setInitialFocusComponentKey()

Parameters:
initialFocusComponent - the component
Returns:
the component
See Also:
prepareUI(boolean, boolean)

getInitialFocusComponentKey

public final K getInitialFocusComponentKey()
Returns:
the key of the component to receive initial the focus

setInitialFocusComponentKey

public final void setInitialFocusComponentKey(K initialFocusComponentKey)
Defines the component associated with the given key as the component that should recieve the initial focus in this edit panel. This is overridden by setInitialFocusComponent().

Parameters:
initialFocusComponentKey - the component key
See Also:
setInitialFocusComponent(javax.swing.JComponent)

setInitialFocus

public final void setInitialFocus()
Sets the initial focus


getComponentKeys

public final Collection<K> getComponentKeys()
Returns:
the keys that have been associated with components.

getComponent

public final JComponent getComponent(K key)
Parameters:
key - the key
Returns:
the component associated with the given key, null if no component has been associated with the given key

getComponentKey

public final K getComponentKey(JComponent component)
Parameters:
component - the component
Returns:
the key the given component is associated with, null if the component has not been associated with a key

selectComponent

public final void selectComponent(K key)
Parameters:
key - the key of the component to select

getInitialFocusComponent

protected JComponent getInitialFocusComponent()
Returns:
the component that should get the initial focus

setComponent

protected final void setComponent(K key,
                                  JComponent component)
Associates the given input component with the given property, preferably this should be called for components associated with key values.

Parameters:
key - the propertyID
component - the input component