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

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

All Implemented Interfaces:

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

public class ToolTag
extends javax.faces.webapp.UIComponentTag

JSP tag for the ToolControl.

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

ToolTag()
Initializes the tag.

Method Summary

int	doEndTag()
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	setClientAction(java.lang.String clientAction) Sets the client action method for the tool control.
void	setClientPostBack(java.lang.String clientPostBack) Sets the client side post back for this control.
void	setCursor(java.lang.String cursor) Sets the cursor for this control.
void	setDefaultImage(java.lang.String defaultImage) Sets the default image for this control.
void	setDisabled(java.lang.String disabled) Sets an indicator whether to disable the control.
void	setDisabledImage(java.lang.String disabledImage) Sets the disabled image for this control.
void	setHoverImage(java.lang.String hoverImage) Sets the hover image for this control.
void	setLineColor(java.lang.String lineColor) Sets the line color for this control.
void	setLineWidth(java.lang.String lineWidth) Sets the line width for this control.
protected void	setProperties(javax.faces.component.UIComponent component) Sets the attributes of the ToolControl from the tag attributes.
void	setSelectedImage(java.lang.String selectedImage) Sets the selected image for this control.
void	setServerAction(java.lang.String serverAction) Sets the server action name.
void	setServerMethod(java.lang.String serverMethod) Sets the server action method binding name.
void	setShowLoadingImage(java.lang.String showLoadingImage) Sets whether the loading image is shown for this control.
void	setStyle(java.lang.String style) Sets the default style for the tool control.
void	setStyleClass(java.lang.String styleClass) Sets the CSS class name where the CSS style attributes are defined.
void	setToolText(java.lang.String toolText) Sets the text to be displayed for this control.
void	setToolTip(java.lang.String toolTip) Sets the alternate text for this control.

Methods inherited from class javax.faces.webapp.UIComponentTag

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

ToolTag

public ToolTag()

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 the parent Toolbar control is responsible for rendering this child control

setProperties

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

Sets the attributes of the ToolControl from the tag attributes.

Overrides:

setProperties in class javax.faces.webapp.UIComponentTag

Parameters:

component - the component to override properties

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Specified by:

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

Overrides:

doEndTag in class javax.faces.webapp.UIComponentTag

Throws:

javax.servlet.jsp.JspException

setClientAction

public void setClientAction(java.lang.String clientAction)

Sets the client action method for the tool control.

Parameters:

clientAction - the client action method, for example, MapDragRectangle

setServerAction

public void setServerAction(java.lang.String serverAction)

Sets the server action name.

Parameters:

serverAction - the server action name, for example, com.esri.adf.web.faces.event.ZoomInToolAction

setServerMethod

public void setServerMethod(java.lang.String serverMethod)

Sets the server action method binding name.

Parameters:

serverMethod - the server action method binding name, for example, #{tool.zoomIn}

setStyle

public void setStyle(java.lang.String style)

Sets the default style for the tool control.

Parameters:

style - the default style for the tool control

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS class name where the CSS style attributes are defined.

Parameters:

styleClass - the CSS class

setToolTip

public void setToolTip(java.lang.String toolTip)

Sets the alternate text for this control.

Parameters:

toolTip - the alternate text for this control

setToolText

public void setToolText(java.lang.String toolText)

Sets the text to be displayed for this control. The text is displayed when the toolbar style is either IMAGEANDTEXT or TEXTONLY.

Parameters:

toolText - the text for this control

setDefaultImage

public void setDefaultImage(java.lang.String defaultImage)

Sets the default image for this control.

Parameters:

defaultImage - the default image for this control

setHoverImage

public void setHoverImage(java.lang.String hoverImage)

Sets the hover image for this control.

Parameters:

hoverImage - the hover image for this control

setSelectedImage

public void setSelectedImage(java.lang.String selectedImage)

Sets the selected image for this control.

Parameters:

selectedImage - the selected image for this control

setDisabledImage

public void setDisabledImage(java.lang.String disabledImage)

Sets the disabled image for this control.

Parameters:

disabledImage - the disabled image for this control

setDisabled

public void setDisabled(java.lang.String disabled)

Sets an indicator whether to disable the control.

Parameters:

disabled - if true, disable the control

setCursor

public void setCursor(java.lang.String cursor)

Sets the cursor for this control.

Parameters:

cursor - the cursor for this control

setShowLoadingImage

public void setShowLoadingImage(java.lang.String showLoadingImage)

Sets whether the loading image is shown for this control.

Parameters:

showLoadingImage - if true, the loading image is shown

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

setLineColor

public void setLineColor(java.lang.String lineColor)

Sets the line color for this control.

Parameters:

lineColor - an HTML color string

setLineWidth

public void setLineWidth(java.lang.String lineWidth)

Sets the line width for this control.

Parameters:

lineWidth - the width in pixels