HiddenInputElementRenderer

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 HiddenInputElementRenderer

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

All Implemented Interfaces:: IConfigurable, IElementValueBuilder, ISearchElementRenderer

public class HiddenInputElementRenderer
extends BasicSearchElementRenderer
implements IElementValueBuilder

Renders a query input parameter as an HTML hidden field in a SearchForm.

XML Configuration Template:

  <SearchElementRenderer 
     rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.HiddenInputElementRenderer"
     fieldID="theFieldID" 
     initField="requestParam,requestParam2"  
     userParam="userParam"            <!-- Alternately - post hidden values from user attributes -->  
     appParam="[app param list]"      <!-- OR - post hidden values from AppID parameter map -->
     defaultValue="defaultValue"
     staticValue="[ fixed value of hidden field - can't be an empty string: _CREATE_GUID_ - generates a unique key ]"
     initClear="true"
     initFrom="request"
     fieldDelim="|" valueDelim=","
     showOnlyIfHasValue="true|false(default)" >

    <!-- Alternatively: can use an IComparator to filter the current set of request parameters -->
    <RequestSelector class="[ class of com.raritantechnologies.utils.comparators.IComparator ]" >

    </RequestSelector>

    <!-- OR: Can use a SearchSource to get hidden fields -->
    <Data searchSource="[ search source name ]"
             nameField="[ result field to use for name ]"
             valueField="[ result field to use for value ]" >
       <Query>
         <Param name="[query param]" value="[query value]" />
         <Param name="[query param]" request="[ request parameter ]" />
       </Query>
      
    </Data>

  </SearchElementRenderer>

Developed by Raritan Technologies Inc..

Author:: Ted Sullivan

Field Summary
`static java.lang.String`	`CREATE_GUID`

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

enabled, name

Constructor Summary
`HiddenInputElementRenderer()`

Method Summary
`void`	`addDataChoice(java.lang.String choiceVal, java.lang.String choiceName)`
`void`	`clearDataChoices()`
`protected java.lang.String`	`doGetBody(ISearchFormRenderer parent, RaritanPageContext pageContext)`
`boolean`	`getAppParams()`
`boolean`	`getClearField()`
`java.lang.String`	`getConfigurationXML()`
`void`	`getConfigurationXML(java.io.Writer writer)`
`java.lang.String`	`getDefaultValue()`
`java.lang.String`	`getFieldDelim()`
`java.lang.String`	`getFieldID()`
`java.lang.String`	`getInitFrom()`
`java.lang.String[]`	`getRequestParams()`
`java.lang.String`	`getStaticValue()`
`boolean`	`getUserParams()`
`java.lang.String`	`getValueDelim()`
`void`	`initialize(org.w3c.dom.Element elem)` Initialize renderer-specific parameters from the configuration XML tag.
`boolean`	`isHidden(ISearchFormRenderer parent, RaritanPageContext pageContext)`
`void`	`setAppParams(boolean appParams)`
`void`	`setClearField(boolean clearField)`
`void`	`setDefaultValue(java.lang.String defaultValue)`
`void`	`setFieldDelim(java.lang.String fieldDelim)`
`void`	`setFieldID(java.lang.String fieldID)`
`void`	`setInitFrom(java.lang.String initFrom)`
`void`	`setRequestParams(java.lang.String[] requestParams)`
`void`	`setSelectedValues(java.util.ArrayList values)`
`void`	`setStaticValue(java.lang.String staticValue)`
`void`	`setUserParams(boolean userParams)`
`void`	`setValue(java.lang.String value)`
`void`	`setValueDelim(java.lang.String valueDelim)`

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_GUID

public static final java.lang.String CREATE_GUID

See Also:: Constant Field Values

Constructor Detail