water.api

Class RequestArguments.TypeaheadInputText<T>

java.lang.Object

water.Iced

water.api.RequestArguments.Argument<T>

water.api.RequestArguments.InputText<T>

water.api.RequestArguments.TypeaheadInputText<T>

All Implemented Interfaces:

java.lang.Cloneable, Request.Filter, Freezable

Direct Known Subclasses:

ExportS3.BucketArg, ImportHdfs.PathArg, ImportS3.BucketArg, Parse.ExistingCSVKey, Request2.TypeaheadKey, RequestArguments.ExistingFile, RequestArguments.GeneralFile, RequestArguments.H2OExistingKey, RequestArguments.H2OHexKey, RequestArguments.H2OKey2, RequestArguments.H2OModelKey

Enclosing class:

RequestArguments

public abstract class RequestArguments.TypeaheadInputText<T>
extends RequestArguments.InputText<T>

Typeahead enabled text input. Typeahead is enabled using the jQuery typeahead plugin. You must specify the JSON request which provides the typeahead, and the data name in the response that contains the array of strings corresponding to the typeahead options. Optionally you can specify the typeahead limit (how many options will be displayed), which is 1024 by default. The typeahead json request must take Str argument filter and Int optional argument limit.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_typeaheadHref href of the json request supplying the typeahead values.
protected int	_typeaheadLimit Typeahead limit.

Fields inherited from class water.api.RequestArguments.Argument

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestArguments.TypeaheadInputText(java.lang.Class<? extends TypeaheadRequest> href, java.lang.String name, boolean required) Creates the typeahead.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	jsAddons() Adds the json to hook initialize the typeahead functionality.

Methods inherited from class water.api.RequestArguments.InputText

jsRefresh, jsValue, queryElement

Methods inherited from class water.api.RequestArguments.Argument

addPrerequisite, check, defaultValue, disable, disable, disabled, errors, getDisplayName, getName, originalValue, parse, query, queryAddons, queryComment, queryDescription, 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

_typeaheadHref

protected final java.lang.String _typeaheadHref

href of the json request supplying the typeahead values.

_typeaheadLimit

protected final int _typeaheadLimit

Typeahead limit. If more than this limit options will be available, the typeahead will be disabled.

Constructor Detail

RequestArguments.TypeaheadInputText

protected RequestArguments.TypeaheadInputText(java.lang.Class<? extends TypeaheadRequest> href,
                                   java.lang.String name,
                                   boolean required)

Creates the typeahead.

Method Detail

jsAddons

protected java.lang.String jsAddons()

Adds the json to hook initialize the typeahead functionality. It is jQuery typeahead plugin standard initialization with async filler.

Overrides:

jsAddons in class RequestArguments.Argument<T>