aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/itmill/toolkit/ui/Select.java
diff options
context:
space:
mode:
authorMarc Englund <marc.englund@itmill.com>2007-10-31 07:41:08 +0000
committerMarc Englund <marc.englund@itmill.com>2007-10-31 07:41:08 +0000
commit4bd46ec67162e0443bc12d4aa47778f4ef5554d7 (patch)
tree275a77bcc371162a500c53205de2c1f8370c9e5a /src/com/itmill/toolkit/ui/Select.java
parent9f22f4dba4a26a9920d4e0ffa28dcc9320d8ff2c (diff)
downloadvaadin-framework-4bd46ec67162e0443bc12d4aa47778f4ef5554d7.tar.gz
vaadin-framework-4bd46ec67162e0443bc12d4aa47778f4ef5554d7.zip
Select refactor initial commit; not done.
svn changeset:2629/svn branch:trunk
Diffstat (limited to 'src/com/itmill/toolkit/ui/Select.java')
-rw-r--r--src/com/itmill/toolkit/ui/Select.java1446
1 files changed, 160 insertions, 1286 deletions
diff --git a/src/com/itmill/toolkit/ui/Select.java b/src/com/itmill/toolkit/ui/Select.java
index 961e0c9b01..e56666f3ad 100644
--- a/src/com/itmill/toolkit/ui/Select.java
+++ b/src/com/itmill/toolkit/ui/Select.java
@@ -29,24 +29,18 @@
package com.itmill.toolkit.ui;
import java.util.Collection;
-import java.util.Collections;
-import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
+import java.util.List;
import java.util.Map;
import java.util.Set;
import com.itmill.toolkit.data.Container;
-import com.itmill.toolkit.data.Item;
import com.itmill.toolkit.data.Property;
-import com.itmill.toolkit.data.util.IndexedContainer;
-import com.itmill.toolkit.terminal.KeyMapper;
import com.itmill.toolkit.terminal.PaintException;
import com.itmill.toolkit.terminal.PaintTarget;
import com.itmill.toolkit.terminal.Resource;
-import com.itmill.toolkit.ui.select.OptionFilter;
-import com.itmill.toolkit.ui.select.StartsWithFilter;
/**
* <p>
@@ -66,199 +60,42 @@ import com.itmill.toolkit.ui.select.StartsWithFilter;
* @VERSION@
* @since 3.0
*/
-public class Select extends AbstractField implements Container,
- Container.Viewer, Container.PropertySetChangeListener,
- Container.PropertySetChangeNotifier, Container.ItemSetChangeNotifier,
- Container.ItemSetChangeListener {
+public class Select extends AbstractSelect implements AbstractSelect.Filtering {
/**
- * Item caption mode: Item's ID's <code>String</code> representation is
- * used as caption.
+ * Holds value of property pageLength. 0 disables paging.
*/
- public static final int ITEM_CAPTION_MODE_ID = 0;
+ protected int pageLength = 15;
- /**
- * Item caption mode: Item's <code>String</code> representation is used as
- * caption.
- */
- public static final int ITEM_CAPTION_MODE_ITEM = 1;
-
- /**
- * Item caption mode: Index of the item is used as caption. The index mode
- * can only be used with the containers implementing the
- * {@link com.itmill.toolkit.data.Container.Indexed} interface.
- */
- public static final int ITEM_CAPTION_MODE_INDEX = 2;
-
- /**
- * Item caption mode: If an Item has a caption it's used, if not, Item's
- * ID's <code>String</code> representation is used as caption. <b>This is
- * the default</b>.
- */
- public static final int ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID = 3;
-
- /**
- * Item caption mode: Captions must be explicitly specified.
- */
- public static final int ITEM_CAPTION_MODE_EXPLICIT = 4;
-
- /**
- * Item caption mode: Only icons are shown, captions are hidden.
- */
- public static final int ITEM_CAPTION_MODE_ICON_ONLY = 5;
-
- /**
- * Item caption mode: Item captions are read from property specified with
- * <code>setItemCaptionPropertyId</code>.
- */
- public static final int ITEM_CAPTION_MODE_PROPERTY = 6;
-
- /**
- * Is the select in multiselect mode?
- */
- private boolean multiSelect = false;
-
- /**
- * Select options.
- */
- protected Container items;
-
- /**
- * Is the user allowed to add new options?
- */
- private boolean allowNewOptions;
-
- /**
- * Keymapper used to map key values.
- */
- protected KeyMapper itemIdMapper = new KeyMapper();
-
- /**
- * Item icons.
- */
- private HashMap itemIcons = new HashMap();
-
- /**
- * Item captions.
- */
- private HashMap itemCaptions = new HashMap();
+ // current page when the user is 'paging' trough options
+ private int currentPage;
- /**
- * Item caption mode.
- */
- private int itemCaptionMode = ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID;
-
- /**
- * Item caption source property id.
- */
- private Object itemCaptionPropertyId = null;
-
- /**
- * Item icon source property id.
- */
- private Object itemIconPropertyId = null;
-
- /**
- * List of property set change event listeners.
- */
- private LinkedList propertySetEventListeners = null;
-
- /**
- * List of item set change event listeners.
- */
- private LinkedList itemSetEventListeners = null;
-
- /**
- * Item id that represents null selection of this select.
- *
- * <p>
- * Data interface does not support nulls as item ids. Selecting the item
- * idetified by this id is the same as selecting no items at all. This
- * setting only affects the single select mode.
- * </p>
- */
- private Object nullSelectionItemId = null;
-
- /**
- * Mechanism for streaming select options outside of the UIDL.
- *
- * By default streaming is not enabled and this is null. Streaming can be
- * enabled with setOptionsLoadingLazy(true).
- *
- */
- // private OptionsStream optionsStream = null;
- /**
- * Number of options to stream per request ('page size') when lazyLoading
- * options.
- */
- private int lazyLoadingPageLength = 20;
-
- private OptionFilter optionFilter;
-
- private boolean isLazyLoading;
-
- private int page;
+ private int filteringMode = FILTERINGMODE_OFF;
private String filterstring;
-
- /**
- * How many visible columns (~characters) does select occupy visually. Used
- * to size select appropriately. Minus one sets to 100% width.
- */
- private int columns = -1;
+ private String prevfilterstring;
+ private List filteredOptions;
/* Constructors ********************************************************* */
- /**
- * Creates an empty Select. The caption is not used.
- */
+ /* Component methods **************************************************** */
+
public Select() {
- setContainerDataSource(new IndexedContainer());
+ super();
}
- /**
- * Creates an empty Select with caption.
- */
- public Select(String caption) {
- setContainerDataSource(new IndexedContainer());
- setCaption(caption);
+ public Select(String caption, Collection options) {
+ super(caption, options);
}
- /**
- * Creates a new select that is connected to a data-source.
- *
- * @param caption
- * the Caption of the component.
- * @param dataSource
- * the Container datasource to be selected from by this select.
- */
public Select(String caption, Container dataSource) {
- setCaption(caption);
- setContainerDataSource(dataSource);
+ super(caption, dataSource);
}
- /**
- * Creates a new select that is filled from a collection of option values.
- *
- * @param caption
- * the Caption of this field.
- * @param options
- * the Collection containing the options.
- */
- public Select(String caption, Collection options) {
-
- // Creates the options container and add given options to it
- Container c = new IndexedContainer();
- if (options != null)
- for (Iterator i = options.iterator(); i.hasNext();)
- c.addItem(i.next());
-
- setCaption(caption);
- setContainerDataSource((Container) c);
+ public Select(String caption) {
+ super(caption);
}
- /* Component methods **************************************************** */
-
/**
* Paints the content of this component.
*
@@ -268,84 +105,104 @@ public class Select extends AbstractField implements Container,
* if the paint operation failed.
*/
public void paintContent(PaintTarget target) throws PaintException {
+ // Focus control id
+ if (getFocusableId() > 0) {
+ target.addAttribute("focusid", getFocusableId());
+ }
+
+ // The tab ordering number
+ if (getTabIndex() > 0) {
+ target.addAttribute("tabindex", getTabIndex());
+ }
+
+ // If the field is modified, but not committed, set modified attribute
+ if (isModified()) {
+ target.addAttribute("modified", true);
+ }
- // Paints field properties
- super.paintContent(target);
+ // Adds the required attribute
+ if (isRequired()) {
+ target.addAttribute("required", true);
+ }
// Paints select attributes
- if (isMultiSelect())
+ if (isMultiSelect()) {
target.addAttribute("selectmode", "multi");
- if (isNewItemsAllowed())
+ }
+ if (isNewItemsAllowed()) {
target.addAttribute("allownewitem", true);
- if (getColumns() > -1)
- target.addAttribute("cols", getColumns());
+ }
+ if (!isNullSelectionAllowed()) {
+ target.addAttribute("nullselect", false);
+ }
// Constructs selected keys array
String[] selectedKeys;
- if (isMultiSelect())
+ if (isMultiSelect()) {
selectedKeys = new String[((Set) getValue()).size()];
- else
+ } else {
selectedKeys = new String[(getValue() == null
&& getNullSelectionItemId() == null ? 0 : 1)];
+ }
+
+ target.addAttribute("filteringmode", getFilteringMode());
// Paints the options and create array of selected id keys
- target.startTag("options");
// TODO Also use conventional rendering if lazy loading is not supported
// by terminal
int keyIndex = 0;
- if (!isLazyLoading()) {
- // Support for external null selection item id
- Collection ids = getItemIds();
- if (getNullSelectionItemId() != null
- && (!ids.contains(getNullSelectionItemId()))) {
-
- // Gets the option attribute values
- Object id = getNullSelectionItemId();
- String key = itemIdMapper.key(id);
- String caption = getItemCaption(id);
- Resource icon = getItemIcon(id);
-
- // Paints option
- target.startTag("so");
- if (icon != null)
- target.addAttribute("icon", icon);
- target.addAttribute("caption", caption);
- target.addAttribute("nullselection", true);
- target.addAttribute("key", key);
- if (isSelected(id)) {
- target.addAttribute("selected", true);
- selectedKeys[keyIndex++] = key;
- }
- target.endTag("so");
+ /*
+ * if (!isLazyLoading()) { // Support for external null selection item
+ * id Collection ids = getItemIds(); if (getNullSelectionItemId() !=
+ * null && (!ids.contains(getNullSelectionItemId()))) { // Gets the
+ * option attribute values Object id = getNullSelectionItemId(); String
+ * key = this.itemIdMapper.key(id); String caption = getItemCaption(id);
+ * Resource icon = getItemIcon(id); // Paints option
+ * target.startTag("so"); if (icon != null) {
+ * target.addAttribute("icon", icon); } target.addAttribute("caption",
+ * caption); target.addAttribute("nullselection", true);
+ * target.addAttribute("key", key); if (isSelected(id)) {
+ * target.addAttribute("selected", true); selectedKeys[keyIndex++] =
+ * key; } target.endTag("so"); } }
+ */
+ /*
+ * Iterator i; if (this.filterstring != null) { i =
+ * this.optionFilter.filter(this.filterstring,
+ * this.lazyLoadingPageLength, this.page).iterator();
+ * target.addAttribute("totalMatches", this.optionFilter
+ * .getMatchCount()); } else { i = getItemIds().iterator(); }
+ */
+ List options = getFilteredOptions();
+ if (options.size() > this.pageLength) {
+ int first = this.currentPage * this.pageLength;
+ int last = first + this.pageLength;
+ if (options.size() < last) {
+ last = options.size();
}
+ options = options.subList(first, last);
}
-
- Iterator i;
- if (isLazyLoading()) {
- i = optionFilter.filter(filterstring, lazyLoadingPageLength, page)
- .iterator();
- target.addAttribute("totalMatches", optionFilter.getMatchCount());
- } else {
- i = getItemIds().iterator();
- }
-
+ Iterator i = options.iterator();
// Paints the available selection options from data source
+
+ target.startTag("options");
while (i.hasNext()) {
// Gets the option attribute values
Object id = i.next();
- String key = itemIdMapper.key(id);
+ String key = this.itemIdMapper.key(id);
String caption = getItemCaption(id);
Resource icon = getItemIcon(id);
// Paints the option
target.startTag("so");
- if (icon != null)
+ if (icon != null) {
target.addAttribute("icon", icon);
+ }
target.addAttribute("caption", caption);
- if (id != null && id.equals(getNullSelectionItemId()))
+ if (id != null && id.equals(getNullSelectionItemId())) {
target.addAttribute("nullselection", true);
+ }
target.addAttribute("key", key);
if (isSelected(id) && keyIndex < selectedKeys.length) {
target.addAttribute("selected", true);
@@ -355,14 +212,62 @@ public class Select extends AbstractField implements Container,
}
target.endTag("options");
+ target.addAttribute("totalitems", size());
+ if (this.filteredOptions != null) {
+ target.addAttribute("totalMatches", this.filteredOptions.size());
+ }
+
// Paint variables
target.addVariable(this, "selected", selectedKeys);
- if (isNewItemsAllowed())
+ if (isNewItemsAllowed()) {
target.addVariable(this, "newitem", "");
- if (isLazyLoading()) {
- target.addVariable(this, "filter", filterstring);
- target.addVariable(this, "page", page);
}
+
+ target.addVariable(this, "filter", this.filterstring);
+ target.addVariable(this, "page", this.currentPage);
+
+ }
+
+ protected List getFilteredOptions() {
+ if (this.filterstring == null || this.filterstring.equals("")
+ || this.filteringMode == FILTERINGMODE_OFF) {
+ this.filteredOptions = new LinkedList(getItemIds());
+ return this.filteredOptions;
+ }
+ if (this.filterstring.equals(this.prevfilterstring)) {
+ return this.filteredOptions;
+ }
+
+ Collection items;
+ if (this.filterstring.startsWith(this.prevfilterstring)) {
+ items = this.filteredOptions;
+ } else {
+ items = getItemIds();
+ }
+
+ this.filteredOptions = new LinkedList();
+ for (Iterator it = items.iterator(); it.hasNext();) {
+ Object itemId = it.next();
+ String caption = getItemCaption(it);
+ if (caption != null || caption.equals("")) {
+ continue;
+ }
+ switch (this.filteringMode) {
+ case FILTERINGMODE_CONTAINS:
+ if (caption.indexOf(this.filterstring) > -1) {
+ this.filteredOptions.add(itemId);
+ }
+ break;
+ case FILTERINGMODE_STARTSWITH:
+ default:
+ if (caption.startsWith(this.filterstring)) {
+ this.filteredOptions.add(itemId);
+ }
+ break;
+ }
+ }
+
+ return this.filteredOptions;
}
/**
@@ -375,8 +280,8 @@ public class Select extends AbstractField implements Container,
String newFilter;
if ((newFilter = (String) variables.get("filter")) != null) {
// this is a filter request
- page = ((Integer) variables.get("page")).intValue();
- filterstring = newFilter;
+ this.currentPage = ((Integer) variables.get("page")).intValue();
+ this.filterstring = newFilter;
requestRepaint();
return;
}
@@ -388,14 +293,15 @@ public class Select extends AbstractField implements Container,
if (newitem != null && newitem.length() > 0) {
// Checks for readonly
- if (isReadOnly())
+ if (isReadOnly()) {
throw new Property.ReadOnlyException();
+ }
// Adds new option
if (addItem(newitem) != null) {
// Sets the caption property, if used
- if (getItemCaptionPropertyId() != null)
+ if (getItemCaptionPropertyId() != null) {
try {
getContainerProperty(newitem,
getItemCaptionPropertyId()).setValue(newitem);
@@ -404,6 +310,7 @@ public class Select extends AbstractField implements Container,
// caption is
// just missing
}
+ }
}
}
@@ -419,12 +326,13 @@ public class Select extends AbstractField implements Container,
// Converts the key-array to id-set
LinkedList s = new LinkedList();
for (int i = 0; i < ka.length; i++) {
- Object id = itemIdMapper.get(ka[i]);
- if (id != null && containsId(id))
+ Object id = this.itemIdMapper.get(ka[i]);
+ if (id != null && containsId(id)) {
s.add(id);
- else if (itemIdMapper.isNewIdKey(ka[i]) && newitem != null
- && newitem.length() > 0)
+ } else if (this.itemIdMapper.isNewIdKey(ka[i])
+ && newitem != null && newitem.length() > 0) {
s.add(newitem);
+ }
}
// Limits the deselection to the set of visible items
@@ -432,10 +340,11 @@ public class Select extends AbstractField implements Container,
Collection visible = getVisibleItemIds();
if (visible != null) {
Set newsel = (Set) getValue();
- if (newsel == null)
+ if (newsel == null) {
newsel = new HashSet();
- else
+ } else {
newsel = new HashSet(newsel);
+ }
newsel.removeAll(visible);
newsel.addAll(s);
setValue(newsel, true);
@@ -449,16 +358,18 @@ public class Select extends AbstractField implements Container,
// Allows deselection only if the deselected item is visible
Object current = getValue();
Collection visible = getVisibleItemIds();
- if (visible != null && visible.contains(current))
+ if (visible != null && visible.contains(current)) {
setValue(null, true);
+ }
} else {
- Object id = itemIdMapper.get(ka[0]);
- if (id != null && id.equals(getNullSelectionItemId()))
+ Object id = this.itemIdMapper.get(ka[0]);
+ if (id != null && id.equals(getNullSelectionItemId())) {
setValue(null, true);
- else if (itemIdMapper.isNewIdKey(ka[0]))
+ } else if (this.itemIdMapper.isNewIdKey(ka[0])) {
setValue(newitem);
- else
+ } else {
setValue(id, true);
+ }
}
}
}
@@ -473,1048 +384,11 @@ public class Select extends AbstractField implements Container,
return "select";
}
- /**
- * Gets the visible item ids. In Select, this returns list of all item ids,
- * but can be overriden in subclasses if they paint only part of the items
- * to the terminal or null if no items is visible.
- */
- public Collection getVisibleItemIds() {
- if (isVisible())
- return getItemIds();
- return null;
- }
-
- /* Property methods ***************************************************** */
-
- /**
- * Returns the type of the property. <code>getValue</code> and
- * <code>setValue</code> methods must be compatible with this type: one
- * can safely cast <code>getValue</code> to given type and pass any
- * variable assignable to this type as a parameter to <code>setValue</code>.
- *
- * @return the Type of the property.
- */
- public Class getType() {
- if (isMultiSelect())
- return Set.class;
- else
- return Object.class;
- }
-
- /**
- * Gets the selected item id or in multiselect mode a set of selected ids.
- *
- * @see com.itmill.toolkit.ui.AbstractField#getValue()
- */
- public Object getValue() {
- Object retValue = super.getValue();
-
- if (isMultiSelect()) {
-
- // If the return value is not a set
- if (retValue == null)
- return new HashSet();
- if (retValue instanceof Set) {
- return Collections.unmodifiableSet((Set) retValue);
- } else if (retValue instanceof Collection) {
- return new HashSet((Collection) retValue);
- } else {
- Set s = new HashSet();
- if (items.containsId(retValue))
- s.add(retValue);
- return s;
- }
-
- } else
- return retValue;
- }
-
- /**
- * Sets the visible value of the property.
- *
- * <p>
- * The value of the select is the selected item id. If the select is in
- * multiselect-mode, the value is a set of selected item keys. In
- * multiselect mode all collections of id:s can be assigned.
- * </p>
- *
- * @param newValue
- * the New selected item or collection of selected items.
- * @see com.itmill.toolkit.ui.AbstractField#setValue(java.lang.Object)
- */
- public void setValue(Object newValue) throws Property.ReadOnlyException,
- Property.ConversionException {
- setValue(newValue, false);
- }
-
- /**
- * Sets the visible value of the property.
- *
- * <p>
- * The value of the select is the selected item id. If the select is in
- * multiselect-mode, the value is a set of selected item keys. In
- * multiselect mode all collections of id:s can be assigned.
- * </p>
- *
- * @param newValue
- * the New selected item or collection of selected items.
- * @param repaintIsNotNeeded
- * True if caller is sure that repaint is not needed.
- * @see com.itmill.toolkit.ui.AbstractField#setValue(java.lang.Object,
- * java.lang.Boolean)
- */
- protected void setValue(Object newValue, boolean repaintIsNotNeeded)
- throws Property.ReadOnlyException, Property.ConversionException {
-
- if (isMultiSelect()) {
- if (newValue == null)
- super.setValue(new HashSet(), repaintIsNotNeeded);
- else if (Collection.class.isAssignableFrom(newValue.getClass()))
- super.setValue(new HashSet((Collection) newValue),
- repaintIsNotNeeded);
- } else if (newValue == null || items.containsId(newValue))
- super.setValue(newValue, repaintIsNotNeeded);
+ public void setFilteringMode(int filteringMode) {
+ this.filteringMode = filteringMode;
}
- /* Container methods **************************************************** */
-
- /**
- * Gets the item from the container with given id. If the container does not
- * contain the requested item, null is returned.
- *
- * @param itemId
- * the item id.
- * @return the item from the container.
- */
- public Item getItem(Object itemId) {
- return items.getItem(itemId);
- }
-
- /**
- * Gets the item Id collection from the container.
- *
- * @return the Collection of item ids.
- */
- public Collection getItemIds() {
- return items.getItemIds();
+ public int getFilteringMode() {
+ return this.filteringMode;
}
-
- /**
- * Gets the property Id collection from the container.
- *
- * @return the Collection of property ids.
- */
- public Collection getContainerPropertyIds() {
- return items.getContainerPropertyIds();
- }
-
- /**
- * Gets the property type.
- *
- * @param propertyId
- * the Id identifying the property.
- * @see com.itmill.toolkit.data.Container#getType(java.lang.Object)
- */
- public Class getType(Object propertyId) {
- return items.getType(propertyId);
- }
-
- /*
- * Gets the number of items in the container.
- *
- * @return the Number of items in the container.
- *
- * @see com.itmill.toolkit.data.Container#size()
- */
- public int size() {
- return items.size();
- }
-
- /**
- * Tests, if the collection contains an item with given id.
- *
- * @param itemId
- * the Id the of item to be tested.
- */
- public boolean containsId(Object itemId) {
- if (itemId != null)
- return items.containsId(itemId);
- else
- return false;
- }
-
- /**
- * Gets the Property identified by the given itemId and propertyId from the
- * Container
- *
- * @see com.itmill.toolkit.data.Container#getContainerProperty(Object,
- * Object)
- */
- public Property getContainerProperty(Object itemId, Object propertyId) {
- return items.getContainerProperty(itemId, propertyId);
- }
-
- /* Container.Managed methods ******************************************** */
-
- /**
- * Adds the new property to all items. Adds a property with given id, type
- * and default value to all items in the container.
- *
- * This functionality is optional. If the function is unsupported, it always
- * returns false.
- *
- * @return True if the operation succeeded.
- * @see com.itmill.toolkit.data.Container#addContainerProperty(java.lang.Object,
- * java.lang.Class, java.lang.Object)
- */
- public boolean addContainerProperty(Object propertyId, Class type,
- Object defaultValue) throws UnsupportedOperationException {
-
- boolean retval = items.addContainerProperty(propertyId, type,
- defaultValue);
- if (retval && !(items instanceof Container.PropertySetChangeNotifier)) {
- firePropertySetChange();
- }
- return retval;
- }
-
- /**
- * Removes all items from the container.
- *
- * This functionality is optional. If the function is unsupported, it always
- * returns false.
- *
- * @return True if the operation succeeded.
- * @see com.itmill.toolkit.data.Container#removeAllItems()
- */
- public boolean removeAllItems() throws UnsupportedOperationException {
-
- boolean retval = items.removeAllItems();
- this.itemIdMapper.removeAll();
- if (retval) {
- setValue(null);
- if (!(items instanceof Container.ItemSetChangeNotifier))
- fireItemSetChange();
- }
- return retval;
- }
-
- /**
- * Creates a new item into container with container managed id. The id of
- * the created new item is returned. The item can be fetched with getItem()
- * method. if the creation fails, null is returned.
- *
- * @return the Id of the created item or null in case of failure.
- * @see com.itmill.toolkit.data.Container#addItem()
- */
- public Object addItem() throws UnsupportedOperationException {
-
- Object retval = items.addItem();
- if (retval != null
- && !(items instanceof Container.ItemSetChangeNotifier))
- fireItemSetChange();
- return retval;
- }
-
- /**
- * Create a new item into container. The created new item is returned and
- * ready for setting property values. if the creation fails, null is
- * returned. In case the container already contains the item, null is
- * returned.
- *
- * This functionality is optional. If the function is unsupported, it always
- * returns null.
- *
- * @param itemId
- * the Identification of the item to be created.
- * @return the Created item with the given id, or null in case of failure.
- * @see com.itmill.toolkit.data.Container#addItem(java.lang.Object)
- */
- public Item addItem(Object itemId) throws UnsupportedOperationException {
-
- Item retval = items.addItem(itemId);
- if (retval != null
- && !(items instanceof Container.ItemSetChangeNotifier))
- fireItemSetChange();
- return retval;
- }
-
- /**
- * Removes the item identified by Id from the container. This functionality
- * is optional. If the function is not implemented, the functions allways
- * returns false.
- *
- * @return True if the operation succeeded.
- * @see com.itmill.toolkit.data.Container#removeItem(java.lang.Object)
- */
- public boolean removeItem(Object itemId)
- throws UnsupportedOperationException {
-
- unselect(itemId);
- boolean retval = items.removeItem(itemId);
- this.itemIdMapper.remove(itemId);
- if (retval && !(items instanceof Container.ItemSetChangeNotifier))
- fireItemSetChange();
- return retval;
- }
-
- /**
- * Removes the property from all items. Removes a property with given id
- * from all the items in the container.
- *
- * This functionality is optional. If the function is unsupported, it always
- * returns false.
- *
- * @return True if the operation succeeded.
- * @see com.itmill.toolkit.data.Container#removeContainerProperty(java.lang.Object)
- */
- public boolean removeContainerProperty(Object propertyId)
- throws UnsupportedOperationException {
-
- boolean retval = items.removeContainerProperty(propertyId);
- if (retval && !(items instanceof Container.PropertySetChangeNotifier))
- firePropertySetChange();
- return retval;
- }
-
- /* Container.Viewer methods ********************************************* */
-
- /**
- * Sets the container as data-source for viewing.
- *
- * @param newDataSource
- * the new data source.
- */
- public void setContainerDataSource(Container newDataSource) {
- if (newDataSource == null)
- newDataSource = new IndexedContainer();
-
- if (items != newDataSource) {
-
- // Removes listeners from the old datasource
- if (items != null) {
- try {
- ((Container.ItemSetChangeNotifier) items)
- .removeListener((Container.ItemSetChangeListener) this);
- } catch (ClassCastException ignored) {
- // Ignored
- }
- try {
- ((Container.PropertySetChangeNotifier) items)
- .removeListener((Container.PropertySetChangeListener) this);
- } catch (ClassCastException ignored) {
- // Ignored
- }
- }
-
- // Assigns new data source
- items = newDataSource;
-
- // Clears itemIdMapper also
- this.itemIdMapper.removeAll();
-
- // Adds listeners
- if (items != null) {
- try {
- ((Container.ItemSetChangeNotifier) items)
- .addListener((Container.ItemSetChangeListener) this);
- } catch (ClassCastException ignored) {
- // Ignored
- }
- try {
- ((Container.PropertySetChangeNotifier) items)
- .addListener((Container.PropertySetChangeListener) this);
- } catch (ClassCastException ignored) {
- // Ignored
- }
- }
-
- // TODO: This should be conditional
- fireValueChange(false);
- }
- }
-
- /**
- * Gets the viewing data-source container.
- *
- * @see com.itmill.toolkit.data.Container.Viewer#getContainerDataSource()
- */
- public Container getContainerDataSource() {
- return items;
- }
-
- /* Select attributes **************************************************** */
-
- /**
- * Is the select in multiselect mode? In multiselect mode
- *
- * @return the Value of property multiSelect.
- */
- public boolean isMultiSelect() {
- return this.multiSelect;
- }
-
- /**
- * Sets the multiselect mode. Setting multiselect mode false may loose
- * selection information: if selected items set contains one or more
- * selected items, only one of the selected items is kept as selected.
- *
- * @param multiSelect
- * the New value of property multiSelect.
- */
- public void setMultiSelect(boolean multiSelect) {
-
- if (multiSelect != this.multiSelect) {
-
- // Selection before mode change
- Object oldValue = getValue();
-
- this.multiSelect = multiSelect;
-
- // Convert the value type
- if (multiSelect) {
- Set s = new HashSet();
- if (oldValue != null)
- s.add(oldValue);
- setValue(s);
- } else {
- Set s = (Set) oldValue;
- if (s == null || s.isEmpty())
- setValue(null);
- else
-
- // Set the single select to contain only the first
- // selected value in the multiselect
- setValue(s.iterator().next());
- }
-
- requestRepaint();
- }
- }
-
- /**
- * Does the select allow adding new options by the user. If true, the new
- * options can be added to the Container. The text entered by the user is
- * used as id. No that data-source must allow adding new items (it must
- * implement Container.Managed).
- *
- * @return True if additions are allowed.
- */
- public boolean isNewItemsAllowed() {
-
- return this.allowNewOptions;
- }
-
- /**
- * Enables or disables possibility to add new options by the user.
- *
- * @param allowNewOptions
- * the New value of property allowNewOptions.
- */
- public void setNewItemsAllowed(boolean allowNewOptions) {
-
- // Only handle change requests
- if (this.allowNewOptions != allowNewOptions) {
-
- this.allowNewOptions = allowNewOptions;
-
- requestRepaint();
- }
- }
-
- /**
- * Override the caption of an item. Setting caption explicitly overrides id,
- * item and index captions.
- *
- * @param itemId
- * the id of the item to be recaptioned.
- * @param caption
- * the New caption.
- */
- public void setItemCaption(Object itemId, String caption) {
- if (itemId != null) {
- itemCaptions.put(itemId, caption);
- requestRepaint();
- }
- }
-
- /**
- * Gets the caption of an item. The caption is generated as specified by the
- * item caption mode. See <code>setItemCaptionMode()</code> for more
- * details.
- *
- * @param itemId
- * the id of the item to be queried.
- * @return the caption for specified item.
- */
- public String getItemCaption(Object itemId) {
-
- // Null items can not be found
- if (itemId == null)
- return null;
-
- String caption = null;
-
- switch (getItemCaptionMode()) {
-
- case ITEM_CAPTION_MODE_ID:
- caption = itemId.toString();
- break;
-
- case ITEM_CAPTION_MODE_INDEX:
- try {
- caption = String.valueOf(((Container.Indexed) items)
- .indexOfId(itemId));
- } catch (ClassCastException ignored) {
- }
- break;
-
- case ITEM_CAPTION_MODE_ITEM:
- Item i = getItem(itemId);
- if (i != null)
- caption = i.toString();
- break;
-
- case ITEM_CAPTION_MODE_EXPLICIT:
- caption = (String) itemCaptions.get(itemId);
- break;
-
- case ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID:
- caption = (String) itemCaptions.get(itemId);
- if (caption == null)
- caption = itemId.toString();
- break;
-
- case ITEM_CAPTION_MODE_PROPERTY:
- Property p = getContainerProperty(itemId,
- getItemCaptionPropertyId());
- if (p != null)
- caption = p.toString();
- break;
- }
-
- // All items must have some captions
- return caption != null ? caption : "";
- }
-
- /**
- * Sets the icon for an item.
- *
- * @param itemId
- * the id of the item to be assigned an icon.
- * @param icon
- * the New icon.
- */
- public void setItemIcon(Object itemId, Resource icon) {
- if (itemId != null) {
- if (icon == null)
- itemIcons.remove(itemId);
- else
- itemIcons.put(itemId, icon);
- requestRepaint();
- }
- }
-
- /**
- * Gets the item icon.
- *
- * @param itemId
- * the id of the item to be assigned an icon.
- * @return the Icon for the item or null, if not specified.
- */
- public Resource getItemIcon(Object itemId) {
- Resource explicit = (Resource) itemIcons.get(itemId);
- if (explicit != null)
- return explicit;
-
- if (getItemIconPropertyId() == null)
- return null;
-
- Property ip = getContainerProperty(itemId, getItemIconPropertyId());
- if (ip == null)
- return null;
- Object icon = ip.getValue();
- if (icon instanceof Resource)
- return (Resource) icon;
-
- return null;
- }
-
- /**
- * Sets the item caption mode.
- *
- * <p>
- * The mode can be one of the following ones:
- * <ul>
- * <li><code>ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID</code> : Items
- * Id-objects <code>toString</code> is used as item caption. If caption is
- * explicitly specified, it overrides the id-caption.
- * <li><code>ITEM_CAPTION_MODE_ID</code> : Items Id-objects
- * <code>toString</code> is used as item caption.</li>
- * <li><code>ITEM_CAPTION_MODE_ITEM</code> : Item-objects
- * <code>toString</code> is used as item caption.</li>
- * <li><code>ITEM_CAPTION_MODE_INDEX</code> : The index of the item is
- * used as item caption. The index mode can only be used with the containers
- * implementing <code>Container.Indexed</code> interface.</li>
- * <li><code>ITEM_CAPTION_MODE_EXPLICIT</code> : The item captions must
- * be explicitly specified.</li>
- * <li><code>ITEM_CAPTION_MODE_PROPERTY</code> : The item captions are
- * read from property, that must be specified with
- * <code>setItemCaptionPropertyId</code>.</li>
- * </ul>
- * The <code>ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID</code> is the default
- * mode.
- * </p>
- *
- * @param mode
- * the One of the modes listed above.
- */
- public void setItemCaptionMode(int mode) {
- if (ITEM_CAPTION_MODE_ID <= mode && mode <= ITEM_CAPTION_MODE_PROPERTY) {
- itemCaptionMode = mode;
- requestRepaint();
- }
- }
-
- /**
- * Gets the item caption mode.
- *
- * <p>
- * The mode can be one of the following ones:
- * <ul>
- * <li><code>ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID</code> : Items
- * Id-objects <code>toString</code> is used as item caption. If caption is
- * explicitly specified, it overrides the id-caption.
- * <li><code>ITEM_CAPTION_MODE_ID</code> : Items Id-objects
- * <code>toString</code> is used as item caption.</li>
- * <li><code>ITEM_CAPTION_MODE_ITEM</code> : Item-objects
- * <code>toString</code> is used as item caption.</li>
- * <li><code>ITEM_CAPTION_MODE_INDEX</code> : The index of the item is
- * used as item caption. The index mode can only be used with the containers
- * implementing <code>Container.Indexed</code> interface.</li>
- * <li><code>ITEM_CAPTION_MODE_EXPLICIT</code> : The item captions must
- * be explicitly specified.</li>
- * <li><code>ITEM_CAPTION_MODE_PROPERTY</code> : The item captions are
- * read from property, that must be specified with
- * <code>setItemCaptionPropertyId</code>.</li>
- * </ul>
- * The <code>ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID</code> is the default
- * mode.
- * </p>
- *
- * @return the One of the modes listed above.
- */
- public int getItemCaptionMode() {
- return itemCaptionMode;
- }
-
- /**
- * Sets the item caption property.
- *
- * <p>
- * Setting the id to a existing property implicitly sets the item caption
- * mode to <code>ITEM_CAPTION_MODE_PROPERTY</code>. If the object is in
- * <code>ITEM_CAPTION_MODE_PROPERTY</code> mode, setting caption property
- * id null resets the item caption mode to
- * <code>ITEM_CAPTION_EXPLICIT_DEFAULTS_ID</code>.
- * </p>
- *
- * <p>
- * Setting the property id to null disables this feature. The id is null by
- * default
- * </p>.
- *
- * @param propertyId
- * the id of the property.
- *
- */
- public void setItemCaptionPropertyId(Object propertyId) {
- if (propertyId != null) {
- itemCaptionPropertyId = propertyId;
- setItemCaptionMode(ITEM_CAPTION_MODE_PROPERTY);
- requestRepaint();
- } else {
- itemCaptionPropertyId = null;
- if (getItemCaptionMode() == ITEM_CAPTION_MODE_PROPERTY)
- setItemCaptionMode(ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID);
- requestRepaint();
- }
- }
-
- /**
- * Gets the item caption property.
- *
- * @return the Id of the property used as item caption source.
- */
- public Object getItemCaptionPropertyId() {
- return itemCaptionPropertyId;
- }
-
- /**
- * Sets the item icon property.
- *
- * <p>
- * If the property id is set to a valid value, each item is given an icon
- * got from the given property of the items. The type of the property must
- * be assignable to Icon.
- * </p>
- *
- * <p>
- * Note : The icons set with <code>setItemIcon</code> function override
- * the icons from the property.
- * </p>
- *
- * <p>
- * Setting the property id to null disables this feature. The id is null by
- * default
- * </p>.
- *
- * @param propertyId
- * the Id of the property that specifies icons for items.
- */
- public void setItemIconPropertyId(Object propertyId) {
- if ((propertyId != null)
- && Resource.class.isAssignableFrom(getType(propertyId))) {
- itemIconPropertyId = propertyId;
- requestRepaint();
- } else
- itemIconPropertyId = null;
- }
-
- /**
- * Gets the item icon property.
- *
- * <p>
- * If the property id is set to a valid value, each item is given an icon
- * got from the given property of the items. The type of the property must
- * be assignable to Icon.
- * </p>
- *
- * <p>
- * Note : The icons set with <code>setItemIcon</code> function override
- * the icons from the property.
- * </p>
- *
- * <p>
- * Setting the property id to null disables this feature. The id is null by
- * default
- * </p>.
- *
- * @return the Id of the property containing the item icons.
- */
- public Object getItemIconPropertyId() {
- return itemIconPropertyId;
- }
-
- /**
- * Tests if an item is selected.
- *
- * <p>
- * In single select mode testing selection status of the item identified by
- * {@link #getNullSelectionItemId()} returns true if the value of the
- * property is null.
- * </p>
- *
- * @param itemId
- * the Id the of the item to be tested.
- * @see #getNullSelectionItemId()
- * @see #setNullSelectionItemId(Object)
- *
- */
- public boolean isSelected(Object itemId) {
- if (itemId == null)
- return false;
- if (isMultiSelect())
- return ((Set) getValue()).contains(itemId);
- else {
- Object value = getValue();
- return itemId.equals(value == null ? getNullSelectionItemId()
- : value);
- }
- }
-
- /**
- * Selects an item.
- *
- * <p>
- * In single select mode selecting item identified by
- * {@link #getNullSelectionItemId()} sets the value of the property to null.
- * </p>
- *
- * @param itemId
- * the tem to be selected.
- * @see #getNullSelectionItemId()
- * @see #setNullSelectionItemId(Object)
- *
- */
- public void select(Object itemId) {
- if (!isSelected(itemId) && items.containsId(itemId)) {
- if (isMultiSelect()) {
- Set s = new HashSet((Set) getValue());
- s.add(itemId);
- setValue(s);
- } else if (itemId.equals(getNullSelectionItemId()))
- setValue(null);
- else
- setValue(itemId);
- }
- }
-
- /**
- * Unselects an item.
- *
- * @param itemId
- * the Item to be unselected.
- * @see #getNullSelectionItemId()
- * @see #setNullSelectionItemId(Object)
- *
- */
- public void unselect(Object itemId) {
- if (isSelected(itemId)) {
- if (isMultiSelect()) {
- Set s = new HashSet((Set) getValue());
- s.remove(itemId);
- setValue(s);
- } else
- setValue(null);
- }
- }
-
- /**
- * Notifies this listener that the Containers contents has changed.
- *
- * @see com.itmill.toolkit.data.Container.PropertySetChangeListener#containerPropertySetChange(com.itmill.toolkit.data.Container.PropertySetChangeEvent)
- */
- public void containerPropertySetChange(
- Container.PropertySetChangeEvent event) {
- firePropertySetChange();
- }
-
- /**
- * Adds a new Property set change listener for this Container.
- *
- * @see com.itmill.toolkit.data.Container.PropertySetChangeNotifier#addListener(com.itmill.toolkit.data.Container.PropertySetChangeListener)
- */
- public void addListener(Container.PropertySetChangeListener listener) {
- if (propertySetEventListeners == null)
- propertySetEventListeners = new LinkedList();
- propertySetEventListeners.add(listener);
- }
-
- /**
- * Removes a previously registered Property set change listener.
- *
- * @see com.itmill.toolkit.data.Container.PropertySetChangeNotifier#removeListener(com.itmill.toolkit.data.Container.PropertySetChangeListener)
- */
- public void removeListener(Container.PropertySetChangeListener listener) {
- if (propertySetEventListeners != null) {
- propertySetEventListeners.remove(listener);
- if (propertySetEventListeners.isEmpty())
- propertySetEventListeners = null;
- }
- }
-
- /**
- * Adds an Item set change listener for the object.
- *
- * @see com.itmill.toolkit.data.Container.ItemSetChangeNotifier#addListener(com.itmill.toolkit.data.Container.ItemSetChangeListener)
- */
- public void addListener(Container.ItemSetChangeListener listener) {
- if (itemSetEventListeners == null)
- itemSetEventListeners = new LinkedList();
- itemSetEventListeners.add(listener);
- }
-
- /**
- * Removes the Item set change listener from the object.
- *
- * @see com.itmill.toolkit.data.Container.ItemSetChangeNotifier#removeListener(com.itmill.toolkit.data.Container.ItemSetChangeListener)
- */
- public void removeListener(Container.ItemSetChangeListener listener) {
- if (itemSetEventListeners != null) {
- itemSetEventListeners.remove(listener);
- if (itemSetEventListeners.isEmpty())
- itemSetEventListeners = null;
- }
- }
-
- /**
- * Lets the listener know a Containers Item set has changed.
- *
- * @see com.itmill.toolkit.data.Container.ItemSetChangeListener#containerItemSetChange(com.itmill.toolkit.data.Container.ItemSetChangeEvent)
- */
- public void containerItemSetChange(Container.ItemSetChangeEvent event) {
- // Clears the item id mapping table
- this.itemIdMapper.removeAll();
-
- // Notify all listeners
- fireItemSetChange();
- }
-
- /**
- * Fires the property set change event.
- */
- protected void firePropertySetChange() {
- if (propertySetEventListeners != null
- && !propertySetEventListeners.isEmpty()) {
- Container.PropertySetChangeEvent event = new PropertySetChangeEvent();
- Object[] listeners = propertySetEventListeners.toArray();
- for (int i = 0; i < listeners.length; i++)
- ((Container.PropertySetChangeListener) listeners[i])
- .containerPropertySetChange(event);
- }
- requestRepaint();
- }
-
- /**
- * Fires the item set change event.
- */
- protected void fireItemSetChange() {
- if (itemSetEventListeners != null && !itemSetEventListeners.isEmpty()) {
- Container.ItemSetChangeEvent event = new ItemSetChangeEvent();
- Object[] listeners = itemSetEventListeners.toArray();
- for (int i = 0; i < listeners.length; i++)
- ((Container.ItemSetChangeListener) listeners[i])
- .containerItemSetChange(event);
- }
- requestRepaint();
- }
-
- /**
- * Implementation of item set change event.
- */
- private class ItemSetChangeEvent implements Container.ItemSetChangeEvent {
-
- /**
- * Gets the Property where the event occurred.
- *
- * @see com.itmill.toolkit.data.Container.ItemSetChangeEvent#getContainer()
- */
- public Container getContainer() {
- return Select.this;
- }
-
- }
-
- /**
- * Implementation of property set change event.
- */
- private class PropertySetChangeEvent implements
- Container.PropertySetChangeEvent {
-
- /**
- * Retrieves the Container whose contents have been modified.
- *
- * @see com.itmill.toolkit.data.Container.PropertySetChangeEvent#getContainer()
- */
- public Container getContainer() {
- return Select.this;
- }
-
- }
-
- /**
- * Returns the item id that represents null value of this select in single
- * select mode.
- *
- * <p>
- * Data interface does not support nulls as item ids. Selecting the item
- * idetified by this id is the same as selecting no items at all. This
- * setting only affects the single select mode.
- * </p>
- *
- * @return the Object Null value item id.
- * @see #setNullSelectionItemId(Object)
- * @see #isSelected(Object)
- * @see #select(Object)
- */
- public final Object getNullSelectionItemId() {
- return nullSelectionItemId;
- }
-
- /**
- * Sets the item id that represents null value of this select.
- *
- * <p>
- * Data interface does not support nulls as item ids. Selecting the item
- * idetified by this id is the same as selecting no items at all. This
- * setting only affects the single select mode.
- * </p>
- *
- * @param nullSelectionItemId
- * the nullSelectionItemId to set.
- * @see #getNullSelectionItemId()
- * @see #isSelected(Object)
- * @see #select(Object)
- */
- public void setNullSelectionItemId(Object nullSelectionItemId) {
- this.nullSelectionItemId = nullSelectionItemId;
- }
-
- // TODO javadoc
- public boolean isLazyLoading() {
- return isLazyLoading;
- }
-
- // TODO javadoc
- // TODO What to do when terminal does not support lazy loading?
- public void setLazyLoading(boolean useLazyLoading) {
- if (useLazyLoading != isLazyLoading) {
- isLazyLoading = useLazyLoading;
- if (getOptionFilter() == null)
- setOptionFilter(new StartsWithFilter(this));
- requestRepaint();
- }
- }
-
- /**
- * Notifies the component that it is connected to an application.
- *
- * @see com.itmill.toolkit.ui.AbstractField#attach()
- */
- public void attach() {
- super.attach();
- }
-
- /**
- * Detaches the component from application.
- *
- * @see com.itmill.toolkit.ui.AbstractComponent#detach()
- */
- public void detach() {
- super.detach();
- }
-
- /**
- * Sets OptionFilter which will do filtering base on query string if Select
- * is in lazy loading mode.
- *
- * @param of
- * OptionFilter to be used in filtering
- */
- public void setOptionFilter(OptionFilter of) {
- optionFilter = of;
- }
-
- /**
- * @return reference to option filter
- */
- public OptionFilter getOptionFilter() {
- return optionFilter;
- }
-
- /**
- * Set visible columns.
- */
- public void setColumns(int cols) {
- this.columns = cols;
- }
-
- /**
- * Get visible columns.
- */
- public int getColumns() {
- return this.columns;
- }
-
}