Package name.matthewgreet.strutscommons.view

Class EnumMultiSelectBoxDisplay<E extends Enum<E>>

java.lang.Object
name.matthewgreet.strutscommons.view.EnumMultiSelectBoxDisplay<E>
public abstract class EnumMultiSelectBoxDisplay<E extends Enum<E>> extends Object

Template that aids creation of OPTION tags in JSPs for multi selection SELECT elements by formatting an enumerated type for display. Subclasses should be created in the JSP as a bean and the selectedValuesproperty set with the currently selected items. See also SelectBoxItemDisplay2.

Example JSP code:

<SELECT SIZE="1" NAME="category" MULTIPLE>
  <s:iterator value="categoryDisplay.list" var="categoryItemDisplay">
    <OPTION VALUE="<s:property value="#categoryItemDisplay.value"/>" <s:property value="#categoryItemDisplay.selectedAttribute"/>><s:property value="#categoryItemDisplay.text"/></OPTION>
  </s:iterator>
</SELECT>

  • Constructor Details

    • EnumMultiSelectBoxDisplay

      public EnumMultiSelectBoxDisplay()

  • Method Details

    • addItems

      protected void addItems(List<SelectBoxItemDisplay2<E,E>> formattedModel)
      May be overridden by subclasses to add additional, formatted items to the display list. This is typically used to add a blank item to represent no value or text that demands a real value is selected.
      Parameters:
      formattedModel - List of SelectBoxItemDisplay2

    • getEnumValues

      protected abstract E[] getEnumValues()
      Overridden by subclass to return the values of the enumerated type. This function exists because the values cannot be extracted from a generic, enumerated type;

    • getSortComparator

      protected Comparator<SelectBoxItemDisplay2<E,E>> getSortComparator()
      May be overridden by subclasses to return a comparator for defining display order of formatted items. Comparator compares instances of SelectBoxItemDisplay2 that are allowed by subclass. Defaults to comparator that sorts by ascending enumeration order.

    • getText

      protected String getText(E item)
      May be overridden by subclasses to return text to be displayed to user as part of OPTION element. This is typically overridden as enumeration names aren't friendly for user display.

    • getValue

      protected String getValue(E item)
      May be overridden by subclasses to return string to be used in VALUE attribute of OPTION element. It is rarely useful to override this.

    • isAllowed

      protected boolean isAllowed(E item)
      May be overridden by subclasses to filter items in lookup list from display. Defaults to allow all items.

    • makeSelectBoxItemDisplay

      protected SelectBoxItemDisplay2<E,E> makeSelectBoxItemDisplay(String value, String text, E data)
      May be overridden by subclasses to return formatted text of an enumerated value for display in a select box. data will be null for a blank entry.

    • getList

      public List<SelectBoxItemDisplay2<E,E>> getList()
      Returns formatted version of account list for human display.

    • getSelectedItems

      public Collection<SelectBoxItemDisplay2<E,E>> getSelectedItems()
      Returns selected, formatted items or empty collection if none selected.

    • setList

      public void setList(List<SelectBoxItemDisplay2<E,E>> value)
      Directly sets formatted version of account list for human display. The value must already be sorted.

    • setSelectedFormattedValues

      public void setSelectedFormattedValues(Collection<String> values)
      Selects items matching name of enumerated value. These match the OPTION tag VALUE attributes.
      Parameters:
      values - Name of selected items or null or empty collection to select none.

    • setSelectedFormattedValuesWithConversionError

      public void setSelectedFormattedValuesWithConversionError(Collection<String> values, String conversionErrorName)
      Selects item matching named Struts 2 conversion error (rejected form field value), or formatted identifier if conversion error not found. Only appropriate in a Struts 2 context.
      Parameters:
      values - Enumerated value name.
      conversionErrorName - Name of Struts 2 conversion error, which will have the "<form name>.<field name>" format.

    • setSelectedValues

      public void setSelectedValues(Collection<E> keys)
      Selects items matching enumerated values. Formatted version of key matches the OPTION tag VALUE attribute.
      Parameters:
      keys - Enumerated values of selected items or null or empty collection to select none.

    • setSelectedValuesWithConversionError

      public void setSelectedValuesWithConversionError(Collection<E> keys, String conversionErrorName)
      Selects items matching named Struts 2 conversion errors (rejected form field values), or unformatted identifier if conversion error not found. Only appropriate in a Struts 2 context.
      Parameters:
      keys - Enumerated values.
      conversionErrorName - Name of Struts 2 conversion error, which will have the "<form name>.<field name>" format.