RadioButtonGroupElement

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 RadioButtonGroupElement

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

All Implemented Interfaces:: IConfigurable, IElementValueBuilder, ISearchElementRenderer

public class RadioButtonGroupElement
extends BasicSearchElementRenderer
implements IElementValueBuilder

Renders a query input field as a set of radio buttons choices within a SearchForm. A radio button group field can have one or more choices, which can be statically defined or obtained dynamically from a SearchSource lookup.

XML Configuration Template:

  <SearchElementRenderer 
     rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.RadioButtonGroupElement"
     fieldID="theFieldID" 
     cssClass="CSS style class" 
     initFrom="request|session" 
     onChangeHandler="[ change handler attribute ]"
     columns="[ number of columns of radio buttons (default=4)]" >

    <Data>
      <Choice value="aVal" name="A Value" default="on"/>
      <Choice value="bVal" name="B Value" />
      <Choice value="cVal" name="C Value" />
    </Data>

    <Data searchSource="searchSourceName"
             resultNameField="[field ID from search result that has choice name]"
             resultValueField="[field ID from search result that has choice value]" >
      <!-- Optional query to search source -->
      <Query>
      </Query>
    </Data>

  </SearchElementRenderer>

Developed by Raritan Technologies Inc..

Author:: Ted Sullivan

Field Summary

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

enabled, name

Constructor Summary
`RadioButtonGroupElement()`
`RadioButtonGroupElement(java.lang.String fieldID, OrderedMap data, int columns)`
`RadioButtonGroupElement(java.lang.String fieldID, OrderedMap data, int columns, java.lang.String defaultVal)`

Method Summary
`void`	`addDataChoice(java.lang.String choiceVal, java.lang.String choiceName)`
`void`	`clearDataChoices()`
`protected java.lang.String`	`doGetBody(ISearchFormRenderer parent, RaritanPageContext pageContext)`
`OrderedMap`	`getChoiceData()`
`int`	`getColumns()`
`java.lang.String`	`getConfigurationXML()`
`void`	`getConfigurationXML(java.io.Writer writer)`
`java.lang.String`	`getCssClass()`
`java.lang.String`	`getDefaultChoice()`
`java.lang.String`	`getFieldID()`
`java.lang.String`	`getInitFrom()`
`java.lang.String`	`getOnChangeHandler()`
`OrderedMap`	`getQueryMap()`
`java.lang.String`	`getResultNameField()`
`java.lang.String`	`getResultValueField()`
`java.lang.String`	`getSearchSourceName()`
`void`	`initialize(org.w3c.dom.Element elem)` Initialize renderer-specific parameters from the configuration XML tag.
`void`	`setChoiceData(java.lang.String[] values, java.lang.String[] names)`
`void`	`setColumns(int columns)`
`void`	`setCssClass(java.lang.String cssClass)`
`void`	`setDefaultChoice(java.lang.String defaultChoice)`
`void`	`setFieldID(java.lang.String fieldID)`
`void`	`setInitFrom(java.lang.String initFrom)`
`void`	`setOnChangeHandler(java.lang.String onChangeHandler)`
`void`	`setQueryMap(java.lang.String[] fieldIDs, java.lang.String[] values)`
`void`	`setResultNameField(java.lang.String resultNameField)`
`void`	`setResultValueField(java.lang.String resultValueField)`
`void`	`setSearchSourceName(java.lang.String searchSourceName)`
`void`	`setSelectedValues(java.util.ArrayList values)`
`void`	`setValue(java.lang.String value)`

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

Constructor Detail