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

java.lang.Object
  javax.faces.webapp.UIComponentTagBase
      javax.faces.webapp.UIComponentClassicTagBase
          javax.faces.webapp.UIComponentELTag
              com.esri.adf.web.faces.taglib.TocTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class TocTag
extends javax.faces.webapp.UIComponentELTag

JSP tag for the TocControl.

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase

bodyContent, pageContext, UNIQUE_ID_PREFIX

Fields inherited from class javax.faces.webapp.UIComponentTagBase

log

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

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

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

EVAL_BODY_AGAIN

Constructor Summary

TocTag()
Initializes the tag.

Method Summary

String	getComponentType() Returns the component type string.
String	getRendererType() Returns the renderer type.
void	release() Resets the attribute values to defaults.
void	setAutoPostBack(javax.el.ValueExpression autoPostBack) Sets whether to automatically post back on every check/uncheck.
void	setClientPostBack(javax.el.ValueExpression clientPostBack) Sets the client side post back for this control.
void	setCollapsedImage(javax.el.ValueExpression collapsedImage) Sets the collapsed image to show in this control.
void	setExpandedImage(javax.el.ValueExpression expandedImage) Sets the expanded image to show in this control.
void	setIndentWidth(javax.el.ValueExpression indentWidth) Sets the indentation level of the TOC nodes.
void	setMapId(javax.el.ValueExpression 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(javax.el.ValueExpression resourceImage) Sets the image for the resource.
void	setShowExpanded(javax.el.ValueExpression showExpanded) Sets the visibility of the collapse/expand images on the TOC.
void	setStyle(javax.el.ValueExpression style) Sets the style for this control.
void	setStyleClass(javax.el.ValueExpression styleClass) Sets the CSS class for this control.
void	setTextStyle(javax.el.ValueExpression textStyle) Sets the CSS for the TOC text.
void	setTextStyleClass(javax.el.ValueExpression textStyleClass) Sets the CSS style class for the TOC text.
void	setValue(javax.el.ValueExpression value) Sets the value binding expression for the TOC.
void	setXslFile(javax.el.ValueExpression xslFileName) Sets the XSL file which renders the TocControl.

Methods inherited from class javax.faces.webapp.UIComponentELTag

createComponent, getELContext, hasBinding, setBinding, setRendered

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase

addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter

Methods inherited from class java.lang.Object

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

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

doEndTag, doStartTag, getParent, setPageContext, setParent

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.UIComponentELTag

getComponentType

public String getComponentType()

Returns the component type string.

Specified by:

getComponentType in class javax.faces.webapp.UIComponentTagBase

Returns:

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

getRendererType

public String getRendererType()

Returns the renderer type.

Specified by:

getRendererType in class javax.faces.webapp.UIComponentTagBase

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.UIComponentELTag

Parameters:

component - the component to override properties

setValue

public void setValue(javax.el.ValueExpression 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(javax.el.ValueExpression mapId)

Sets the map control id associated with the control.

Parameters:

mapId - the map control id.

setXslFile

public void setXslFile(javax.el.ValueExpression 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(javax.el.ValueExpression 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(javax.el.ValueExpression 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(javax.el.ValueExpression style)

Sets the style for this control.

Parameters:

style - the style value

setStyleClass

public void setStyleClass(javax.el.ValueExpression styleClass)

Sets the CSS class for this control.

Parameters:

styleClass - the CSS class name

setTextStyle

public void setTextStyle(javax.el.ValueExpression textStyle)

Sets the CSS for the TOC text.

Parameters:

textStyle - the TOC text CSS style

setTextStyleClass

public void setTextStyleClass(javax.el.ValueExpression textStyleClass)

Sets the CSS style class for the TOC text.

Parameters:

textStyleClass - the TOC text CSS style class name

setIndentWidth

public void setIndentWidth(javax.el.ValueExpression indentWidth)

Sets the indentation level of the TOC nodes.

Parameters:

indentWidth - the number of pixels to indent nodes

setExpandedImage

public void setExpandedImage(javax.el.ValueExpression expandedImage)

Sets the expanded image to show in this control.

Parameters:

expandedImage - a URL string to the image

setCollapsedImage

public void setCollapsedImage(javax.el.ValueExpression collapsedImage)

Sets the collapsed image to show in this control.

Parameters:

collapsedImage - a URL string to the image

setResourceImage

public void setResourceImage(javax.el.ValueExpression resourceImage)

Sets the image for the resource.

Parameters:

resourceImage - a URL string to the resource image

setShowExpanded

public void setShowExpanded(javax.el.ValueExpression showExpanded)

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

Parameters:

showExpanded - if true, show the collapse/expand images