water.api

Class RequestArguments.StringList

java.lang.Object

water.Iced

water.api.RequestArguments.Argument<T>

water.api.RequestArguments.InputSelect<java.lang.String>

water.api.RequestArguments.StringList

All Implemented Interfaces:

java.lang.Cloneable, Request.Filter, Freezable

Enclosing class:

RequestArguments

public class RequestArguments.StringList
extends RequestArguments.InputSelect<java.lang.String>

Field Summary

Fields

Modifier and Type	Field and Description
int	_defaultIndex
java.lang.String[]	_values

Fields inherited from class water.api.RequestArguments.Argument

_displayName, _field, _gridable, _hideInQuery, _mustExist, _name, _prerequisites, _readOnly, _requestHelp, _required, _validator

Constructor Summary

Constructors

Constructor and Description
RequestArguments.StringList(java.lang.String name, java.lang.String[] values)
RequestArguments.StringList(java.lang.String name, java.lang.String[] values, int defaultIndex)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	defaultValue() Returns the default value of the argument.
protected java.lang.String	parse(java.lang.String input) Override this method to provide parsing of the input string to the Java expected value.
protected java.lang.String	queryDescription() Returns the query description.
protected java.lang.String	selectedItemValue() Returns which value should be selected.
protected java.lang.String[]	selectValues() Override this method to provide the values for the options.

Methods inherited from class water.api.RequestArguments.InputSelect

jsRefresh, jsValue, queryElement, selectNames

Methods inherited from class water.api.RequestArguments.Argument

addPrerequisite, check, disable, disable, disabled, errors, getDisplayName, getName, jsAddons, originalValue, query, queryAddons, queryComment, record, refreshOnChange, requestHelp, reset, run, setRefreshOnChange, specified, valid, value

Methods inherited from class water.Iced

clone, frozenType, init, newInstance, read, toDocField, write, writeJSON, writeJSONFields

Methods inherited from class java.lang.Object

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

Field Detail

_values

public final java.lang.String[] _values

_defaultIndex

public final int _defaultIndex

Constructor Detail

RequestArguments.StringList

public RequestArguments.StringList(java.lang.String name,
                           java.lang.String[] values)

RequestArguments.StringList

public RequestArguments.StringList(java.lang.String name,
                           java.lang.String[] values,
                           int defaultIndex)

Method Detail

selectValues

protected java.lang.String[] selectValues()

Description copied from class: RequestArguments.InputSelect

Override this method to provide the values for the options. These will be the possible values returned by the form's input and should be the possible values for the JSON argument.

Specified by:

selectValues in class RequestArguments.InputSelect<java.lang.String>

selectedItemValue

protected java.lang.String selectedItemValue()

Description copied from class: RequestArguments.InputSelect

Returns which value should be selected. This is *not* the default value itself, as the default values may be of any type, but the input value that should be selected in the browser.

Specified by:

selectedItemValue in class RequestArguments.InputSelect<java.lang.String>

parse

protected java.lang.String parse(java.lang.String input)
                          throws java.lang.IllegalArgumentException

Description copied from class: RequestArguments.Argument

Override this method to provide parsing of the input string to the Java expected value. The input is guaranteed to be non-empty when this method is called and all prerequisities are guaranteed to be valid before this method is called.

Specified by:

parse in class RequestArguments.Argument<java.lang.String>

Throws:

java.lang.IllegalArgumentException

defaultValue

protected java.lang.String defaultValue()

Description copied from class: RequestArguments.Argument

Returns the default value of the argument. Note that the method will be called also on required arguments, in which case it is ok return null. It is kept abstract because defining a proper default value might be tricky and in many case you do not want it to be null. Overriding it always makes you think:)

Specified by:

defaultValue in class RequestArguments.Argument<java.lang.String>

queryDescription

protected java.lang.String queryDescription()

Description copied from class: RequestArguments.Argument

Returns the query description. This is a concise description of a correct value for the argument. generally used as a placeholder in the html query elements.

Specified by:

queryDescription in class RequestArguments.Argument<java.lang.String>