TextInputElementRenderer

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.raritantechnologies.quickstart.taglibrary.forms
Class TextInputElementRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicSearchElementRenderer
      com.raritantechnologies.quickstart.taglibrary.forms.TextInputElementRenderer

All Implemented Interfaces:: IConfigurable, IElementValueBuilder, ISearchElementRenderer

public class TextInputElementRenderer
extends BasicSearchElementRenderer
implements IElementValueBuilder, ISearchElementRenderer

Renders a query input parameter as an HTML text input box within a SearchForm.

Can be configured to initialize the text field from the request, the last submitted query, or from the session cache. It also implements the IElementValueBuilder interface so that it can be updated dynamically from a search source if wrapped in a SearchSourceElementWrapper.

May contain an optional IStringFilter to modify any initial string value before rendering the input box.

XML Configuration Template:

    <SearchElementRenderer 
       rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.TextInputElementRenderer"
       fieldID="theFieldID" 
       cssClass="[ css class ]"
       width="50" 
       initClear="true" 
       initFrom="request|lastQuery|dataWrapper|session"   IMPORTANT: forces initClear="false"
       initFields="fieldIDs to init from"
       clearRequest="sourceType=clear"
       onKeyDown="[onKeyDown handler name]" >

    <InputFilter class="[IStringFilter implementation]" >
      <!-- InputFilter parameters -->
    </InputFilter>

   </SearchElementRenderer>

Developed by Raritan Technologies Inc..

Author:: Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.taglibrary.BasicSearchElementRenderer

enabled, name

Constructor Summary
`TextInputElementRenderer()`
`TextInputElementRenderer(java.lang.String name, java.lang.String fieldID, int width)`
`TextInputElementRenderer(java.lang.String fieldID, java.lang.String cssClass, int width, boolean initClear, java.lang.String clearRequest, java.lang.String initFrom)`

Method Summary
`void`	`addDataChoice(java.lang.String choiceVal, java.lang.String choiceName)`
`void`	`clearDataChoices()`
`protected java.lang.String`	`doGetBody(ISearchFormRenderer parent, RaritanPageContext pageContext)`
`boolean`	`getClearField()`
`java.lang.String`	`getClearRequest()`
`java.lang.String`	`getConfigurationXML()`
`java.lang.String`	`getCssClass()`
`java.lang.String`	`getFieldID()`
`java.lang.String`	`getInitFrom()`
`java.lang.String`	`getOnKeyDown()`
`IStringFilter`	`getStringFilter()`
`int`	`getWidth()`
`void`	`initialize(org.w3c.dom.Element elem)` Initialize renderer-specific parameters from the configuration XML tag.
`void`	`setClearField(boolean clearField)`
`void`	`setClearRequest(java.lang.String clearRequest)`
`void`	`setCssClass(java.lang.String cssClass)`
`void`	`setFieldID(java.lang.String fieldID)`
`void`	`setInitFrom(java.lang.String initFrom)`
`void`	`setOnKeyDown(java.lang.String onKeyDown)`
`void`	`setSelectedValues(java.util.ArrayList values)`
`void`	`setStringFilter(IStringFilter theFilter)`
`void`	`setValue(java.lang.String value)`
`void`	`setWidth(int width)`

Methods inherited from class com.raritantechnologies.searchApp.taglibrary.BasicSearchElementRenderer

doGetBodyDisabled, getBody, getInitValue, getInitValue, getInitValue, getRenderer, isHidden, setEnable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.raritantechnologies.searchApp.taglibrary.ISearchElementRenderer

getBody, getRenderer, isHidden, setEnable

Constructor Detail