de.must.wuic

Class HalfDataComboBox

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JComboBox<java.lang.Object>

de.must.wuic.MustComboBox

de.must.wuic.HalfDataComboBox

All Implemented Interfaces:

DataChangeListener, ModifiedInformer, ContextHelp, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ListDataListener

Direct Known Subclasses:

DataComboBox, ParamHalfDataComboBox

public class HalfDataComboBox
extends MustComboBox
implements DataChangeListener, ModifiedInformer

Combo box whose content is filled by a database table.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HalfDataComboBox.Variant The variant builder wrapper to simplify construction detail definition.

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

javax.swing.JComboBox.AccessibleJComboBox, javax.swing.JComboBox.KeySelectionManager

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	containsNoSpecification
protected DataObject	contentDataObject
protected Identifier	editBeginValue
protected java.lang.String	filterCondition
protected IdentifierTextTable	identifierTable
protected java.lang.String	inactiveColumnName
protected java.lang.String	nameForNoChoice
protected java.lang.String[]	orderByColumnNames
static java.lang.String	SPECIAL_NAME_FOR_NO_CHOICE_WHICH_MEANS_NOT_APPLICABLE
protected java.lang.String[]	specialChoices
protected java.lang.String[]	visibleColumnNames
protected java.util.Hashtable<Identifier,java.lang.String>	weakItems
static int	WIDTH_FITTING_TO_CONTENT

Fields inherited from class de.must.wuic.MustComboBox

programmaticChange

Fields inherited from class javax.swing.JComboBox

actionCommand, dataModel, isEditable, keySelectionManager, lightWeightPopupEnabled, maximumRowCount, renderer, selectedItemReminder

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
HalfDataComboBox(DataObject sourceDataObject, java.lang.String visibleColumnName) Constructs a new combo box.
HalfDataComboBox(DataObject sourceDataObject, java.lang.String visibleColumnName, HalfDataComboBox.Variant variant) Constructs a new combo box.
HalfDataComboBox(DataObject sourceDataObject, java.lang.String visibleColumnName, java.lang.String orderByColumnName, java.lang.String nameForNoChoice) Constructs a new combo box.
HalfDataComboBox(DataObject sourceDataObject, java.lang.String visibleColumnName, java.lang.String orderByColumnName, java.lang.String nameForNoChoice, int width) Constructs a new combo box.
HalfDataComboBox(DataObject sourceDataObject, java.lang.String visibleColumnName, java.lang.String orderByColumnName, java.lang.String nameForNoChoice, int width, boolean fillWhileConstruction, boolean containsNoSpecification) Constructs a new combo box.

Method Summary

Modifier and Type	Method and Description
void	addItem(java.lang.String item, Identifier identifier) Adds an item to the combo box.
void	dataChangePerformed(DataChangedEvent e)
protected void	fill() Fills or refills the content of the data combo box by reading the source data object.
void	fill(java.lang.String whereCondition) Fills or refills the content of the data combo box by reading the source data object.
protected void	finalize()
void	free() Frees external resources.
Identifier	getEditBeginValue() Returns the value of the input field before user was able to edit it.
Identifier	getSelectedIdentifier() Returns the identifier of the selected entry.
java.lang.String	getSelectedItemWithoutNameForNoChoice() Returns the selected item as String after replacing '' by ''.
protected java.lang.String	getTranslation(java.lang.String resourceKey) Returns a text in the corresponding language according to the locale specific resource bundle of the package.
boolean	isFilled() Returns true if the component has a value.
boolean	isModified() Indicates whether the component's value differs from its initial value.
boolean	isSpecialChoice() Returns true if the selected item is not the placeholder for "none" or "any".
protected void	removeItem(Identifier identifier)
void	selectAll() Selects all input of the component, if it is supported - e.g. in JTextField.
void	setFilterCondition(java.lang.String filterCondition) Sets the filter condition, e.g. not to present entries declared as inactive
void	setFilterCondition(java.lang.String columnName, boolean booleanValue) Sets a boolean filter condition, e.g. not to present entries declared as inactive - uses the appropriate SQL value to build the comparison string
void	setHelpContext(java.lang.String helpTopic) Sets the component's context help.
void	setInactiveColumnName(java.lang.String inactiveColumnName) Sets the column name to determine inactive items.
void	setNoSpecialChoice() Selects the item to be used to indicate "no special choice"
boolean	setSelectedIdentifier(Identifier selectedIdentifier) Selects an item by the identifier.
void	setSelectedIdentifierAsBeginValue(Identifier identifier) Selects an item of the combo box by identifier.
void	setSpecialChoices(java.lang.String[] specialChoices) Sets special choices to be displayed after 'name for no choice' and values from source data object.

Methods inherited from class de.must.wuic.MustComboBox

getBackground, getHelpTarget, getHelpTopic, getIndexIfUnique, resetEditBeginValue, setEditable, setEditableForUserTyping, setEditableForUserTyping, setEditableForUserTyping, setHelpContext, setSelectedIndex, setSelectedIndexAsEditBeginValue, setSelectedItem, setSelectedItemAsEditBeginValue

Methods inherited from class javax.swing.JComboBox

actionPerformed, actionPropertyChanged, addActionListener, addItem, addItemListener, addPopupMenuListener, configureEditor, configurePropertiesFromAction, contentsChanged, createActionPropertyChangeListener, createDefaultKeySelectionManager, fireActionEvent, fireItemStateChanged, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getAction, getActionCommand, getActionListeners, getEditor, getItemAt, getItemCount, getItemListeners, getKeySelectionManager, getMaximumRowCount, getModel, getPopupMenuListeners, getPrototypeDisplayValue, getRenderer, getSelectedIndex, getSelectedItem, getSelectedObjects, getUI, getUIClassID, hidePopup, insertItemAt, installAncestorListener, intervalAdded, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, paramString, processKeyBinding, processKeyEvent, removeActionListener, removeAllItems, removeItem, removeItemAt, removeItemListener, removePopupMenuListener, selectedItemChanged, selectWithKeyChar, setAction, setActionCommand, setEditor, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setUI, showPopup, 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, 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, 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, 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, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SPECIAL_NAME_FOR_NO_CHOICE_WHICH_MEANS_NOT_APPLICABLE

public static final java.lang.String SPECIAL_NAME_FOR_NO_CHOICE_WHICH_MEANS_NOT_APPLICABLE

See Also:

Constant Field Values

WIDTH_FITTING_TO_CONTENT

public static final int WIDTH_FITTING_TO_CONTENT

See Also:

Constant Field Values

contentDataObject

protected DataObject contentDataObject

visibleColumnNames

protected java.lang.String[] visibleColumnNames

orderByColumnNames

protected java.lang.String[] orderByColumnNames

nameForNoChoice

protected java.lang.String nameForNoChoice

specialChoices

protected java.lang.String[] specialChoices

containsNoSpecification

protected boolean containsNoSpecification

filterCondition

protected java.lang.String filterCondition

inactiveColumnName

protected java.lang.String inactiveColumnName

identifierTable

protected IdentifierTextTable identifierTable

editBeginValue

protected Identifier editBeginValue

weakItems

protected java.util.Hashtable<Identifier,java.lang.String> weakItems

Constructor Detail

HalfDataComboBox

public HalfDataComboBox(DataObject sourceDataObject,
                        java.lang.String visibleColumnName,
                        HalfDataComboBox.Variant variant)

Constructs a new combo box.

Parameters:

sourceDataObject - the source data object

variant - the wrapper containing variant definitions.

HalfDataComboBox

public HalfDataComboBox(DataObject sourceDataObject,
                        java.lang.String visibleColumnName)

Constructs a new combo box.

Parameters:

sourceDataObject - the source data object

visibleColumnName - the name of the column to be displayed

HalfDataComboBox

public HalfDataComboBox(DataObject sourceDataObject,
                        java.lang.String visibleColumnName,
                        java.lang.String orderByColumnName,
                        java.lang.String nameForNoChoice)

Constructs a new combo box.

Parameters:

sourceDataObject - the source data object

visibleColumnName - the name of the column to be displayed

orderByColumnName - the sorting column name of the content data object

nameForNoChoice - the expression to be used to indicate "no choice"

HalfDataComboBox

public HalfDataComboBox(DataObject sourceDataObject,
                        java.lang.String visibleColumnName,
                        java.lang.String orderByColumnName,
                        java.lang.String nameForNoChoice,
                        int width)

Constructs a new combo box.

Parameters:

sourceDataObject - the source data object

visibleColumnName - the name of the column to be displayed

orderByColumnName - the sorting column name of the content data object

nameForNoChoice - the expression to be used to indicate "no choice"

width - the width of the component - if 0 it's automatically sized

HalfDataComboBox

public HalfDataComboBox(DataObject sourceDataObject,
                        java.lang.String visibleColumnName,
                        java.lang.String orderByColumnName,
                        java.lang.String nameForNoChoice,
                        int width,
                        boolean fillWhileConstruction,
                        boolean containsNoSpecification)

Constructs a new combo box.

Parameters:

sourceDataObject - the source data object

visibleColumnName - the name of the column to be displayed

orderByColumnName - the sorting column name of the content data object

nameForNoChoice - the expression to be used to indicate "no choice"

width - the width of the component - if 0 it's automatically sized

fillWhileConstruction - whether or not this combo box should be filled while construction process

containsNoSpecification - whether or not this combo box should include an item to represent 'nothing'

Method Detail

setSpecialChoices

public void setSpecialChoices(java.lang.String[] specialChoices)

Sets special choices to be displayed after 'name for no choice' and values from source data object. This can only work with IdentifyTemplate.IDENTIFIED_BY_STRING!

Parameters:

specialChoices - the specialChoices to set.

setHelpContext

public void setHelpContext(java.lang.String helpTopic)

Sets the component's context help.

Overrides:

setHelpContext in class MustComboBox

Parameters:

helpTopic - the context help's topic

setFilterCondition

public void setFilterCondition(java.lang.String columnName,
                               boolean booleanValue)

Sets a boolean filter condition, e.g. not to present entries declared as inactive - uses the appropriate SQL value to build the comparison string

Parameters:

columnName - the column name for the boolean condition

booleanValue - the boolean value to select

setFilterCondition

public void setFilterCondition(java.lang.String filterCondition)

Sets the filter condition, e.g. not to present entries declared as inactive

Parameters:

filterCondition - the condition to reduce the content

setInactiveColumnName

public void setInactiveColumnName(java.lang.String inactiveColumnName)

Sets the column name to determine inactive items. Inactive items will only be presented if assigned.

Parameters:

inactiveColumnName - the name to determine inactive items

getTranslation

protected java.lang.String getTranslation(java.lang.String resourceKey)

Returns a text in the corresponding language according to the locale specific resource bundle of the package.

Parameters:

resourceKey - the key of the resource to retrieve

Returns:

the resource

fill

protected void fill()

Fills or refills the content of the data combo box by reading the source data object.

fill

public void fill(java.lang.String whereCondition)

Fills or refills the content of the data combo box by reading the source data object.

Parameters:

whereCondition - the where condition to shorten the content

selectAll

public void selectAll()

Selects all input of the component, if it is supported - e.g. in JTextField. Allows easy new input, because the previous value is reset when the first key stroke occurs.

addItem

public void addItem(java.lang.String item,
                    Identifier identifier)

Adds an item to the combo box.

Parameters:

item - the item to add

identifyValueInt - the identifier of the item to add

removeItem

protected void removeItem(Identifier identifier)

setSelectedIdentifier

public boolean setSelectedIdentifier(Identifier selectedIdentifier)

Selects an item by the identifier.

Parameters:

selectedIdentifier - the identifier to select an entry

Returns:

true

setSelectedIdentifierAsBeginValue

public void setSelectedIdentifierAsBeginValue(Identifier identifier)

Selects an item of the combo box by identifier.

Parameters:

selectIdentifier - the identifier (primary key) of the item to select

getSelectedIdentifier

public Identifier getSelectedIdentifier()

Returns the identifier of the selected entry.

Returns:

the identifier of the selected entry

getSelectedItemWithoutNameForNoChoice

public java.lang.String getSelectedItemWithoutNameForNoChoice()

Returns the selected item as String after replacing '' by ''.

Returns:

the selected item as String after replacing '' by ''

isFilled

public boolean isFilled()

Returns true if the component has a value.

Returns:

true if the component has a value

getEditBeginValue

public Identifier getEditBeginValue()

Returns the value of the input field before user was able to edit it.

Returns:

the value of the input field before user was able to edit it

isModified

public boolean isModified()

Description copied from interface: ModifiedInformer

Indicates whether the component's value differs from its initial value.

Specified by:

isModified in interface ModifiedInformer

Overrides:

isModified in class MustComboBox

Returns:

true if the component's value differs from its initial value

isSpecialChoice

public boolean isSpecialChoice()

Returns true if the selected item is not the placeholder for "none" or "any".

Returns:

true if the selected item is not the placeholder for "none" or "any"

setNoSpecialChoice

public void setNoSpecialChoice()

Selects the item to be used to indicate "no special choice"

dataChangePerformed

public void dataChangePerformed(DataChangedEvent e)

Specified by:

dataChangePerformed in interface DataChangeListener

free

public void free()

Frees external resources. May be called manually without waiting for the garbage collector.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable