Package org.kuali.rice.krad.uif.control

Interface MultiValueControl

All Known Subinterfaces:
SelectControl
All Known Implementing Classes:
CheckboxGroupControl, MultiValueControlBase, OptionListControl, RadioGroupControl, SelectControlBase
public interface MultiValueControl
Indicates Control types that can hold more than one value for selection
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    List<KeyValue>
    getOptions()
    List of values the control can accept.
    List<KeyMessage>
    getRichOptions()
    Gets the richOptions which contain Message objects with the translated rich message structures, which then can be used by templates to output the appropriate content.
    void
    setOptions(List<KeyValue> options)
    Sets the List of KeyValue pairs that make up the options for the control

  • Method Details

    • getOptions

      List<KeyValue> getOptions()
      List of values the control can accept. Each value consists of a key and a label. The key is the what will be submitted back if the user selects the choice, the label is what will be displayed to the user for the choice.

      KeyLabelPair instances are usually generated by the KeyValueFinder associated with the Field for which the control belongs

      Returns:
      List of KeyLabelPair instances

    • setOptions

      void setOptions(List<KeyValue> options)
      Sets the List of KeyValue pairs that make up the options for the control
      Parameters:
      options -

    • getRichOptions

      List<KeyMessage> getRichOptions()
      Gets the richOptions which contain Message objects with the translated rich message structures, which then can be used by templates to output the appropriate content.
      Returns:
      richOptions which include a message object with the translated value content