com.raritantechnologies.searchApp.sourceMap.taglibrary
Interface ISourceMapTreeRenderer

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

BasicSourceMapTreeRenderer

public interface ISourceMapTreeRenderer

extends IConfigurable

Interface for a configurable SourceMap Tree HTML renderer.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Method Summary

void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
java.lang.String	renderSourceMap(ISourceMapTreeNode sourceMapTree, RaritanPageContext pageContext) Renders a SourceMapTree Including any parameter lists and a search form
void	setActiveSourceMapNode(ISourceMapTreeNode activeNode)
void	setDisplayFormName(java.lang.String displayFormName)
void	setFormTableProps(java.lang.String formTableProps)
void	setPageSize(java.lang.String pageSize)
void	setSearchFormName(java.lang.String searchFormName) Search form name to use for search form submits.
void	setSearchFormURL(java.lang.String searchFormURL) URL to use for search form submits.
void	setSourceMapName(java.lang.String sourceMapName)
void	setSourceMapTreeName(java.lang.String sourceMapTreeName)
void	setSourceMapURL(java.lang.String sourceMapURL) URL to use for source tree hyperlinks...
void	setTableProps(java.lang.String tableProps)
void	setTreeBorderColor(java.lang.String treeBorderColor)
void	setTreeState(ISourceMapTreeNode smTree, RaritanPageContext pageContext)

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 IConfigurable

setSourceMapURL

public void setSourceMapURL(java.lang.String sourceMapURL)

URL to use for source tree hyperlinks...

setSearchFormName

public void setSearchFormName(java.lang.String searchFormName)

Search form name to use for search form submits.

setSearchFormURL

public void setSearchFormURL(java.lang.String searchFormURL)

URL to use for search form submits.

renderSourceMap

public java.lang.String renderSourceMap(ISourceMapTreeNode sourceMapTree,
                                        RaritanPageContext pageContext)

Renders a SourceMapTree Including any parameter lists and a search form

setActiveSourceMapNode

public void setActiveSourceMapNode(ISourceMapTreeNode activeNode)

setTreeState

public void setTreeState(ISourceMapTreeNode smTree,
                         RaritanPageContext pageContext)

setDisplayFormName

public void setDisplayFormName(java.lang.String displayFormName)

setSourceMapName

public void setSourceMapName(java.lang.String sourceMapName)

setSourceMapTreeName

public void setSourceMapTreeName(java.lang.String sourceMapTreeName)

setPageSize

public void setPageSize(java.lang.String pageSize)

setTableProps

public void setTableProps(java.lang.String tableProps)

setFormTableProps

public void setFormTableProps(java.lang.String formTableProps)

setTreeBorderColor

public void setTreeBorderColor(java.lang.String treeBorderColor)