de.espirit.firstspirit.webedit.plugin.report

Class ParameterText

java.lang.Object

de.espirit.firstspirit.webedit.plugin.report.ParameterText

All Implemented Interfaces:

Parameter<String>, Serializable

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

String parameter definition. On the client side, this parameter is represented by a textfield.

Since:

5.0.103

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterText(String name, String placeholder, String defaultValue) Creates a new String-typed text input parameter, using the given attributes.

Method Summary

Methods

Modifier and Type	Method and Description
String	cast(Object object) Casts the given object this parameter's value type.
String	getDefaultValue() Provides the parameter's default value.
String	getName() Provides this parameter's name.
String	getPlaceholder() Returns the placeholder for the related textfield on client side.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterText

public ParameterText(String name,
             @Nullable
             String placeholder,
             @Nullable
             String defaultValue)

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

Parameters:

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

placeholder - The default text, if the related textfield is empty. The string will not be used as a value.

defaultValue - The default value of this parameter.

Since:

5.0.103

Method Detail

getName

public String getName()

Provides this 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)

Casts the given object this 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

getPlaceholder

@Nullable
public String getPlaceholder()

Returns the placeholder for the related textfield on client side. The string will not be used as a value.

Returns:

The placeholder text.

Since:

5.0.103