no.g9.client.component

Class G9ComboBox

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JComboBox

no.g9.client.component.G9ComboBox

All Implemented Interfaces:

ActionListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, ListDataListener, G9ValueState, G9FieldValue

public class G9ComboBox
extends JComboBox
implements G9FieldValue, G9ValueState

The class representing a combo box.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	G9ComboBox.SelectionManager The class for managing selections by key stroke on a non-searchable combo box.

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

JComboBox.AccessibleJComboBox, JComboBox.KeySelectionManager

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

Modifier and Type	Field and Description
protected EventListenerList	vcListeners List of value changed listeners

Fields inherited from class javax.swing.JComboBox

actionCommand, dataModel, editor, 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
G9ComboBox() Creates a JComboBox with a default data model.

Method Summary

Modifier and Type	Method and Description
void	addAllItems(Collection<? extends Object> items) Adds a collection of items to the combo box.
void	addG9SelectionListener(G9SelectionListener listener) Adds a g9 selected listener to this component.
void	addItem(Collection<? extends Object> items) Adds a collection of items to the item list.
void	addItem(Object anObject)
void	addItem(String enumTitle, Class<?> enumType) Adds an enumeration to this combo.
void	addValueChangedListener(G9ValueChangedListener listener) Adds a change listener to this component.
void	display(Object anObject) Sets the specified object as the selected object.
void	editingAboutToBegin() Internal use! Will not be implemented until editable listblock is supported.
void	fireG9SelectedEvent(int oldSelection, int newSelection) Fires a g9 selection event
protected void	fireG9ValueChangedEvent(int id, Object oldValue, Object newValue) Fires a g9 value changed event.
String	format() Formats the selected value into the approriate string representation.
String	format(Object anObject) Returns the String value used when displaying the specified object
protected Object	getDisplayValue(Object anObject) Gets the value used for displaying anObject.
Object	getInitialValue() Returns the initial displayed value.
int	getNumberOfPossibleHits(String searchString, boolean caseSensitive) Returns the number of possible search hits using the specified search string.
Object	getSelectedItem()
String	getSelectedItemAsString() Returns the string representation of the selected item (viz.
Object	getValue() Gets the selected value object.
boolean	isCaseSenstitiveSearch() Returns the value used when determening if searching is case sensitive.
boolean	isChanged() Checks if the currently displayed value is the same as the initial value.
boolean	isCustomEditable() Returns the isCustomEditable property
boolean	isDontFire() Internal use, returns the dontFire flag.
boolean	isSearchable() Returns the isSearchable property
boolean	isSearchHit(String searchString) Returns true if an item (viz.
Object	parse(String formattedString) Returns a value object.
void	reset() Resets the current displayed value and the state of the combo box. It the combo list contains any elements, the first element is chosen.
void	resetState() Forces the currently displayed value to be considered the old value.
void	setCaseSensitiveSearch(boolean aFlag) Sets whether searching is case sensitive or not (only applies to searchable combos).
void	setEditable(boolean aFlag) Sets the combo to be editable.
void	setHorizontalAlignment(int alignment) Sets the horizontal alignment.
void	setInitialValue(Object value) Sets the initial value to be the specified value.
void	setInputJustification(int justification) Sets the input justification
void	setOutputJustification(int outputJustification) Sets the output justification.
void	setSearchable(boolean searchable) Sets this combo as searchable.
void	setSelectAllOnFocus(boolean selectAllOnFocus) Internal use.
void	setSelectedItem(Object anObject)
void	setSelectedItemG9(Object value) Deprecated. This method is now obsolete and should not be used. Use setSelectedItem(Object) instead.
void	setSorted(boolean isSorted) Sets the isSorted property.
void	setUsedAsListblockEditor(DefaultCellEditor tx) Internal use! Will not be implemented until editable listblock is supported.
void	setValue(Object value) Selects a value, this is the same as invoking display(value).

Methods inherited from class javax.swing.JComboBox

actionPerformed, actionPropertyChanged, addActionListener, 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, 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, setSelectedIndex, 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, 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

Field Detail

vcListeners

protected EventListenerList vcListeners

List of value changed listeners

Constructor Detail

G9ComboBox

public G9ComboBox()

Creates a JComboBox with a default data model. The default data model is an empty list of objects. Use addItem to add items. By default the first item in the data model becomes selected.

See Also:

DefaultComboBoxModel

Method Detail

fireG9ValueChangedEvent

protected void fireG9ValueChangedEvent(int id,
                                       Object oldValue,
                                       Object newValue)

Fires a g9 value changed event.

Parameters:

id - the type of event

oldValue - the old value

newValue - the new value

format

public String format(Object anObject)

Returns the String value used when displaying the specified object

Parameters:

anObject - the object holding the value

Returns:

the value used for displaying the object.

format

public String format()

Formats the selected value into the approriate string representation.

Specified by:

format in interface G9FieldValue

Returns:

the selected value as a String

getValue

public Object getValue()

Gets the selected value object. E.g. if this combo displays domainObject.foo, an instance of foo is returned.

Specified by:

getValue in interface G9FieldValue

Returns:

the selected item's display value.

parse

public Object parse(String formattedString)

Description copied from interface: G9FieldValue

Returns a value object. The specified string must be a representation of a value in the internal format.

Specified by:

parse in interface G9FieldValue

Parameters:

formattedString - (missing javadoc)

Returns:

(missing javadoc)

setValue

public void setValue(Object value)

Selects a value, this is the same as invoking display(value).

Specified by:

setValue in interface G9FieldValue

Parameters:

value - the value to set

See Also:

display(Object)

addValueChangedListener

public void addValueChangedListener(G9ValueChangedListener listener)

Description copied from interface: G9ValueState

Adds a change listener to this component. The change listener will be notified when a value changed event occurs.

Specified by:

addValueChangedListener in interface G9ValueState

Parameters:

listener - the listener to add

display

public void display(Object anObject)

Sets the specified object as the selected object. If the specified object is "null", and the combo is not editable, it will only become the selcted value if the list contains a null value, otherwise no selection is made. If the specified Object is a String, the corresponding item will be selected (if it exists). Note that invoking this method does not trigger a selected event. If you want the selected event to be triggered, use setSelectedItem(Object).

Specified by:

display in interface G9ValueState

Parameters:

anObject - the object to select.

getInitialValue

public Object getInitialValue()

Description copied from interface: G9ValueState

Returns the initial displayed value.

Specified by:

getInitialValue in interface G9ValueState

Returns:

the initial displayed value

isChanged

public boolean isChanged()

Description copied from interface: G9ValueState

Checks if the currently displayed value is the same as the initial value. The initial value is updated when the component is updated programaticly.

Specified by:

isChanged in interface G9ValueState

Returns:

true if the displayed value differs from the initial value.

getSelectedItem

public Object getSelectedItem()

Overrides:

getSelectedItem in class JComboBox

reset

public void reset()

Resets the current displayed value and the state of the combo box.
It the combo list contains any elements, the first element is chosen. Otherwise, if the combo is editable, the editfield is cleared.

resetState

public void resetState()

Description copied from interface: G9ValueState

Forces the currently displayed value to be considered the old value.

Specified by:

resetState in interface G9ValueState

setInitialValue

public void setInitialValue(Object value)

Sets the initial value to be the specified value.

If the specified initial value is "null", and this the combo is not editable, and the list does not contain "null", the first item is choosen as the initial value. If the specified value is a String, the list is searched for an item that matches the string. If found, that item is used.

Specified by:

setInitialValue in interface G9ValueState

Parameters:

value - the (new) initial value.

setSelectAllOnFocus

public void setSelectAllOnFocus(boolean selectAllOnFocus)

Internal use.

Sets the select all on focus property.

Parameters:

selectAllOnFocus - (missing javadoc)

getSelectedItemAsString

public String getSelectedItemAsString()

Returns the string representation of the selected item (viz. the displayed text).

Returns:

the selected item's displayed text.

setSelectedItemG9

@Deprecated
public void setSelectedItemG9(Object value)

Deprecated. This method is now obsolete and should not be used. Use setSelectedItem(Object) instead.

Sets the selected item to be the specified value.

Parameters:

value - the value to select

See Also:

JComboBox.setSelectedItem(Object)

addItem

public void addItem(Object anObject)

Overrides:

addItem in class JComboBox

addItem

public void addItem(Collection<? extends Object> items)

Adds a collection of items to the item list. This method works only if the JComboBox uses a mutable data model.

Warning: Focus and keyboard navigation problems may arise if you add duplicate String objects. A workaround is to add new objects instead of String objects and make sure that the toString() method is defined, see JComboBox.addItem(Object)

Parameters:

items - the Collection of objects to add to the list

See Also:

MutableComboBoxModel

addAllItems

public void addAllItems(Collection<? extends Object> items)

Adds a collection of items to the combo box. Forwards the call to addItem(Collection).

Parameters:

items - a collection of items.

See Also:

addItem(Collection)

addItem

public void addItem(String enumTitle,
                    Class<?> enumType)

Adds an enumeration to this combo.

Parameters:

enumTitle - the title of the enum (current value)

enumType - the type of enum

setInputJustification

public void setInputJustification(int justification)

Sets the input justification

Parameters:

justification - value specifying the input justification. See JTextField.setHorizontalAlignment(int) for a list of valid parameters.

setOutputJustification

public void setOutputJustification(int outputJustification)

Sets the output justification.

Parameters:

outputJustification - value specifying the output justification. See JTextField.setHorizontalAlignment(int) for a list of valid parameters.

setHorizontalAlignment

public void setHorizontalAlignment(int alignment)

Sets the horizontal alignment.

Parameters:

alignment - the alignment, see JTextField.setHorizontalAlignment(int) for a list of valid parameters.

setSorted

public void setSorted(boolean isSorted)

Sets the isSorted property. If set to true, the contents of this combo will be sorted in the natural, descending order.

Parameters:

isSorted - (missing javadoc)

getDisplayValue

protected Object getDisplayValue(Object anObject)

Gets the value used for displaying anObject.

Parameters:

anObject - the object to get the display value of

Returns:

the value used for displaying the specified object.

setEditable

public void setEditable(boolean aFlag)

Sets the combo to be editable. Note that even though a combo is set to uneditble, it still might be editable if it is searchable. The difference is then determined in how the search is performed. In either case, editing the combo field does not affect the combo list.

Overrides:

setEditable in class JComboBox

Parameters:

aFlag - a boolean value where true indicates that this combo is editable.

getNumberOfPossibleHits

public int getNumberOfPossibleHits(String searchString,
                                   boolean caseSensitive)

Returns the number of possible search hits using the specified search string. E.g. if the list contains mont-names, the string "Ju" will give two possible hits (mathces both "June" and "Juli"). Note that even if a search string hits more than one item in the list, it does not mean that an item can not be uniquly identified using the search string. E.g. if the list contains (among other items) the texts "foo" and "foo bar", the search string "foo" gives two hits, but is sufficently accurate to uniquely identify the "foo" item. The second parameter determines if case is significant or not.

Parameters:

searchString - the string used for searching.

caseSensitive - a boolean value where false indicates that case is not significant.

Returns:

the number of itemes starting with the specified string

isSearchHit

public boolean isSearchHit(String searchString)

Returns true if an item (viz. the string represenatation of that item) equals the search string.

Parameters:

searchString - the string used for searching

Returns:

true if an exact match is found.

setCaseSensitiveSearch

public void setCaseSensitiveSearch(boolean aFlag)

Sets whether searching is case sensitive or not (only applies to searchable combos). Default value is false.

Parameters:

aFlag - a boolean value where true indicates that searching is case sensitive.

isCaseSenstitiveSearch

public boolean isCaseSenstitiveSearch()

Returns the value used when determening if searching is case sensitive.

Returns:

the caseSensitiveSearch property

See Also:

setCaseSensitiveSearch(boolean)

setSearchable

public void setSearchable(boolean searchable)

Sets this combo as searchable. Note that setting a combo to searchable, implies that it is also editable (invoking isEditable on a searchable combo results in true. In order to make it true editable, one must invoke the setEditable method.

Parameters:

searchable - a boolean value, true indicating that this combo is searchable.

setSelectedItem

public void setSelectedItem(Object anObject)

Overrides:

setSelectedItem in class JComboBox

isSearchable

public boolean isSearchable()

Returns the isSearchable property

Returns:

true if this combo is searchable.

See Also:

setSearchable(boolean)

isCustomEditable

public boolean isCustomEditable()

Returns the isCustomEditable property

Returns:

true if this combo is editable

See Also:

setEditable(boolean)

addG9SelectionListener

public void addG9SelectionListener(G9SelectionListener listener)

Adds a g9 selected listener to this component.

Parameters:

listener - the listener

fireG9SelectedEvent

public void fireG9SelectedEvent(int oldSelection,
                                int newSelection)

Fires a g9 selection event

Parameters:

oldSelection - the index of the old selection

newSelection - the index of the new selection

setUsedAsListblockEditor

public void setUsedAsListblockEditor(DefaultCellEditor tx)

Internal use! Will not be implemented until editable listblock is supported. Sets the default listblock cell editor.

Parameters:

tx - the cell editor.

editingAboutToBegin

public void editingAboutToBegin()

Internal use! Will not be implemented until editable listblock is supported. Signals that edit is about to begin.

isDontFire

public boolean isDontFire()

Internal use, returns the dontFire flag. Used when updating expressions, to determine wheter the target combo should fire a selected event or not.

Returns:

the dontFire flag.