org.kuali.rice.core.api.uif

Class RemotableSelect

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.core.api.uif.RemotableAbstractControl

org.kuali.rice.core.api.uif.RemotableSelect

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, KeyLabeled, RemotableControlContract, RemotableSelectContract, Sized

public final class RemotableSelect
extends RemotableAbstractControl
implements RemotableSelectContract

A select control type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemotableSelect.Builder

Method Summary

Methods

Modifier and Type	Method and Description
List<RemotableSelectGroup>	getGroups() Gets an immutable list of Grouped keyLabel pairs.
Map<String,String>	getKeyLabels() The key-label pairs to display on the control.
Integer	getSize() The size value to make the control.
boolean	isMultiple() Whether the select control allows selection of multiple values.
boolean	isRefreshOnChange() If true, indicates that the page needs to be refreshed whenever the drop-down value is changed.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getKeyLabels

public Map<String,String> getKeyLabels()

Description copied from interface: KeyLabeled

The key-label pairs to display on the control. This field cannot be null or an empty map.

Specified by:

getKeyLabels in interface KeyLabeled

Returns:

a map containing values.

getSize

public Integer getSize()

Description copied from interface: Sized

The size value to make the control. This field can be null. Cannot be less than 1.

Specified by:

getSize in interface Sized

Returns:

the size value or null.

getGroups

public List<RemotableSelectGroup> getGroups()

Description copied from interface: RemotableSelectContract

Gets an immutable list of Grouped keyLabel pairs. When this list is non-empty, KeyLabeled.getKeyLabels() must be empty. Cannot be null.

Specified by:

getGroups in interface RemotableSelectContract

Returns:

the list of groups.

isMultiple

public boolean isMultiple()

Description copied from interface: RemotableSelectContract

Whether the select control allows selection of multiple values. defaults to false.

Specified by:

isMultiple in interface RemotableSelectContract

Returns:

allows multiple selections

isRefreshOnChange

public boolean isRefreshOnChange()

Description copied from interface: RemotableSelectContract

If true, indicates that the page needs to be refreshed whenever the drop-down value is changed.

Specified by:

isRefreshOnChange in interface RemotableSelectContract

Returns:

whether or not to refresh the page when the select value is changed