com.raritantechnologies.verity.parametric.taglibrary
Class GetExploreTreeTaxonomyViewRefresh

java.lang.Object
  BodyTagSupport
      com.raritantechnologies.verity.parametric.taglibrary.GetExploreTreeTaxonomyViewRefresh

All Implemented Interfaces:

IConfigurable, ICustomTag, ISearchElementRenderer

public class GetExploreTreeTaxonomyViewRefresh

extends BodyTagSupport

implements ICustomTag, ISearchElementRenderer

Custom JSP tag that wraps a Raritan Technologies Tree taxonomy renderer.

Developed by Raritan Technologies . XML Configuration Template:

   <SearchElementRenderer class="com.raritantechnologies.verity.parametric.taglibrary.GetExploreTreeTaxonomyViewRefresh" 
                             fieldname="[ name of taxonomy field ]"
                             titleclass="[ CSS class of title element ]"
                             headerclass="[ CSS class of header element ]"
                             bodyclass="[ CSS class of body ]"
                             title="[ title of taxonomy (root node label) ]"
                             renderRoot="[ true(default)|false ]"
                             expandCurrentNode="[ true|false(default) ]"
                             expandLevel="[ number of levels to expand ]"
                             action="[ href action url base ]"
                             window="[ href window ]"
                             prefix="[ node name prefix ]" >

      <!-- Optional extra parameters to add to node links -->
      <RequestParams>
        <!-- One or more Param tags: -->
        <Param ID="[ name of parameter ]" value="[ value of parameter ]" />
        <!-- etc... -->
      </RequestParams>

      <!-- Display String filter for modifications to node display -->
      <NodeNameFilter class="[ class of IStringFilter ]" >

      </NodeNameFilter>

   </SearchElementRenderer>
 

Author:

Chris Peterson

See Also:

Serialized Form

Constructor Summary

GetExploreTreeTaxonomyViewRefresh()

Method Summary

int	doAfterBody()
int	doStartTag()
java.lang.String	getBody(ISearchFormRenderer parent, RaritanPageContext pageContext) Returns the element html fragment.
java.lang.String	getBody(RaritanPageContext rpc) Returns the tag body.
ISearchElementRenderer	getRenderer(java.lang.String name) Returns ISearchElementRenderer of this render or a nested renderer matching the name given or null if no match is found.
void	initialize(org.w3c.dom.Element elem) Initialize renderer-specific parameters from the configuration XML tag.
void	initialize(java.util.Map initParams)
boolean	isHidden(ISearchFormRenderer parent, RaritanPageContext pageContext)
void	setAction(java.lang.String action)
void	setBodyclass(java.lang.String bodyclass)
void	setEnable(boolean enabled) Enable/Disable the renderer.
void	setExpandCurrentNode(java.lang.String expandCurrentNode)
void	setExpandLevel(java.lang.String expandLevel)
void	setFieldname(java.lang.String fieldname)
void	setHeaderclass(java.lang.String headerclass)
void	setPrefix(java.lang.String prefix)
void	setRenderRoot(java.lang.String renderRoot)
void	setTitle(java.lang.String title)
void	setTitleclass(java.lang.String titleclass)
void	setWindow(java.lang.String window)

Methods inherited from class java.lang.Object

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

Constructor Detail

GetExploreTreeTaxonomyViewRefresh

public GetExploreTreeTaxonomyViewRefresh()

Method Detail

setAction

public void setAction(java.lang.String action)

setExpandCurrentNode

public void setExpandCurrentNode(java.lang.String expandCurrentNode)

setWindow

public void setWindow(java.lang.String window)

setFieldname

public void setFieldname(java.lang.String fieldname)

setTitleclass

public void setTitleclass(java.lang.String titleclass)

setHeaderclass

public void setHeaderclass(java.lang.String headerclass)

setBodyclass

public void setBodyclass(java.lang.String bodyclass)

setTitle

public void setTitle(java.lang.String title)

setRenderRoot

public void setRenderRoot(java.lang.String renderRoot)

setExpandLevel

public void setExpandLevel(java.lang.String expandLevel)

setPrefix

public void setPrefix(java.lang.String prefix)

doStartTag

public int doStartTag()
               throws JspException

Throws:

JspException

getBody

public java.lang.String getBody(RaritanPageContext rpc)

Description copied from interface: ICustomTag

Returns the tag body.

Specified by:

getBody in interface ICustomTag

Parameters:

rpc - Platform-neutral page context ( can be used in non J2EE environments such as ASP).

Returns:

The tag body text string.

doAfterBody

public int doAfterBody()
                throws JspException

Throws:

JspException

initialize

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

Description copied from interface: ISearchElementRenderer

Initialize renderer-specific parameters from the configuration XML tag.

Specified by:

initialize in interface IConfigurable

initialize

public void initialize(java.util.Map initParams)

Specified by:

initialize in interface ICustomTag

getBody

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

Description copied from interface: ISearchElementRenderer

Returns the element html fragment.

Specified by:

getBody in interface ISearchElementRenderer

setEnable

public void setEnable(boolean enabled)

Description copied from interface: ISearchElementRenderer

Enable/Disable the renderer. Disabled renderers are not included in the html output of an ISearchFormRenderer.

Specified by:

setEnable in interface ISearchElementRenderer

getRenderer

public ISearchElementRenderer getRenderer(java.lang.String name)

Description copied from interface: ISearchElementRenderer

Returns ISearchElementRenderer of this render or a nested renderer matching the name given or null if no match is found.

Specified by:

getRenderer in interface ISearchElementRenderer

isHidden

public boolean isHidden(ISearchFormRenderer parent,
                        RaritanPageContext pageContext)

Specified by:

isHidden in interface ISearchElementRenderer