de.espirit.firstspirit.webedit.plugin.report

Class ParameterBoolean

java.lang.Object

de.espirit.firstspirit.webedit.plugin.report.ParameterBoolean

All Implemented Interfaces:

Parameter<Boolean>, Serializable

@GwtCompatible
public class ParameterBoolean
extends Object
implements Parameter<Boolean>

Boolean parameter definition. On the client side, this parameter is represented by a checkbox.

Since:

5.0.103 todo [117605] factory?

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterBoolean(String name, String label, Boolean defaultValue) Creates a new Boolean-typed parameter, using the given attributes.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	cast(Object object) Casts the given object to the parameter's value type.
Boolean	getDefaultValue() Provides the parameter's default value.
String	getLabel() Returns the label for the related checkbox on client side.
String	getName() Provides the parameter's name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterBoolean

public ParameterBoolean(String name,
                String label,
                @Nullable
                Boolean defaultValue)

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

Parameters:

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

label - The label for the related checkbox on client side.

defaultValue - The default value of this parameter.

Since:

5.0.103

Method Detail

cast

public Boolean cast(Object object)

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

Specified by:

cast in interface Parameter<Boolean>

Parameters:

object - The object to be cast.

Returns:

The cast object.

Since:

5.0.103

getDefaultValue

public Boolean getDefaultValue()

Provides the parameter's default value.

Specified by:

getDefaultValue in interface Parameter<Boolean>

Returns:

The default value.

Since:

5.0.103

getName

public String getName()

Provides the parameter's name.

Specified by:

getName in interface Parameter<Boolean>

Returns:

The parameter's name.

Since:

5.0.103

getLabel

public String getLabel()

Returns the label for the related checkbox on client side.

Returns:

The checkbox label.

Since:

5.0.103