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

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

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

JSP tag for the CommandControl.

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

CommandTag()
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	setAction(javax.el.MethodExpression action) Sets the Method Binding to be invoked for this object.
void	setActionListener(javax.el.MethodExpression actionListener) Sets the action listener method to be invoked for this object.
void	setClientPostBack(javax.el.ValueExpression clientPostBack) Sets the client side post back for this control.
void	setDefaultImage(javax.el.ValueExpression defaultImage) Sets the default image for this control.
void	setDisabled(javax.el.ValueExpression disabled) Sets an indicator whether to disable the control.
void	setDisabledImage(javax.el.ValueExpression disabledImage) Sets the disabled image for this control.
void	setHoverImage(javax.el.ValueExpression hoverImage) Sets the hover image for this control.
void	setOnclick(javax.el.ValueExpression onclick) Sets the Javascript code to be executed when this control is clicked.
protected void	setProperties(javax.faces.component.UIComponent component) Sets the attributes of the CommandControl from the tag attributes.
void	setSelectedImage(javax.el.ValueExpression selectedImage) Sets the selected image for this control.
void	setShowLoadingImage(javax.el.ValueExpression showLoadingImage) Sets whether the loading image is shown for this control.
void	setStyle(javax.el.ValueExpression style) Sets the default style for the Command control.
void	setStyleClass(javax.el.ValueExpression styleClass) Sets the CSS class name where the CSS style attributes are defined.
void	setToolText(javax.el.ValueExpression toolText) Sets the text to be displayed for this control.
void	setToolTip(javax.el.ValueExpression toolTip) Sets the alternate text for this control.

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

CommandTag

public CommandTag()

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 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 CommandControl from the tag attributes.

Overrides:

setProperties in class javax.faces.webapp.UIComponentELTag

Parameters:

component - the component to override properties

setAction

public void setAction(javax.el.MethodExpression action)

Sets the Method Binding to be invoked for this object.

Parameters:

action - the method binding value

setActionListener

public void setActionListener(javax.el.MethodExpression actionListener)

Sets the action listener method to be invoked for this object.

Parameters:

actionListener - the method binding expression value

setOnclick

public void setOnclick(javax.el.ValueExpression onclick)

Sets the Javascript code to be executed when this control is clicked.

Parameters:

onclick - the Javascript code to execute

setStyle

public void setStyle(javax.el.ValueExpression style)

Sets the default style for the Command control.

Parameters:

style - the default style for the Command control

setStyleClass

public void setStyleClass(javax.el.ValueExpression styleClass)

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

Parameters:

styleClass - the CSS class

setToolTip

public void setToolTip(javax.el.ValueExpression toolTip)

Sets the alternate text for this control.

Parameters:

toolTip - the alternate text for this control

setToolText

public void setToolText(javax.el.ValueExpression toolText)

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

Parameters:

toolText - the text for this control

setDefaultImage

public void setDefaultImage(javax.el.ValueExpression defaultImage)

Sets the default image for this control.

Parameters:

defaultImage - the default image for this control

setHoverImage

public void setHoverImage(javax.el.ValueExpression hoverImage)

Sets the hover image for this control.

Parameters:

hoverImage - the hover image for this control

setSelectedImage

public void setSelectedImage(javax.el.ValueExpression selectedImage)

Sets the selected image for this control.

Parameters:

selectedImage - the selected image for this control

setDisabledImage

public void setDisabledImage(javax.el.ValueExpression disabledImage)

Sets the disabled image for this control.

Parameters:

disabledImage - the disabled image for this control

setDisabled

public void setDisabled(javax.el.ValueExpression disabled)

Sets an indicator whether to disable the control.

Parameters:

disabled - if true, disable the control

setShowLoadingImage

public void setShowLoadingImage(javax.el.ValueExpression showLoadingImage)

Sets whether the loading image is shown for this control.

Parameters:

showLoadingImage - if true, the loading image is shown

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