com.esri.adf.web.faces.component
Class ToolControl

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.esri.adf.web.faces.component.ToolControl

All Implemented Interfaces:

ToolbarItem, javax.faces.component.StateHolder

public class ToolControl
extends javax.faces.component.UIComponentBase
implements ToolbarItem

The Tool Control executes the client action followed by the server side action.

Field Summary

static java.lang.String	COMPONENT_FAMILY The standard component family for this component.
static java.lang.String	COMPONENT_TYPE The standard component type for this component.
static java.lang.String	CONTROLID_DELIMITER The delimiter for the control ID.

Constructor Summary

ToolControl()
Initializes the Tool Control and sets the renderer type to null.

Method Summary

org.w3c.dom.Element	generateXML() Generates an XML representation of the control.
java.lang.String	getClientAction() Returns the client action method associated with this tool.
java.lang.String	getCursor() Returns the cursor that is used for this control.
java.lang.String	getDefaultImage() Returns the default image that is set for this control.
java.lang.String	getDisabledImage() Returns the disabled image that is set for this control.
java.lang.String	getFamily() Returns the family of this control.
java.lang.String	getHoverImage() Returns the hover image that is set for this control.
java.lang.String	getLineColor() Returns the color of the line.
int	getLineWidth() Returns the width of the line.
java.lang.String	getSelectedImage() Returns the selected image that is set for this control.
java.lang.String	getServerAction() Returns the server side tool action name.
java.lang.String	getServerMethod() Returns the expression string for server side tool action method binding.
java.lang.String	getStyle() Returns the style attributes of the tool control.
java.lang.String	getStyleClass() Returns the file name where the CSS style attributes are defined.
java.lang.String	getToolText() Returns the tool text that is set for this control.
java.lang.String	getToolTip() Returns the tool tip that is set for this control.
boolean	isClientPostBack() Indicates whether the control supports client side post back.
boolean	isDisabled() Indicates whether this control is disabled.
boolean	isInit() Indicates whether this control is initialized.
boolean	isShowLoadingImage() Indicates whether the control shows a loading image when the page is submited.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state) Restores the state of the control.
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext) Saves the state of this control.
void	setClientAction(java.lang.String clientAction) Sets the client action method for the tool.
void	setClientPostBack(boolean clientPostBack) Sets whether the control supports client side post back.
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(boolean 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	setInit(boolean init) Sets an indicator whether to initialize the control.
void	setLineColor(java.lang.String lineColor) Sets the line color for this control.
void	setLineWidth(int lineWidth) Sets the line width for this control.
void	setSelectedImage(java.lang.String selectedImage) Sets the selected image for this control.
void	setServerAction(java.lang.String serverAction) Sets the server side tool action name.
void	setServerMethod(java.lang.String serverMethod) Sets the expression string for the server side tool action method binding.
void	setShowLoadingImage(boolean 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.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

CONTROLID_DELIMITER

public static final java.lang.String CONTROLID_DELIMITER

The delimiter for the control ID.

See Also:

Constant Field Values

Constructor Detail

ToolControl

public ToolControl()

Initializes the Tool Control and sets the renderer type to null. The renderer type is set to null since the parent Toolbar Control is responsible for rendering this control.

Method Detail

getFamily

public java.lang.String getFamily()

Returns the family of this control.

Specified by:

getFamily in class javax.faces.component.UIComponent

Returns:

String- the COMPONENT_FAMILY

isInit

public boolean isInit()

Indicates whether this control is initialized.

Returns:

boolean- if true, the control is initialized

setInit

public void setInit(boolean init)

Sets an indicator whether to initialize the control.

Parameters:

init - if true, initialize the control

getClientAction

public java.lang.String getClientAction()

Returns the client action method associated with this tool.

Returns:

String- the client action method name.

setClientAction

public void setClientAction(java.lang.String clientAction)

Sets the client action method for the tool. For example: MapDragRectangle, MapDragImage, etc.

Parameters:

clientAction - the client action method to be used for this tool.

getServerAction

public java.lang.String getServerAction()

Returns the server side tool action name.

Returns:

String- the server side tool action name

setServerAction

public void setServerAction(java.lang.String serverAction)

Sets the server side tool action name.

Parameters:

serverAction - the server side tool action name

getServerMethod

public java.lang.String getServerMethod()

Returns the expression string for server side tool action method binding.

Returns:

String- the expression string for the server side tool action method binding

setServerMethod

public void setServerMethod(java.lang.String serverMethod)

Sets the expression string for the server side tool action method binding.

Parameters:

serverMethod - the expression string for the server side tool action method binding

getStyle

public java.lang.String getStyle()

Returns the style attributes of the tool control.

Returns:

String- the style attributes

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

getStyleClass

public java.lang.String getStyleClass()

Returns the file name where the CSS style attributes are defined.

Returns:

String- the CSS class

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

getToolTip

public java.lang.String getToolTip()

Returns the tool tip that is set for this control.

Returns:

String- the tool tip

setToolTip

public void setToolTip(java.lang.String toolTip)

Sets the alternate text for this control.

Parameters:

toolTip - the alternate text for this control

getToolText

public java.lang.String getToolText()

Returns the tool text that is set for this control.

Returns:

String- the tool text

setToolText

public void setToolText(java.lang.String toolText)

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

Parameters:

toolText - the text for this control

getDefaultImage

public java.lang.String getDefaultImage()

Returns the default image that is set for this control.

Returns:

String- the default image

setDefaultImage

public void setDefaultImage(java.lang.String defaultImage)

Sets the default image for this control.

Parameters:

defaultImage - the default image for this control

getHoverImage

public java.lang.String getHoverImage()

Returns the hover image that is set for this control.

Returns:

String- the hover image

setHoverImage

public void setHoverImage(java.lang.String hoverImage)

Sets the hover image for this control.

Parameters:

hoverImage - the hover image for this control

getSelectedImage

public java.lang.String getSelectedImage()

Returns the selected image that is set for this control.

Returns:

String- the selected image

setSelectedImage

public void setSelectedImage(java.lang.String selectedImage)

Sets the selected image for this control.

Parameters:

selectedImage - the selected image for this control

getDisabledImage

public java.lang.String getDisabledImage()

Returns the disabled image that is set for this control.

Returns:

String- the disabled image

setDisabledImage

public void setDisabledImage(java.lang.String disabledImage)

Sets the disabled image for this control.

Parameters:

disabledImage - the disabled image for this control

getCursor

public java.lang.String getCursor()

Returns the cursor that is used for this control.

Returns:

String- the cursor name

setCursor

public void setCursor(java.lang.String cursor)

Sets the cursor for this control. For example: crosshair, pointer, etc.

Parameters:

cursor - the cursor for this control

isDisabled

public boolean isDisabled()

Indicates whether this control is disabled.

Returns:

boolean- if true, the control is disabled

setDisabled

public void setDisabled(boolean disabled)

Sets an indicator whether to disable the control.

Parameters:

disabled - if true, disable the control

isShowLoadingImage

public boolean isShowLoadingImage()

Indicates whether the control shows a loading image when the page is submited.

Returns:

boolean- if true, the loading image is shown

setShowLoadingImage

public void setShowLoadingImage(boolean showLoadingImage)

Sets whether the loading image is shown for this control.

Parameters:

showLoadingImage - if true, the loading image is shown

isClientPostBack

public boolean isClientPostBack()

Indicates whether the control supports client side post back.

Returns:

boolean- if true, the client side post back is supported

setClientPostBack

public void setClientPostBack(boolean clientPostBack)

Sets whether the control supports client side post back.

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

getLineColor

public java.lang.String getLineColor()

Returns the color of the line.

Returns:

String- the line color

setLineWidth

public void setLineWidth(int lineWidth)

Sets the line width for this control.

Parameters:

lineWidth - the line width in pixels

getLineWidth

public int getLineWidth()

Returns the width of the line.

Returns:

int- the line width

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Saves the state of this control.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

Parameters:

facesContext - the associated FacesContext

Returns:

Object- the object to be saved

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Restores the state of the control.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase

Parameters:

facesContext - the associated FacesContext

state - the object from which to restore the state of the control

generateXML

public org.w3c.dom.Element generateXML()

Generates an XML representation of the control.

Specified by:

generateXML in interface ToolbarItem

Returns:

Element- the XML element of the control