de.espirit.firstspirit.webedit.plugin.report

Class ParameterSelect

java.lang.Object

de.espirit.firstspirit.webedit.plugin.report.ParameterSelect

All Implemented Interfaces:

Parameter<String>, Serializable

@GwtCompatible
public class ParameterSelect
extends Object
implements Parameter<String>

Selection parameter definition. On the client side, this parameter is represented by a listbox.

Since:

5.0.103

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterSelect.SelectItem Definition for a selectable item.

Constructor Summary

Constructors

Constructor and Description
ParameterSelect(String name, List<ParameterSelect.SelectItem> items, String defaultValue) Creates a new String-typed selection parameter, using the given attributes.

Method Summary

Methods

Modifier and Type	Method and Description
String	cast(Object object) Cast's the given object to the parameter's value type.
String	getDefaultValue() Provides the parameter's default value.
List<ParameterSelect.SelectItem>	getItems() Returns the list of selectable items for the related listbox on client side.
String	getName() Privides the parameter's name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterSelect

public ParameterSelect(String name,
               List<ParameterSelect.SelectItem> items,
               @Nullable
               String defaultValue)

Creates a new String-typed selection parameter, using the given attributes.

Parameters:

name - Name of this parameter, should be unique within a WebeditReportPlugin.

items - List of selectable items for the related listbox on client side.

defaultValue - The default value of this parameter.

Since:

5.0.103

Method Detail

getName

public String getName()

Privides the parameter's name.

Specified by:

getName in interface Parameter<String>

Returns:

The parameter's name.

Since:

5.0.103

cast

public String cast(Object object)

Cast's the given object to the parameter's value type.

Specified by:

cast in interface Parameter<String>

Parameters:

object - The object to be cast.

Returns:

The cast object.

Since:

5.0.103

getDefaultValue

public String getDefaultValue()

Provides the parameter's default value.

Specified by:

getDefaultValue in interface Parameter<String>

Returns:

The default value.

Since:

5.0.103

getItems

public List<ParameterSelect.SelectItem> getItems()

Returns the list of selectable items for the related listbox on client side.

Returns:

Selectable items.

Since:

5.0.103