com.fathzer.soft.ajlib.swing.widget

Class AbstractSelector<T,V>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.fathzer.soft.ajlib.swing.widget.AbstractSelector<T,V>

Type Parameters:

T - The class of the items selected by the selector.

V - The class of the constructor argument.

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public abstract class AbstractSelector<T,V>
extends JPanel

An abstract widget composed of an optional label, a combo box and a new button.
It is typically used to select a value in a list of possible values.
This widget defines a property that reflects the selection changes. Its name is defined by the method getPropertyName.
It also allows the combo box display to be customized using method getDefaultRenderedValue.

Author:

Jean-Marc Astesana
License: LGPL v3

See Also:

getPropertyName(), getDefaultRenderedValue(Object), 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

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

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

Constructors

Constructor and Description
AbstractSelector(V parameters) Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract T	createNew() Creates a new element.
T	get() Gets the selected value.
ComboBox	getCombo() Gets the ComboBox.
protected String	getComboTip() Gets the combo's initial tooltip.
protected Component	getCustomizedRenderer(Component renderer, T value, int index, boolean isSelected, boolean cellHasFocus) Returns a customized renderer used to display a specific value.
protected Object	getDefaultRenderedValue(T value) Returns the default value displayed in the combo box.
JLabel	getJLabel() Gets the label.
protected String	getLabel() Gets the widget's label.
JButton	getNewButton() Gets the new button.
protected Icon	getNewButtonIcon()
protected String	getNewButtonTip() Gets the new button's initial tooltip.
V	getParameters() Gets the parameters of the widget.
protected abstract String	getPropertyName() Gets the name of the property that changes when the selection changes.
protected boolean	isNewButtonVisible()
protected abstract void	populateCombo() Populates the combo.
void	refresh() Refreshes the widget when the parameters has changed.
void	set(T value) Sets the selected value.
void	setEnabled(boolean enabled)
void	setParameters(V parameters) Sets the parameters of the widget.
protected void	setSelectionAfterRefresh(T old) Sets the combo selection during a refresh.
void	setToolTipText(String tip) Sets the combo tooltip.

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSelector

public AbstractSelector(V parameters)

Constructor.

Parameters:

parameters - The init parameters of the selector (that object will be used to populate the combo).

Method Detail

getNewButtonIcon

protected Icon getNewButtonIcon()

getParameters

public V getParameters()

Gets the parameters of the widget.

Returns:

The argument passed to the constructor.

See Also:

AbstractSelector(Object)

setParameters

public void setParameters(V parameters)

Sets the parameters of the widget.
The refresh method is called.

Parameters:

parameters - The new parameters

populateCombo

protected abstract void populateCombo()

Populates the combo.
You should override this method to define how the combo is populated.
Usually, you will use the getParameters method in order to retrieve the argument of the constructor.
Note that this method is always called with a empty combo.

See Also:

getParameters()

refresh

public void refresh()

Refreshes the widget when the parameters has changed.
This method is called when the widget parameters are changed by setParameters.
It removes all old combo items, then calls populateCombo and setSelectionAfterRefresh.
A property change is thrown if the selection changes (and the combo action is not disabled).
The actionEnabled attribute of the combo is unchanged.

See Also:

ComboBox.setActionEnabled(boolean), populateCombo(), setSelectionAfterRefresh(Object)

setSelectionAfterRefresh

protected void setSelectionAfterRefresh(T old)

Sets the combo selection during a refresh.
By default, this method selects the last item selected, if it is still available.

Parameters:

old - the last selected item before refresh was performed.

getJLabel

public JLabel getJLabel()

Gets the label.

Returns:

a JLabel

getNewButton

public JButton getNewButton()

Gets the new button.

Returns:

a JButton

isNewButtonVisible

protected boolean isNewButtonVisible()

getCombo

public ComboBox getCombo()

Gets the ComboBox.

Returns:

a CoolJComboBox.

getCustomizedRenderer

protected Component getCustomizedRenderer(Component renderer,
                                          T value,
                                          int index,
                                          boolean isSelected,
                                          boolean cellHasFocus)

Returns a customized renderer used to display a specific value.
Please note that this method is never called when combo's renderer is set by getCombo().setRenderer(...) method.

Parameters:

renderer - The default renderer

value - The value to be rendered

index - The index of the value in the combo

isSelected - True if the value is selected

cellHasFocus - True if the value has the focus

Returns:

a customized renderer, by default this method returns the renderer argument.

getDefaultRenderedValue

protected Object getDefaultRenderedValue(T value)

Returns the default value displayed in the combo box.
Default means that this value is used by the default renderer. If you define your own ListCellRenderer, this method will never been called. The default implementation returns the value itself (the default renderer will display the toString of that object). You may override this method in order to customized the combo box displayed

Parameters:

value - The value to be displayed (it can be null)

Returns:

The value that will be displayed.

createNew

protected abstract T createNew()

Creates a new element. This method is called when the new button is clicked. It should ask for the new instance to be created, then, adds it to the object used by method populateCombo, then, returns the created object.

Returns:

The created object, null if the object creation was cancelled.

getLabel

protected String getLabel()

Gets the widget's label.

Returns:

a String, null to have no label.

getComboTip

protected String getComboTip()

Gets the combo's initial tooltip.

Returns:

a String, null to have no tooltip.

getNewButtonTip

protected String getNewButtonTip()

Gets the new button's initial tooltip.

Returns:

a String, null to have no tooltip.

getPropertyName

protected abstract String getPropertyName()

Gets the name of the property that changes when the selection changes.

Returns:

a String

get

public T get()

Gets the selected value.

Returns:

the selected value.

set

public void set(T value)

Sets the selected value.

Parameters:

value - The value to select

setToolTipText

public void setToolTipText(String tip)

Sets the combo tooltip.
This method is a shortcut to this.getCombo().setToolTipText(text)

Overrides:

setToolTipText in class JComponent

Parameters:

tip - The tooltip text.

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class JComponent