org.kuali.rice.core.api.uif

Class RemotableSelect.Builder

java.lang.Object

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

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

All Implemented Interfaces:

ModelBuilder, KeyLabeled, RemotableControlContract, RemotableSelectContract, Sized

Enclosing class:

RemotableSelect

public static final class RemotableSelect.Builder
extends RemotableAbstractControl.Builder
implements RemotableSelectContract

Method Summary

Methods

Modifier and Type	Method and Description
RemotableSelect	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static RemotableSelect.Builder	create(List<RemotableSelectGroup.Builder> groups)
static RemotableSelect.Builder	create(Map<String,String> keyLabels)
List<RemotableSelectGroup.Builder>	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.
void	setGroups(List<RemotableSelectGroup.Builder> groups)
void	setKeyLabels(Map<String,String> keyLabels)
void	setMultiple(boolean multiple)
void	setRefreshOnChange(boolean refreshOnChange)
void	setSize(Integer size)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RemotableSelect.Builder create(Map<String,String> keyLabels)

create

public static RemotableSelect.Builder create(List<RemotableSelectGroup.Builder> groups)

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.

setSize

public void setSize(Integer size)

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.

setKeyLabels

public void setKeyLabels(Map<String,String> keyLabels)

getGroups

public List<RemotableSelectGroup.Builder> 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.

setGroups

public void setGroups(List<RemotableSelectGroup.Builder> 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

setMultiple

public void setMultiple(boolean multiple)

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

setRefreshOnChange

public void setRefreshOnChange(boolean refreshOnChange)

build

public RemotableSelect build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Specified by:

build in class RemotableAbstractControl.Builder

Returns:

an instance of the object being built by this builder, should never return null