com.esri.adf.web.faces.taglib
Class TocTag

java.lang.Object
  javax.faces.webapp.UIComponentTag
      com.esri.adf.web.faces.taglib.TocTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class TocTag
extends javax.faces.webapp.UIComponentTag

JSP tag for the TocControl.

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentTag

pageContext

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

TocTag()
Initializes the tag.

Method Summary

java.lang.String	getComponentType() Returns the component type string.
java.lang.String	getRendererType() Returns the renderer type.
void	release() Resets the attribute values to defaults.
void	setAutoPostBack(java.lang.String autoPostBack) Sets whether to automatically post back on every check/uncheck.
void	setClientPostBack(java.lang.String clientPostBack) Sets the client side post back for this control.
void	setCollapsedImage(java.lang.String collapsedImage) Sets the collapsed image to show in this control.
void	setExpandedImage(java.lang.String expandedImage) Sets the expanded image to show in this control.
void	setIndentWidth(java.lang.String indentWidth) Sets the indentation level of the TOC nodes.
void	setMapId(java.lang.String mapId) Sets the map control id associated with the control.
protected void	setProperties(javax.faces.component.UIComponent component) Sets the attributes of the TocControl from the tag attributes.
void	setResourceImage(java.lang.String resourceImage) Sets the image for the resource.
void	setShowExpanded(java.lang.String showExpanded) Sets the visibility of the collapse/expand images on the TOC.
void	setStyle(java.lang.String style) Sets the style for this control.
void	setStyleClass(java.lang.String styleClass) Sets the CSS class for this control.
void	setTextStyle(java.lang.String textStyle) Sets the CSS for the TOC text.
void	setTextStyleClass(java.lang.String textStyleClass) Sets the CSS style class for the TOC text.
void	setValue(java.lang.String value) Sets the value binding expression for the TOC.
void	setXslFile(java.lang.String xslFileName) Sets the XSL file which renders the TocControl.

Methods inherited from class javax.faces.webapp.UIComponentTag

doEndTag, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getDoStartValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

TocTag

public TocTag()

Initializes the tag.

Method Detail

release

public void release()

Resets the attribute values to defaults.

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.faces.webapp.UIComponentTag

getComponentType

public java.lang.String getComponentType()

Returns the component type string.

Specified by:

getComponentType in class javax.faces.webapp.UIComponentTag

Returns:

String- the component-type as defined in the faces-config.xml file

getRendererType

public java.lang.String getRendererType()

Returns the renderer type.

Specified by:

getRendererType in class javax.faces.webapp.UIComponentTag

Returns:

String- the renderer-type as defined in the faces-config.xml file

setProperties

protected void setProperties(javax.faces.component.UIComponent component)

Sets the attributes of the TocControl from the tag attributes.

Overrides:

setProperties in class javax.faces.webapp.UIComponentTag

Parameters:

component - the component to override properties

setValue

public void setValue(java.lang.String value)

Sets the value binding expression for the TOC. The expression must evaluate to a WebToc.

Parameters:

value - the value binding expression for the TOC

setMapId

public void setMapId(java.lang.String mapId)

Sets the map control id associated with the control.

Parameters:

mapId - the map control id.

setXslFile

public void setXslFile(java.lang.String xslFileName)

Sets the XSL file which renders the TocControl. The XSL file needs to be located in the xsl directory of the WebApplication.

Parameters:

xslFileName - the XSL file name

setClientPostBack

public void setClientPostBack(java.lang.String clientPostBack)

Sets the client side post back for this control.

Parameters:

clientPostBack - if true, the client side post back is supported

setAutoPostBack

public void setAutoPostBack(java.lang.String autoPostBack)

Sets whether to automatically post back on every check/uncheck.

Parameters:

autoPostBack - if true, sends the TOC request to the server after each event

setStyle

public void setStyle(java.lang.String style)

Sets the style for this control.

Parameters:

style - the style value

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS class for this control.

Parameters:

styleClass - the CSS class name

setTextStyle

public void setTextStyle(java.lang.String textStyle)

Sets the CSS for the TOC text.

Parameters:

textStyle - the TOC text CSS style

setTextStyleClass

public void setTextStyleClass(java.lang.String textStyleClass)

Sets the CSS style class for the TOC text.

Parameters:

textStyleClass - the TOC text CSS style class name

setIndentWidth

public void setIndentWidth(java.lang.String indentWidth)

Sets the indentation level of the TOC nodes.

Parameters:

indentWidth - the number of pixels to indent nodes

setExpandedImage

public void setExpandedImage(java.lang.String expandedImage)

Sets the expanded image to show in this control.

Parameters:

expandedImage - a URL string to the image

setCollapsedImage

public void setCollapsedImage(java.lang.String collapsedImage)

Sets the collapsed image to show in this control.

Parameters:

collapsedImage - a URL string to the image

setResourceImage

public void setResourceImage(java.lang.String resourceImage)

Sets the image for the resource.

Parameters:

resourceImage - a URL string to the resource image

setShowExpanded

public void setShowExpanded(java.lang.String showExpanded)

Sets the visibility of the collapse/expand images on the TOC.

Parameters:

showExpanded - if true, show the collapse/expand images