de.must.wuic

Class VariableChoice

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.VariableChoice

All Implemented Interfaces:

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:

DataVariableChoice, ParamChoice

public class VariableChoice
extends MustComboBox
implements ModifiedInformer

A JComboBox with statically filled content via keys and their descriptions.

See Also:

Serialized Form

Nested Class Summary

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 java.lang.String	editBeginValue

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
VariableChoice(KeyValuePair[] keyValuePairs) Constructs an new variable choice with the specified content.
VariableChoice(KeyValuePair[] keyValuePairs, boolean noChoicePossible) Constructs an new variable choice with the specified content and offer control.
VariableChoice(KeyValuePair[] keyValuePairs, java.lang.String nameForNoChoice) Constructs an new variable choice with the specified content and offer control.
VariableChoice(java.lang.String[][] content) Constructs an new variable choice with the specified content.
VariableChoice(java.lang.String[][] content, boolean noChoicePossible) Constructs an new variable choice with the specified content and offer control.
VariableChoice(java.lang.String[][] content, boolean noChoicePossible, boolean suppressKey) Constructs an new variable choice with the specified content and offer control.
VariableChoice(java.lang.String[][] content, boolean noChoicePossible, java.lang.String nameForNoChoice) Constructs an new variable choice with the specified content and offer control.
VariableChoice(java.lang.String[][] content, boolean noChoicePossible, java.lang.String nameForNoChoice, boolean suppressKey) Constructs an new variable choice with the specified content and offer control.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSelectedItemKey() Returns the key of the selected item.
int	getSelectedItemKeyAsInt() Returns the key of the selected item as integer value.
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	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".
void	setNoSpecialChoice() Selects the item to be used to indicate "no special choice"
void	setSelectedItemKey(java.lang.String key) Selects the item by its key.
void	setSelectedItemKeyAsBeginValue(java.lang.String key) Selects an item of the combo box by identifier.

Methods inherited from class de.must.wuic.MustComboBox

getBackground, getHelpTarget, getHelpTopic, getIndexIfUnique, resetEditBeginValue, setEditable, setEditableForUserTyping, setEditableForUserTyping, setEditableForUserTyping, setHelpContext, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

editBeginValue

protected java.lang.String editBeginValue

Constructor Detail

VariableChoice

public VariableChoice(java.lang.String[][] content)

Constructs an new variable choice with the specified content.

Parameters:

content - the statically filled content, each line is a pair of key and value.

VariableChoice

public VariableChoice(java.lang.String[][] content,
                      boolean noChoicePossible)

Constructs an new variable choice with the specified content and offer control.

Parameters:

content - the statically filled content, each line is a pair of key and value

noChoicePossible - if true, an item is offered which represents the "no choice"

VariableChoice

public VariableChoice(java.lang.String[][] content,
                      boolean noChoicePossible,
                      boolean suppressKey)

Constructs an new variable choice with the specified content and offer control.

Parameters:

content - the statically filled content, each line is a pair of key and value

noChoicePossible - if true, an item is offered which represents the "no choice"

suppressKey - whether or not keys should be suppressed in ComboBox

VariableChoice

public VariableChoice(java.lang.String[][] content,
                      boolean noChoicePossible,
                      java.lang.String nameForNoChoice)

Constructs an new variable choice with the specified content and offer control.

Parameters:

content - the statically filled content, each line is a pair of key and value

noChoicePossible - if true, an item is offered which represents the "no choice"

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

VariableChoice

public VariableChoice(java.lang.String[][] content,
                      boolean noChoicePossible,
                      java.lang.String nameForNoChoice,
                      boolean suppressKey)

Constructs an new variable choice with the specified content and offer control.

Parameters:

content - the statically filled content, each line is a pair of key and value

noChoicePossible - if true, an item is offered which represents the "no choice"

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

suppressKey - whether or not keys should be suppressed in ComboBox

VariableChoice

public VariableChoice(KeyValuePair[] keyValuePairs)

Constructs an new variable choice with the specified content.

Parameters:

keyValuePairs - the content as an array of key value pairs

VariableChoice

public VariableChoice(KeyValuePair[] keyValuePairs,
                      java.lang.String nameForNoChoice)

Constructs an new variable choice with the specified content and offer control.

Parameters:

keyValuePairs - the content as an array of key value pairs

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

VariableChoice

public VariableChoice(KeyValuePair[] keyValuePairs,
                      boolean noChoicePossible)

Constructs an new variable choice with the specified content and offer control.

Parameters:

keyValuePairs - the content as an array of key value pairs

noChoicePossible - if true, an item is offered which represents the "no choice"

Method Detail

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

getSelectedItemKeyAsInt

public int getSelectedItemKeyAsInt()

Returns the key of the selected item as integer value.

Returns:

the key of the selected item as integer value

getSelectedItemKey

public java.lang.String getSelectedItemKey()

Returns the key of the selected item.

Returns:

the key of the selected item

setSelectedItemKeyAsBeginValue

public void setSelectedItemKeyAsBeginValue(java.lang.String key)

Selects an item of the combo box by identifier.

Parameters:

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

setSelectedItemKey

public void setSelectedItemKey(java.lang.String key)

Selects the item by its key.

Parameters:

key - the key of the item to select

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"

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