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

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

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 ToolbarTag
extends javax.faces.webapp.UIComponentELTag

JSP tag for the ToolbarControl.

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

ToolbarTag()
Initializes the tag.

Method Summary

String	getComponentType() Returns the component type string.
String	getRendererType() Returns the renderer type of this control.
void	release() Resets the attribute values to defaults.
void	setActiveTool(javax.el.ValueExpression activeTool) Sets the active tool for the map.
void	setDefaultStyle(javax.el.ValueExpression defaultStyle) Sets the default style for tool bar item control.
void	setDisabledStyle(javax.el.ValueExpression disabledStyle) Sets the disabled style for the tool bar item control.
void	setHoverStyle(javax.el.ValueExpression hoverStyle) Sets the hover style for tool bar item control.
void	setMapId(javax.el.ValueExpression mapId) Sets the map control id associated with the control.
void	setOrientation(javax.el.ValueExpression orientation) Sets the orientation for this control.
protected void	setProperties(javax.faces.component.UIComponent component) Sets the attributes of the ToolbarControl from the tag attributes.
void	setSelectedStyle(javax.el.ValueExpression selectedStyle) Sets the selected style for the tool bar item control.
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	setTextPosition(javax.el.ValueExpression textPosition) Sets the text position for this control.
void	setToolbarStyle(javax.el.ValueExpression toolbarStyle) Sets the toolbar style for this control.
void	setXslFile(javax.el.ValueExpression xslFile) Sets the XSL file which renders the ToolbarControl.

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

ToolbarTag

public ToolbarTag()

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 of this control.

Specified by:

getRendererType in class javax.faces.webapp.UIComponentTagBase

Returns:

String- null since parent Toolbar control is responsible for rendering this child control

setProperties

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

Sets the attributes of the ToolbarControl from the tag attributes.

Overrides:

setProperties in class javax.faces.webapp.UIComponentELTag

Parameters:

component - the component to override properties

setMapId

public void setMapId(javax.el.ValueExpression mapId)

Sets the map control id associated with the control.

Parameters:

mapId - the map control id.

setActiveTool

public void setActiveTool(javax.el.ValueExpression activeTool)

Sets the active tool for the map. The tool key is defined in the XML tool collection file.

Parameters:

activeTool - the active tool

setXslFile

public void setXslFile(javax.el.ValueExpression xslFile)

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

Parameters:

xslFile - the XSL file name

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

setOrientation

public void setOrientation(javax.el.ValueExpression orientation)

Sets the orientation for this control.

Parameters:

orientation - the orientation of the control

setDefaultStyle

public void setDefaultStyle(javax.el.ValueExpression defaultStyle)

Sets the default style for tool bar item control.

Parameters:

defaultStyle - the default style value

setHoverStyle

public void setHoverStyle(javax.el.ValueExpression hoverStyle)

Sets the hover style for tool bar item control.

Parameters:

hoverStyle - the hover style value

setDisabledStyle

public void setDisabledStyle(javax.el.ValueExpression disabledStyle)

Sets the disabled style for the tool bar item control.

Parameters:

disabledStyle - the disabled style value

setSelectedStyle

public void setSelectedStyle(javax.el.ValueExpression selectedStyle)

Sets the selected style for the tool bar item control.

Parameters:

selectedStyle - the selected style value

setToolbarStyle

public void setToolbarStyle(javax.el.ValueExpression toolbarStyle)

Sets the toolbar style for this control. For example: IMAGEANDTEXT, IMAGEONLY, or TEXTONLY.

Parameters:

toolbarStyle - the toolbar style

setTextPosition

public void setTextPosition(javax.el.ValueExpression textPosition)

Sets the text position for this control. For example: LEFT, TOP, BOTTOM, or RIGHT.

Parameters:

textPosition - the text position