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

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

All Implemented Interfaces:

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

public class ToolbarTag
extends javax.faces.webapp.UIComponentTag

JSP tag for the ToolbarControl.

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

ToolbarTag()
Initializes the tag.

Method Summary

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

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

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

Specified by:

getRendererType in class javax.faces.webapp.UIComponentTag

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

Parameters:

component - the component to override properties

setMapId

public void setMapId(java.lang.String mapId)

Sets the map control id associated with the control.

Parameters:

mapId - the map control id.

setActiveTool

public void setActiveTool(java.lang.String 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(java.lang.String 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(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

setOrientation

public void setOrientation(java.lang.String orientation)

Sets the orientation for this control.

Parameters:

orientation - the orientation of the control

setDefaultStyle

public void setDefaultStyle(java.lang.String defaultStyle)

Sets the default style for tool bar item control.

Parameters:

defaultStyle - the default style value

setHoverStyle

public void setHoverStyle(java.lang.String hoverStyle)

Sets the hover style for tool bar item control.

Parameters:

hoverStyle - the hover style value

setDisabledStyle

public void setDisabledStyle(java.lang.String disabledStyle)

Sets the disabled style for the tool bar item control.

Parameters:

disabledStyle - the disabled style value

setSelectedStyle

public void setSelectedStyle(java.lang.String selectedStyle)

Sets the selected style for the tool bar item control.

Parameters:

selectedStyle - the selected style value

setToolbarStyle

public void setToolbarStyle(java.lang.String toolbarStyle)

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

Parameters:

toolbarStyle - the toolbar style

setTextPosition

public void setTextPosition(java.lang.String textPosition)

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

Parameters:

textPosition - the text position