org.gvsig.gui.beans.comboboxconfigurablelookup

Class DefaultComboBoxConfigurableLookUpModel

java.lang.Object

javax.swing.AbstractListModel

org.gvsig.gui.beans.comboboxconfigurablelookup.DefaultComboBoxConfigurableLookUpModel

All Implemented Interfaces:

Serializable, ComboBoxModel, ListModel, MutableComboBoxModel, IComboBoxLookUp

public class DefaultComboBoxConfigurableLookUpModel
extends AbstractListModel
implements ComboBoxModel, MutableComboBoxModel, Serializable, IComboBoxLookUp

Re-implementation of DefaultComboBoxModel adapted for the behavior needed to look up items.

This model has configurable behaviour using flags.

DefaultComboBoxConfigurableLookUpModel represents the model used by a JComboBoxLookUpConfigurable, according the MVC (Model-View-Controller) pattern.

Flags:

• ItemsOrder: order in which items will be showed: maintain position (according the items were introduced); alphabetical order (according the local rules); or disordered.
  + MAINTAIN_POSITION: in the same position as they are stored.
  + ALPHABETICAL_ORDERED: in alphabetical order (according a local language rules).
  + MAINTAIN_AGENT_POSITIONS: in the same position as the are returned by the look up agent.
• ShowAllItemsInListBox: show all items in list box always, or only items that match with the text written according the ILookUp agent.
  + SHOW_ALL_ITEMS: shows all items of the model always.
  + SHOW_ONLY_MATCHES: shows only the items , or only items that match with the text written according the ILookUp agent.
• LanguageRules: language rules (es_ES, en_US, fr_FR, ...)
• CaseSensitive: consider or ignore the case sensitive looking up the items with the ILookUp agent.
  + CASE_SENSITIVE: discriminates between lower and upper cases.
  + CASE_INSENSITIVE: doesn't discriminate between lower and upper cases.

Default flag values are:

• ItemsOrder: MAINTAIN_AGENT_POSITIONS.
• ShowAllItemsInListBox: false (that's equal to ''SHOW_ONLY_MATCHES'').
• LanguageRules: en_EN (English from England).
• CaseSensitive: true (that's equal to ''CASE_SENSITIVE'').

See Also:

DefaultComboBoxModel, JComboBoxConfigurableLookUp, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DefaultComboBoxConfigurableLookUpModel.VectorUtilities New functionality to work with vectors (of elements).

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALPHABETICAL_ORDERED
static boolean	CASE_INSENSITIVE
static boolean	CASE_SENSITIVE
static boolean	DEFAULT_CASE_SENSITIVE_CONFIGURATION
static int	DEFAULT_ITEMS_ORDER_CONFIGURATION
static String	DEFAULT_LANGUAGE_RULES_CONFIGURATION
static boolean	DEFAULT_SHOW_ALL_ITEMS_IN_LIST_BOX_CONFIGURATION
static int	MAINTAIN_AGENT_POSITIONS
static int	MAINTAIN_POSITION
static boolean	SHOW_ALL_ITEMS
static boolean	SHOW_ONLY_MATCHES

Fields inherited from class javax.swing.AbstractListModel

listenerList

Constructor Summary

Constructors

Constructor and Description
DefaultComboBoxConfigurableLookUpModel()
DefaultComboBoxConfigurableLookUpModel(Object[] items)
DefaultComboBoxConfigurableLookUpModel(Vector<Object> vector)

Method Summary

Modifier and Type	Method and Description
void	addElement(Object object)
Vector<Object>	getData() Returns all elements stored in this model, according the order they were added.
Vector<Object>	getDataAccordingItemsOrder() Gets the data stored in this model according the criterion of the itemsOrder parameter.
Object	getElementAt(int index)
boolean	getEventNotificationEnabled() Gets if the notification of events in this model is enabled.
int	getIndexOf(Object object)
int	getItemsOrder() Returns the 'itemsOrder' configuration value of this component.
String	getLocaleRules() Returns the 'localeRules' configuration value of this component.
ILookUp	getLookUpAgent() Gets the agent used with the logic for looking up the items of this model, considering the text written.
Object	getSelectedItem()
int	getSize()
protected void	initialize() Initializes some attributes.
void	insertElementAt(Object object, int index)
boolean	isCaseSensitive() Returns the 'caseSensitive' configuration value of this component.
boolean	isShowAllItemsInListBox() Returns the 'showAllItemsInListBox' configuration value of this component.
protected List<Object>	lookUp() Invokes the agent to execute its search on all items alphabetically sort ordered, considering the text written and the case sensitive configuration.
void	removeAllElements()
void	removeElement(Object object)
void	removeElementAt(int index)
void	setCaseSensitive(boolean caseSensitive) Sets the 'caseSensitive' configuration value for this component.
protected void	setDefaultBehaviorFlagsConfiguration() Sets the default values of the flags.
void	setEventNotificationEnabled(boolean b) Sets enabled or disabled the notification of events in this model.
void	setItemsOrder(int itemsOrder) Sets the 'itemsOrder' configuration value for this component.
void	setLocaleRules(String localeRules) Sets the 'localeRules' configuration value for this component.
void	setLookUpAgent(ILookUp agent) Sets the agent with the logic for looking up the items of this model, considering the text written.
void	setSelectedItem(Object anObject)
void	setShowAllItemsInListBox(boolean itemsShownInListBox) Sets the 'showAllItemsInListBox' configuration value for this component.
void	setTextWritten(String text) Sets the text for search items.
protected void	updateVisibleList() Updates the list with the results of the look up by the agent, and its configuration.

Methods inherited from class javax.swing.AbstractListModel

addListDataListener, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, getListDataListeners, getListeners, removeListDataListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.ListModel

addListDataListener, removeListDataListener

Field Detail

MAINTAIN_POSITION

public static final int MAINTAIN_POSITION

See Also:

Constant Field Values

ALPHABETICAL_ORDERED

public static final int ALPHABETICAL_ORDERED

See Also:

Constant Field Values

MAINTAIN_AGENT_POSITIONS

public static final int MAINTAIN_AGENT_POSITIONS

See Also:

Constant Field Values

SHOW_ALL_ITEMS

public static final boolean SHOW_ALL_ITEMS

See Also:

Constant Field Values

SHOW_ONLY_MATCHES

public static final boolean SHOW_ONLY_MATCHES

See Also:

Constant Field Values

CASE_SENSITIVE

public static final boolean CASE_SENSITIVE

See Also:

Constant Field Values

CASE_INSENSITIVE

public static final boolean CASE_INSENSITIVE

See Also:

Constant Field Values

DEFAULT_ITEMS_ORDER_CONFIGURATION

public static final int DEFAULT_ITEMS_ORDER_CONFIGURATION

See Also:

Constant Field Values

DEFAULT_SHOW_ALL_ITEMS_IN_LIST_BOX_CONFIGURATION

public static final boolean DEFAULT_SHOW_ALL_ITEMS_IN_LIST_BOX_CONFIGURATION

See Also:

Constant Field Values

DEFAULT_LANGUAGE_RULES_CONFIGURATION

public static final String DEFAULT_LANGUAGE_RULES_CONFIGURATION

See Also:

Constant Field Values

DEFAULT_CASE_SENSITIVE_CONFIGURATION

public static final boolean DEFAULT_CASE_SENSITIVE_CONFIGURATION

See Also:

Constant Field Values

Constructor Detail

DefaultComboBoxConfigurableLookUpModel

public DefaultComboBoxConfigurableLookUpModel()

See Also:

DefaultComboBoxModel.DefaultComboBoxModel()

DefaultComboBoxConfigurableLookUpModel

public DefaultComboBoxConfigurableLookUpModel(Object[] items)

See Also:

DefaultComboBoxModel.DefaultComboBoxModel(java.lang.Object[])

DefaultComboBoxConfigurableLookUpModel

public DefaultComboBoxConfigurableLookUpModel(Vector<Object> vector)

See Also:

DefaultComboBoxModel.DefaultComboBoxModel(java.util.Vector)

Method Detail

addElement

public void addElement(Object object)

Specified by:

addElement in interface MutableComboBoxModel

See Also:

DefaultComboBoxModel.addElement(java.lang.Object)

removeElementAt

public void removeElementAt(int index)

Specified by:

removeElementAt in interface MutableComboBoxModel

See Also:

DefaultComboBoxModel.removeElementAt(int)

insertElementAt

public void insertElementAt(Object object,
                            int index)

Specified by:

insertElementAt in interface MutableComboBoxModel

See Also:

DefaultComboBoxModel.insertElementAt(java.lang.Object, int)

removeElement

public void removeElement(Object object)

Specified by:

removeElement in interface MutableComboBoxModel

See Also:

DefaultComboBoxModel.removeElement(java.lang.Object)

removeAllElements

public void removeAllElements()

See Also:

DefaultComboBoxModel.removeAllElements()

getSize

public int getSize()

Specified by:

getSize in interface ListModel

See Also:

DefaultComboBoxModel.getSize()

setSelectedItem

public void setSelectedItem(Object anObject)

Specified by:

setSelectedItem in interface ComboBoxModel

See Also:

DefaultComboBoxModel.setSelectedItem(java.lang.Object)

getSelectedItem

public Object getSelectedItem()

Specified by:

getSelectedItem in interface ComboBoxModel

See Also:

DefaultComboBoxModel.getSelectedItem()

getElementAt

public Object getElementAt(int index)

Specified by:

getElementAt in interface ListModel

See Also:

DefaultComboBoxModel.getElementAt(int)

getIndexOf

public int getIndexOf(Object object)

See Also:

DefaultComboBoxModel.getIndexOf(java.lang.Object)

getItemsOrder

public int getItemsOrder()

Returns the 'itemsOrder' configuration value of this component. Configuration values are:

• MAINTAIN_POSITION: all items will be shown in the order programmer did.
• ALPHABETICAL_ORDERED: all items will be shown in alphabetical order.
• MAINTAIN_AGENT_POSITIONS: all items will be shown in the order the look up agent did.

Returns:

'itemsOrder' configuration

setItemsOrder

public void setItemsOrder(int itemsOrder)

Sets the 'itemsOrder' configuration value for this component. Configuration values are:

• MAINTAIN_POSITION: all items will be shown in the order programmer did.
• ALPHABETICAL_ORDERED: all items will be shown in alphabetical order.
• MAINTAIN_AGENT_POSITIONS: all items will be shown in the order the look up agent did.

Parameters:

An - integer value for 'itemsOrder' configuration flag

isShowAllItemsInListBox

public boolean isShowAllItemsInListBox()

Returns the 'showAllItemsInListBox' configuration value of this component. Configuration values are:

• SHOW_ALL_ITEMS: shows all items in the list box.
• SHOW_ONLY_MATCHES: shows only the items that match with the text written according the ILookUp agent.

Returns:

'showAllItemsInListBox' configuration

setShowAllItemsInListBox

public void setShowAllItemsInListBox(boolean itemsShownInListBox)

Sets the 'showAllItemsInListBox' configuration value for this component. Configuration values are:

• SHOW_ALL_ITEMS: shows all items in the list box.
• SHOW_ONLY_MATCHES: shows only the items that match with the text written according the ILookUp agent.

Parameters:

A - boolean value for 'showAllItemsInListBox' configuration flag

getLocaleRules

public String getLocaleRules()

Returns the 'localeRules' configuration value of this component. The language code values could be consulted at:
http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt
http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

Returns:

'localeRules' configuration

See Also:

{@Locale}

setLocaleRules

public void setLocaleRules(String localeRules)

Sets the 'localeRules' configuration value for this component. Configuration values are:
http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt
http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

Parameters:

An - String value for 'localeRules' configuration flag

See Also:

{@Locale}

isCaseSensitive

public boolean isCaseSensitive()

Returns the 'caseSensitive' configuration value of this component. Configuration values are:

• CASE_SENSITIVE: discriminates between small letters and capital letters.
• CASE_INSENSITIVE: doesn't discriminates between small letters and capital letters.

Returns:

'caseSensitive' configuration

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Sets the 'caseSensitive' configuration value for this component. Configuration values are:

• CASE_SENSITIVE: discriminates between small letters and capital letters.
• CASE_INSENSITIVE: doesn't discriminates between small letters and capital letters.

Parameters:

A - boolean value for 'caseSensitive' configuration flag

initialize

protected void initialize()

Initializes some attributes.

setDefaultBehaviorFlagsConfiguration

protected void setDefaultBehaviorFlagsConfiguration()

Sets the default values of the flags.

getData

public Vector<Object> getData()

Returns all elements stored in this model, according the order they were added.

Returns:

data stored in this model.

getDataAccordingItemsOrder

public Vector<Object> getDataAccordingItemsOrder()

Gets the data stored in this model according the criterion of the itemsOrder parameter.

Always returns all items stored.

Returns:

data stored in this model according the criterion of the itemsOrder parameter

updateVisibleList

protected void updateVisibleList()

Updates the list with the results of the look up by the agent, and its configuration.

lookUp

protected List<Object> lookUp()

Invokes the agent to execute its search on all items alphabetically sort ordered, considering the text written and the case sensitive configuration. The agent will use a

Comparator

that includes the locale language rules and the case sensitive in the rule that uses to compare.

.

Returns:

java.util.List

getLookUpAgent

public ILookUp getLookUpAgent()

Gets the agent used with the logic for looking up the items of this model, considering the text written.

Returns:

the agent used with the logic for looking up the items of this model

setLookUpAgent

public void setLookUpAgent(ILookUp agent)

Sets the agent with the logic for looking up the items of this model, considering the text written.

Parameters:

agent - the agent used with the logic for looking up the items of this model

setEventNotificationEnabled

public void setEventNotificationEnabled(boolean b)

Sets enabled or disabled the notification of events in this model.

Parameters:

b - true to enable, false to disable

getEventNotificationEnabled

public boolean getEventNotificationEnabled()

Gets if the notification of events in this model is enabled.

Returns:

true is its enabled; false otherwise

setTextWritten

public void setTextWritten(String text)

Description copied from interface: IComboBoxLookUp

Sets the text for search items.

Specified by:

setTextWritten in interface IComboBoxLookUp