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

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

All Implemented Interfaces:

MapToolAction, ToolAction, java.io.Serializable, javax.faces.component.ActionSource, javax.faces.component.StateHolder

public class ButtonControl
extends javax.faces.component.UICommand
implements MapToolAction, java.io.Serializable

A button control executes the server side action and/or action listener method for the control its associated with.

See Also:

Serialized Form

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.

Constructor Summary

ButtonControl()
Instantiates an object of ButtonControl.

Method Summary

void	execute(javax.faces.context.FacesContext context) Executes the server action associated with this button.
void	execute(MapEvent event) Executes the server action associated with this button.
java.lang.String	getClientAction() Gets the client action of the button, should be a javascript method.
java.lang.String	getCollectionId() Gets the collectionId of the ButtonControl.
java.lang.String	getDefaultImage() Returns the default 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	getMapId() Returns the map control id associated with the control.
java.lang.String	getOnclick() Gets the onclick event of the button.
java.lang.String	getSelectedImage() Gets the selected image that is set for this control.
java.lang.String	getServerAction() Gets the server action of the button, should be a backing bean method.
java.lang.String	getStyle() Gets the CSS style of the button.
java.lang.String	getStyleClass() Gets the CSS style class of the ButtonControl.
java.lang.String	getToolTip() Gets the toolTip of the button.
java.lang.String	getType() Gets the type of the button.
java.lang.String	getValue() Gets the text value of the button.
boolean	isDisabled() Returns true if the button is disabled.
void	registerMapToolItem(javax.faces.context.FacesContext facesContext) Registers the button as a MapToolItem.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setClientAction(java.lang.String clientAction) Sets the client action of the button, should be a javascript method.
void	setCollectionId(java.lang.String collectionId) Sets the collectionId of the ButtonControl.
void	setDefaultImage(java.lang.String defaultImage) Sets the default image that is set for this control.
void	setDisabled(boolean disabled) Sets to true if the button is disabled.
void	setHoverImage(java.lang.String hoverImage) Sets the hover image that is set for this control.
void	setMapId(java.lang.String mapId) Sets the map control id associated with the control.
void	setOnclick(java.lang.String onclick) Sets the onclick event of the button.
void	setSelectedImage(java.lang.String selectedImage) Sets the selected image that is set for this control.
void	setServerAction(java.lang.String serverAction) Sets the server action of the button, should be a backing bean method.
void	setStyle(java.lang.String style) Sets the CSS style of the button.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the ButtonControl.
void	setToolTip(java.lang.String toolTip) Sets the toolTip of the button.
void	setType(java.lang.String type) Sets the type of the button.
void	setValue(java.lang.String value) Sets the text value of the button.
void	setValueBinding(java.lang.String name, javax.faces.el.ValueBinding binding) Sets the value binding.

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionListener, getActionListeners, isImmediate, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, 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, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

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

Constructor Detail

ButtonControl

public ButtonControl()

Instantiates an object of ButtonControl.

Method Detail

getFamily

public java.lang.String getFamily()

Returns the family of this control.

Overrides:

getFamily in class javax.faces.component.UICommand

Returns:

String- the COMPONENT_FAMILY

getMapId

public java.lang.String getMapId()

Returns the map control id associated with the control.

Returns:

Returns the mapId.

setMapId

public void setMapId(java.lang.String mapId)

Sets the map control id associated with the control.

Parameters:

mapId - The mapId to set.

getDefaultImage

public java.lang.String getDefaultImage()

Returns the default image that is set for this control.

Returns:

Returns the defaultImage.

setDefaultImage

public void setDefaultImage(java.lang.String defaultImage)

Sets the default image that is set for this control.

Parameters:

defaultImage - The defaultImage to set.

getStyleClass

public java.lang.String getStyleClass()

Gets the CSS style class of the ButtonControl.

Returns:

Returns the styleClass.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the ButtonControl.

Parameters:

styleClass - The styleClass to set.

isDisabled

public boolean isDisabled()

Returns true if the button is disabled.

Returns:

Returns the disabled.

setDisabled

public void setDisabled(boolean disabled)

Sets to true if the button is disabled.

Parameters:

disabled - The disabled to set.

getHoverImage

public java.lang.String getHoverImage()

Returns the hover image that is set for this control.

Returns:

Returns the hoverImage.

setHoverImage

public void setHoverImage(java.lang.String hoverImage)

Sets the hover image that is set for this control.

Parameters:

hoverImage - The hoverImage to set.

getSelectedImage

public java.lang.String getSelectedImage()

Gets the selected image that is set for this control.

Returns:

Returns the selectedImage.

setSelectedImage

public void setSelectedImage(java.lang.String selectedImage)

Sets the selected image that is set for this control.

Parameters:

selectedImage - The selectedImage to set.

getClientAction

public java.lang.String getClientAction()

Gets the client action of the button, should be a javascript method.

Returns:

Returns the clientAction.

setClientAction

public void setClientAction(java.lang.String clientAction)

Sets the client action of the button, should be a javascript method.

Parameters:

clientAction - The clientAction to set.

getServerAction

public java.lang.String getServerAction()

Gets the server action of the button, should be a backing bean method.

Returns:

Returns the serverAction.

setServerAction

public void setServerAction(java.lang.String serverAction)

Sets the server action of the button, should be a backing bean method.

Parameters:

serverAction - The serverAction to set.

getValue

public java.lang.String getValue()

Gets the text value of the button.

Overrides:

getValue in class javax.faces.component.UICommand

Returns:

Returns the value.

setValue

public void setValue(java.lang.String value)

Sets the text value of the button.

Parameters:

value - The value to set.

getType

public java.lang.String getType()

Gets the type of the button.

Returns:

Returns the type.

setType

public void setType(java.lang.String type)

Sets the type of the button.

Parameters:

type - The type to set.

getStyle

public java.lang.String getStyle()

Gets the CSS style of the button.

Returns:

Returns the style.

setStyle

public void setStyle(java.lang.String style)

Sets the CSS style of the button.

Parameters:

style - The style to set.

getToolTip

public java.lang.String getToolTip()

Gets the toolTip of the button.

Returns:

Returns the toolTip.

setToolTip

public void setToolTip(java.lang.String toolTip)

Sets the toolTip of the button.

Parameters:

toolTip - The toolTip to set.

getOnclick

public java.lang.String getOnclick()

Gets the onclick event of the button.

Returns:

Returns the onclick.

setOnclick

public void setOnclick(java.lang.String onclick)

Sets the onclick event of the button.

Parameters:

onclick - The onclick to set.

getCollectionId

public java.lang.String getCollectionId()

Gets the collectionId of the ButtonControl.

Returns:

Returns the collectionId.

setCollectionId

public void setCollectionId(java.lang.String collectionId)

Sets the collectionId of the ButtonControl.

Parameters:

collectionId - The collectionId to set.

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UICommand

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UICommand

execute

public void execute(MapEvent event)
             throws java.lang.Exception

Executes the server action associated with this button. It will be invoked if the button is a MapToolItem.

Specified by:

execute in interface MapToolAction

Parameters:

event - the MapEvent to execute this tool

Throws:

java.lang.Exception - if an error happens while executing the tool. The MapControl aborts processing the current event when this happens.

registerMapToolItem

public void registerMapToolItem(javax.faces.context.FacesContext facesContext)

Registers the button as a MapToolItem.

execute

public void execute(javax.faces.context.FacesContext context)

Executes the server action associated with this button. It will be invoked if the button is not a MapToolItem.

setValueBinding

public void setValueBinding(java.lang.String name,
                            javax.faces.el.ValueBinding binding)

Sets the value binding. For the "value" attribute it checks if it is an instanceof TaskInfo or not. If not, it throws an ADFException. For all other cases, it simply calls super.setValueBinding()

Overrides:

setValueBinding in class javax.faces.component.UIComponentBase

Parameters:

name - the name of the attribute or property for which to set a ValueBinding

binding - the ValueBinding to set. If null, remove any currently set ValueBinding.