com.raritantechnologies.quickstart.taglibrary.forms
Class ResultFieldDisplayCheckboxRenderer

java.lang.Object
  com.raritantechnologies.quickstart.taglibrary.forms.ResultFieldDisplayCheckboxRenderer

All Implemented Interfaces:

IConfigurable, IDisplayControlRenderer

Direct Known Subclasses:

ResultFieldDisplayHyperlinkRenderer

public class ResultFieldDisplayCheckboxRenderer

extends java.lang.Object

implements IDisplayControlRenderer

Provides a checkbox control to turn an IResult field display on/off for all of the results in a result DisplayForm.

XML Configuration Template:

   <DisplayControlRenderer 
            rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.ResultFieldDisplayCheckboxRenderer"
            displayForm="[ Associated display form name ]"
            showLabel="[ checkbox label to be shown when field is disabled ]"
            hideLabel="[ checkbox label to be shown when field is enabled ]"
            class="the CSS Class" >
    <Field ID="[ result field To control ]" label="[ checkbox field label ]" />
  </DisplayControlRenderer>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

protected java.lang.String	clazz
protected java.util.ArrayList	fieldLabels
protected java.util.ArrayList	fieldNames
protected java.lang.String	hideLabel
protected boolean	initialState
protected java.lang.String	label
protected java.lang.String	outsideDisplayForm
protected java.lang.String	showLabel

Constructor Summary

ResultFieldDisplayCheckboxRenderer()

Method Summary

protected java.lang.String	doGetBody(IDisplayFormRenderer parent, java.lang.String displayForm, RaritanPageContext pageContext)
protected void	enableAllRenderers(RaritanPageContext pageContext)
java.lang.String	getBody(IDisplayFormRenderer parent, java.lang.String displayForm, RaritanPageContext pageContext)
java.lang.String	getConfigurationXML()
java.lang.String	getCssClass()
protected java.lang.String	getDisabledRenderers(RaritanPageContext pageContext)
protected java.lang.String	getEnabledRenderers(RaritanPageContext pageContext)
java.lang.String[]	getFieldLabels()
java.lang.String[]	getFieldNames()
java.lang.String	getHideLabel()
java.lang.String	getLabel()
protected boolean	getRendererState(IDisplayFormRenderer parent, java.lang.String fieldName, RaritanPageContext pageContext)
java.lang.String	getShowLabel()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	initialize(java.util.Map paramMap)
void	setCssClass(java.lang.String clazz)
void	setFieldLabels(java.lang.String[] fieldLabels)
void	setFieldNames(java.lang.String[] fieldNames)
void	setHideLabel(java.lang.String hideLabel)
void	setLabel(java.lang.String label)
void	setShowLabel(java.lang.String showLabel)

Methods inherited from class java.lang.Object

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

Field Detail

fieldNames

protected java.util.ArrayList fieldNames

fieldLabels

protected java.util.ArrayList fieldLabels

showLabel

protected java.lang.String showLabel

hideLabel

protected java.lang.String hideLabel

label

protected java.lang.String label

clazz

protected java.lang.String clazz

outsideDisplayForm

protected java.lang.String outsideDisplayForm

initialState

protected boolean initialState

Constructor Detail

ResultFieldDisplayCheckboxRenderer

public ResultFieldDisplayCheckboxRenderer()

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IDisplayControlRenderer

initialize

public void initialize(java.util.Map paramMap)

Specified by:

initialize in interface IDisplayControlRenderer

getBody

public java.lang.String getBody(IDisplayFormRenderer parent,
                                java.lang.String displayForm,
                                RaritanPageContext pageContext)

Specified by:

getBody in interface IDisplayControlRenderer

doGetBody

protected java.lang.String doGetBody(IDisplayFormRenderer parent,
                                     java.lang.String displayForm,
                                     RaritanPageContext pageContext)

getRendererState

protected boolean getRendererState(IDisplayFormRenderer parent,
                                   java.lang.String fieldName,
                                   RaritanPageContext pageContext)

getEnabledRenderers

protected java.lang.String getEnabledRenderers(RaritanPageContext pageContext)

getDisabledRenderers

protected java.lang.String getDisabledRenderers(RaritanPageContext pageContext)

enableAllRenderers

protected void enableAllRenderers(RaritanPageContext pageContext)

setShowLabel

public void setShowLabel(java.lang.String showLabel)

getShowLabel

public java.lang.String getShowLabel()

setHideLabel

public void setHideLabel(java.lang.String hideLabel)

getHideLabel

public java.lang.String getHideLabel()

setLabel

public void setLabel(java.lang.String label)

getLabel

public java.lang.String getLabel()

setCssClass

public void setCssClass(java.lang.String clazz)

getCssClass

public java.lang.String getCssClass()

setFieldNames

public void setFieldNames(java.lang.String[] fieldNames)

getFieldNames

public java.lang.String[] getFieldNames()

setFieldLabels

public void setFieldLabels(java.lang.String[] fieldLabels)

getFieldLabels

public java.lang.String[] getFieldLabels()

getConfigurationXML

public java.lang.String getConfigurationXML()