org.araneaframework.uilib.form.control
Class AutoCompleteTextControl

java.lang.Object
  org.araneaframework.core.BaseComponent
      org.araneaframework.core.BaseService
          org.araneaframework.core.BaseWidget
              org.araneaframework.core.BaseApplicationWidget
                  org.araneaframework.uilib.form.control.BaseControl
                      org.araneaframework.uilib.form.control.StringArrayRequestControl
                          org.araneaframework.uilib.form.control.StringRequestControl
                              org.araneaframework.uilib.form.control.EmptyStringNullableControl
                                  org.araneaframework.uilib.form.control.StringValueControl
                                      org.araneaframework.uilib.form.control.TextControl
                                          org.araneaframework.uilib.form.control.AutoCompleteTextControl

All Implemented Interfaces:

ApplicationComponent, ApplicationService, ApplicationWidget, Component, Composite, Composite.CompositeComponent, Composite.CompositeService, Composite.CompositeWidget, Control, FilteredInputControl, FormElementAware, Serializable, Service, Viewable, Viewable.ViewableComponent, Viewable.ViewableService, Viewable.ViewableWidget, Widget

public class AutoCompleteTextControl

extends TextControl

TextControl with AJAX autocompletion support.

Author:

Steven Jentson (steven@webmedia.ee), Taimo Peelo (taimo@araneaframework.org)

See Also:

Serialized Form

Nested Class Summary

static interface	AutoCompleteTextControl.DataProvider
static class	AutoCompleteTextControl.DefaultResponseBuilder Default AutoCompleteTextControl.ResponseBuilder used when AutoCompleteTextControl does not have its AutoCompleteTextControl.ResponseBuilder set and ConfigurationContext.AUTO_COMPLETE_RESPONSE_BUILDER does not specify application-wide AutoCompleteTextControl.ResponseBuilder.
static interface	AutoCompleteTextControl.ResponseBuilder Autocompletion response builder interface.
class	AutoCompleteTextControl.ViewModel

Nested classes inherited from class org.araneaframework.uilib.form.control.BaseControl

BaseControl.WidgetImpl

Nested classes inherited from class org.araneaframework.core.BaseApplicationWidget

BaseApplicationWidget.CompositeImpl, BaseApplicationWidget.ViewableImpl

Nested classes inherited from class org.araneaframework.core.BaseService

BaseService.ServiceImpl

Nested classes inherited from class org.araneaframework.core.BaseComponent

BaseComponent.ComponentImpl

Nested classes inherited from class org.araneaframework.Widget

Widget.Interface

Nested classes inherited from class org.araneaframework.Viewable

Viewable.Interface, Viewable.ViewableComponent, Viewable.ViewableService, Viewable.ViewableWidget

Nested classes inherited from class org.araneaframework.core.ApplicationWidget

ApplicationWidget.WidgetViewModel

Nested classes inherited from class org.araneaframework.core.ApplicationService

ApplicationService.ServiceViewModel

Nested classes inherited from class org.araneaframework.core.ApplicationComponent

ApplicationComponent.ComponentViewModel

Nested classes inherited from class org.araneaframework.Composite

Composite.CompositeComponent, Composite.CompositeService, Composite.CompositeWidget, Composite.Interface

Field Summary

protected AutoCompleteTextControl.DataProvider	dataProvider
static String	LISTENER_NAME
protected long	minCompletionLength
protected AutoCompleteTextControl.ResponseBuilder	responseBuilder

Fields inherited from class org.araneaframework.uilib.form.control.TextControl

textType

Fields inherited from class org.araneaframework.uilib.form.control.StringArrayRequestControl

eventHelper

Fields inherited from class org.araneaframework.uilib.form.control.BaseControl

innerData, isReadFromRequest, value

Fields inherited from class org.araneaframework.core.BaseService

currentInputData, currentOutputData

Fields inherited from interface org.araneaframework.core.ApplicationWidget

EVENT_HANDLER_ID_KEY, EVENT_PARAMETER_KEY, EVENT_PATH_KEY

Fields inherited from interface org.araneaframework.core.ApplicationService

ACTION_HANDLER_ID_KEY, ACTION_PARAMETER_KEY, ACTION_PATH_KEY

Constructor Summary

AutoCompleteTextControl()

AutoCompleteTextControl(long minCompletionLength)

AutoCompleteTextControl(TextType textType)

AutoCompleteTextControl(TextType textType, long minCompletionLength)

Method Summary

AutoCompleteTextControl.ResponseBuilder	getResponseBuilder()
Object	getViewModel() Returns AutoCompleteTextControl.ViewModel.
protected void	init() Init callback.
protected AutoCompleteTextControl.ResponseBuilder	resolveResponseBuilder()
void	setDataProvider(AutoCompleteTextControl.DataProvider dataProvider)
void	setResponseBuilder(AutoCompleteTextControl.ResponseBuilder responseBuilder)

Methods inherited from class org.araneaframework.uilib.form.control.TextControl

getInputFilter, setInputFilter, setTextType, validateNotNull

Methods inherited from class org.araneaframework.uilib.form.control.StringValueControl

fromRequest, getRawValueType, setMaxLength, setMinLength, setTrimValue, toResponse

Methods inherited from class org.araneaframework.uilib.form.control.EmptyStringNullableControl

isRead, preprocessRequestParameter

Methods inherited from class org.araneaframework.uilib.form.control.StringRequestControl

fromRequestParameters, preprocessRequestParameters, toResponseParameters

Methods inherited from class org.araneaframework.uilib.form.control.StringArrayRequestControl

addOnChangeEventListener, clearOnChangeEventListeners, convert, readFromRequest, setRawValue, validate

Methods inherited from class org.araneaframework.uilib.form.control.BaseControl

_getWidget, action, addError, convertAndValidate, getFormElementCtx, getLabel, getRawValue, handleEvent, isDisabled, isMandatory, isValid, setFormElementCtx, update

Methods inherited from class org.araneaframework.core.BaseApplicationWidget

_getComposite, _getViewable, addActionListener, addEventListener, addWidget, addWidget, clearActionListeners, clearEventlisteners, clearGlobalEventListener, disableWidget, enableWidget, event, getActionId, getChildEnvironment, getChildren, getChildWidgetEnvironment, getEnvironment, getEventId, getWidget, handleAction, handleUpdate, propagate, putViewData, putViewDataOnce, removeActionListener, removeEventListener, removeViewData, removeWidget, render, setGlobalEventListener

Methods inherited from class org.araneaframework.core.BaseWidget

getInputData, getOutputData, handleWidgetException

Methods inherited from class org.araneaframework.core.BaseService

_getService, handleServiceException

Methods inherited from class org.araneaframework.core.BaseComponent

_addComponent, _addComponent, _checkCall, _disableComponent, _enableComponent, _endCall, _endWaitingCall, _getChildren, _getComponent, _getDisabledChildren, _propagate, _relocateComponent, _removeComponent, _setEnvironment, _setScope, _startCall, _startWaitingCall, _strictCheckCall, _strictStartCall, _waitNoCall, destroy, disable, enable, getScope, handleException, isAlive, isDead, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.araneaframework.uilib.form.Control

convert, getRawValue, getRawValueType, isDisabled, isRead, setRawValue, validate

Methods inherited from interface org.araneaframework.Widget

_getWidget

Methods inherited from interface org.araneaframework.Service

_getService

Methods inherited from interface org.araneaframework.Component

_getComponent, getEnvironment, getScope, isAlive

Methods inherited from interface org.araneaframework.Viewable

_getViewable

Methods inherited from interface org.araneaframework.uilib.form.FormElementAware

setFormElementCtx

Field Detail

LISTENER_NAME

public static final String LISTENER_NAME

See Also:

Constant Field Values

minCompletionLength

protected long minCompletionLength

dataProvider

protected AutoCompleteTextControl.DataProvider dataProvider

responseBuilder

protected AutoCompleteTextControl.ResponseBuilder responseBuilder

Constructor Detail

AutoCompleteTextControl

public AutoCompleteTextControl()

AutoCompleteTextControl

public AutoCompleteTextControl(long minCompletionLength)

Parameters:

minCompletionLength - number of chars that must be input before suggestions are provided

AutoCompleteTextControl

public AutoCompleteTextControl(TextType textType)

AutoCompleteTextControl

public AutoCompleteTextControl(TextType textType,
                               long minCompletionLength)

Parameters:

minCompletionLength - number of chars that must be input before suggestions are provided

Method Detail

init

protected void init()
             throws Exception

Description copied from class: BaseComponent

Init callback. Gets called when the component is initilized.

Overrides:

init in class StringArrayRequestControl

Throws:

Exception

setDataProvider

public void setDataProvider(AutoCompleteTextControl.DataProvider dataProvider)

setResponseBuilder

public void setResponseBuilder(AutoCompleteTextControl.ResponseBuilder responseBuilder)

Since:

1.0.4

getResponseBuilder

public AutoCompleteTextControl.ResponseBuilder getResponseBuilder()

Returns:

AutoCompleteTextControl.ResponseBuilder that will be used to build response with suggestions.

Since:

1.0.4

resolveResponseBuilder

protected AutoCompleteTextControl.ResponseBuilder resolveResponseBuilder()

Since:

1.0.4

getViewModel

public Object getViewModel()

Returns AutoCompleteTextControl.ViewModel.

Overrides:

getViewModel in class TextControl

Returns:

AutoCompleteTextControl.ViewModel.