public class AjaxAutoComplete extends AjaxComponent
This is a component that look like a text field, where when you start entering value, it start giving you a menu of options related to what you type. Think about the auto-completion feature of many IDE (XCode / Eclipse) inside a textField.
The scriptaculous library has 2 version of the autocompleter combo-box : a local version and an ajax version.
isLocal binding. Then the list binding will
need to provide all the objects needed to be found. Filtering of the list as
you type will be done client-side, all javascript.
| Bindings | |
list | bound to a method that should return the whole list of object
to be displayed. When used in an Ajax context, the component will
push first to the value binding, giving you the chance
to narrow the list of elements displayed. When used in a Local
context, the list should contain all possible objects. the list will
be filtered by the scriptaculous engine. |
value | string that will hold the text entered in the field. It is
continuously updated. |
item | pushed and pulled the current element of the list. This can be
used to customized the string representation (in conjunction with the
displayString binding) of the object. |
displayString | optional custom string representation of the current
element. |
isLocal | boolean indicating if you want the list to be completely
client-side. Binding a true value, would mean that the list will
filtered on the client. |
isLocalSharedList | boolean indicating if the list needs to be shared. |
localSharedVarName | the name of the javascript variable to use to
store the list in. The list is stored in the userInfo dictionary
on the server side to allow for shared use by multiple auto complete
components. |
token | token |
frequency | Look at the scriptaculous documentation. |
minChars | Look at the scriptaculous documentation. |
indicator | Look at the scriptaculous documentation. |
updateElement | Look at the scriptaculous documentation. |
afterUpdateElement | Look at the scriptaculous documentation. |
select | Look at the scriptaculous documentation. |
onShow | Look at the scriptaculous documentation. |
fullSearch | Look at the scriptaculous documentation. |
partialSearch | Look at the scriptaculous documentation. |
choices | Look at the scriptaculous documentation (Local only) |
partialChars | Look at the scriptaculous documentation (Local only) |
ignoreCase | Look at the scriptaculous documentation (Local only) |
accesskey | hot key that should activate the text field (optional) |
tabindex | tab index of the text field (optional) |
default | hint for the text field, when used together with {@link AjaxTextHinter}. |
selection | if set, if the text field's string matches the displayString of one of the objects in the provided list, that object will be bound back as the selection. currently this only supports displayString renderers and not child templates |
class | class attribute of the text field |
style | class attribute of the text field |
onblur | onblur attribute of the text field |
onfocus | onfocus attribute of the text field |
onchange | onchange attribute of the text field |
activateOnFocus | activate when text field gets focus |
containerId | tag id for the container of the popup div (default is body) |
WOComponent._EventLoggingEnabler, WOComponent.EventNSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.UtilityNSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessorNSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException| Modifier and Type | Field and Description |
|---|---|
java.lang.String |
divName |
java.lang.String |
fieldName |
java.lang.String |
indicatorName |
_Extension, _IsEventLoggingEnabled, _keyAssociations_CLASS_CLASS, _KeyPathSeparatorChar, KeyPathSeparatorNullValue_CLASS| Constructor and Description |
|---|
AjaxAutoComplete(WOContext context) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addRequiredWebResources(WOResponse res)
Adds all required resources.
|
protected void |
appendItemToResponse(java.lang.Object value,
WOElement child,
boolean hasItem,
WOResponse response,
WOContext context) |
void |
appendToResponse(WOResponse res,
WOContext ctx)
Overridden to add the initialization javascript for the auto completer.
|
void |
awake()
Overridden to set the IDs for the field and the div tag.
|
protected NSDictionary |
createAjaxOptions() |
protected java.lang.String |
displayStringForValue(java.lang.Object value) |
WOActionResults |
handleRequest(WORequest request,
WOContext context)
Handles the Ajax request.
|
java.lang.String |
indicator() |
boolean |
isStateless()
Overridden because the component is stateless
|
protected int |
maxItems() |
void |
setStringValue(java.lang.String strValue) |
void |
sleep() |
java.lang.String |
stringValue() |
java.lang.String |
zcontainerName() |
_containerID, addScriptResourceInHead, addScriptResourceInHead, addStylesheetResourceInHead, addStylesheetResourceInHead, appendTagAttributeToResponse, booleanValueForBinding, invokeAction, safeElementID, shouldHandleRequest, valueForBinding, valueForBinding, valueForBinding__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithNamepublic java.lang.String divName
public java.lang.String fieldName
public java.lang.String indicatorName
public AjaxAutoComplete(WOContext context)
public void awake()
awake in class WOComponentpublic void sleep()
sleep in class WOComponentpublic boolean isStateless()
isStateless in class WOComponentpublic java.lang.String indicator()
protected NSDictionary createAjaxOptions()
public void appendToResponse(WOResponse res, WOContext ctx)
appendToResponse in class AjaxComponentres - the HTTP response that an application returns to a Web server to complete a cycle of the request-response loopctx - context of a transactionprotected void addRequiredWebResources(WOResponse res)
addRequiredWebResources in class AjaxComponentres - the response to write topublic java.lang.String stringValue()
protected java.lang.String displayStringForValue(java.lang.Object value)
protected int maxItems()
public void setStringValue(java.lang.String strValue)
protected void appendItemToResponse(java.lang.Object value,
WOElement child,
boolean hasItem,
WOResponse response,
WOContext context)
public WOActionResults handleRequest(WORequest request, WOContext context)
handleRequest in interface IAjaxElementhandleRequest in class AjaxComponentrequest - the requestcontext - the contextpublic java.lang.String zcontainerName()
Copyright © 2002 – 2022 Project Wonder.