CheckboxResultRenderer

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 CheckboxResultRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      com.raritantechnologies.quickstart.taglibrary.forms.CheckboxResultRenderer

All Implemented Interfaces:: IConfigurable, IPreferencesBeanInfo, IResultRenderer, ISessionDataHandler

public class CheckboxResultRenderer
extends BasicResultRenderer
implements ISessionDataHandler, IResultRenderer

Renders an IResult as a checkbox. Keeps a list of selected results for a user session on the server.

XML Configuration Template:

   <ResultRenderer 
        rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.CheckboxResultRenderer" 
        useHost="true"
        width="[ field width ]" 
        formField="[ checkbox http field name - used to send selections ]"
        formName="[ related display form name ]"
        setvalue="[true|false - if true a 'value' attribute is added to checkbox tag] "
        cacheResultSetName="[ name to use as session cache key of selected results ]"
        lastResultSetName="[ optional name of last result set to use (if result set is cached ) ]"
        addFieldID="[true|false - if true, appended fieldID to cacheResultSetName in session data]" 
        synchronizeCheckboxes="[true|false(default) - if true will sync all checkboxes on the same page with the same name - this requires <form> wrappers ]"
        redirectURL="[ optional URL to redirect to after a checkbox update ]"
        redirectParams="[ comma separated list of request params to include in a redirect ]" >

    <!-- Key field or id field used to determine unique result.     -->
    <Field ID="fieldID" />

    <!-- If SetField is included, checkbox toggles a result value.  -->
    <!-- else checkbox toggles the inclusion of the result in       -->
    <!-- in the cached record set.                                  -->
    <!-- NOTE: SetField checkboxes should be used with non-SetField -->
    <!-- checkboxes or the result will not be available in the      -->
    <!-- cached set!                                                -->
    <SetField ID="[ field ID of toggled value ]"
                 onVal="[ value of field if checkbox is set ]" 
                 offVal="[ value of field if checkbox is unset ]" />  

   </ResultRenderer>

Developed by Raritan Technologies Inc..

Author:: Ted Sullivan

Field Summary

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

enabled, name, prefBeanName, prefCompareValue, prefEnableIfInChecklist, prefEnableIfInYesno

Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IResultRenderer

TEMPLATE

Constructor Summary
`CheckboxResultRenderer()`

Method Summary
`protected java.lang.String`	`doRenderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext)`
`static java.lang.String`	`filterIDValue(java.lang.String pIdValue)`
`java.lang.String`	`getCacheResultSetName()`
`java.lang.String`	`getConfigurationXML()`
`java.lang.String`	`getConfigurationXML(java.lang.String configurationTemplate)`
`void`	`getConfigurationXML(java.io.Writer writer)`
`java.lang.String`	`getDelimiter()`
`java.lang.String`	`getFieldID()`
`java.lang.String`	`getFormField()`
`static java.lang.String`	`getIDValue(IResult result, java.lang.String fieldID)`
`static java.lang.String`	`getIDValue(IResult result, java.lang.String fieldID, java.lang.String sourceName)`
`boolean`	`getSetValue()`
`java.lang.String`	`getTitle()`
`void`	`handleSessionData(java.util.Map sessionDataMap, RaritanPageContext pageContext)` Updates session data parameters handled by this handler and/or updates handler parameters.
`void`	`initialize(org.w3c.dom.Element elem)` IResultRenderers are XML configurable.
`void`	`registerDataHandler(ISessionDataManager manager, java.util.Map params)` Register this SessionDataHandler with a SessionDataManager.
`void`	`setCacheResultSetName(java.lang.String cacheResultSetName)`
`void`	`setDelimiter(java.lang.String delimiter)`
`void`	`setFieldID(java.lang.String fieldID)`
`void`	`setFormField(java.lang.String formField)`
`void`	`setResultSetField(java.lang.String fieldName, java.lang.String onVal, java.lang.String offVal)`
`void`	`setSetValue(boolean setValue)`
`void`	`setTitle(java.lang.String title)`

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

getPrefBeanName, getPrefCompareValue, getPrefEnableIfInChecklist, getPrefEnableIfInYesno, getRenderer, isEnabled, renderResult, 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.IResultRenderer

getRenderer, isEnabled, renderResult, setEnable

Constructor Detail