|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
com.esri.adf.web.faces.component.ButtonControl
public class ButtonControl
A button control executes the server side action and/or action listener method for the control its associated with.
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
The standard component family for this component. |
static String |
COMPONENT_TYPE
The standard component type for this component. |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
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. |
String |
getClientAction()
Gets the client action of the button, should be a JavaScript method. |
String |
getCollectionId()
Gets the collectionId of the ButtonControl. |
String |
getDefaultImage()
Returns the default image that is set for this control. |
String |
getFamily()
Returns the family of this control. |
String |
getHoverImage()
Returns the hover image that is set for this control. |
String |
getMapId()
Returns the map control id associated with the control. |
String |
getOnclick()
Gets the onclick event of the button. |
String |
getSelectedImage()
Gets the selected image that is set for this control. |
String |
getServerAction()
Gets the server action of the button, should be a backing bean method. |
String |
getStyle()
Gets the CSS style of the button. |
String |
getStyleClass()
Gets the CSS style class of the ButtonControl. |
String |
getToolTip()
Gets the toolTip of the button. |
String |
getType()
Gets the type of the button. |
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,
Object state)
|
Object |
saveState(javax.faces.context.FacesContext facesContext)
|
void |
setClientAction(String clientAction)
Sets the client action of the button, should be a JavaScript method. |
void |
setCollectionId(String collectionId)
Sets the collectionId of the ButtonControl. |
void |
setDefaultImage(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(String hoverImage)
Sets the hover image that is set for this control. |
void |
setMapId(String mapId)
Sets the map control id associated with the control. |
void |
setOnclick(String onclick)
Sets the onclick event of the button. |
void |
setSelectedImage(String selectedImage)
Sets the selected image that is set for this control. |
void |
setServerAction(String serverAction)
Sets the server action of the button, should be a backing bean method. |
void |
setStyle(String style)
Sets the CSS style of the button. |
void |
setStyleClass(String styleClass)
Sets the CSS style class of the ButtonControl. |
void |
setToolTip(String toolTip)
Sets the toolTip of the button. |
void |
setType(String type)
Sets the type of the button. |
void |
setValue(String value)
Sets the text value of the button. |
void |
setValueExpression(String name,
javax.el.ValueExpression binding)
Sets the value binding. |
Methods inherited from class javax.faces.component.UICommand |
---|
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
Constructor Detail |
---|
public ButtonControl()
Method Detail |
---|
public String getFamily()
getFamily
in class javax.faces.component.UICommand
String
- the COMPONENT_FAMILY
public String getMapId()
public void setMapId(String mapId)
mapId
- The mapId to set.public String getDefaultImage()
public void setDefaultImage(String defaultImage)
defaultImage
- The defaultImage to set.public String getStyleClass()
public void setStyleClass(String styleClass)
styleClass
- The styleClass to set.public boolean isDisabled()
public void setDisabled(boolean disabled)
disabled
- The disabled to set.public String getHoverImage()
public void setHoverImage(String hoverImage)
hoverImage
- The hoverImage to set.public String getSelectedImage()
public void setSelectedImage(String selectedImage)
selectedImage
- The selectedImage to set.public String getClientAction()
public void setClientAction(String clientAction)
clientAction
- The clientAction to set.public String getServerAction()
public void setServerAction(String serverAction)
serverAction
- The serverAction to set.public String getValue()
getValue
in class javax.faces.component.UICommand
public void setValue(String value)
value
- The value to set.public String getType()
public void setType(String type)
type
- The type to set.public String getStyle()
public void setStyle(String style)
style
- The style to set.public String getToolTip()
public void setToolTip(String toolTip)
toolTip
- The toolTip to set.public String getOnclick()
public void setOnclick(String onclick)
onclick
- The onclick to set.public String getCollectionId()
public void setCollectionId(String collectionId)
collectionId
- The collectionId to set.public void restoreState(javax.faces.context.FacesContext facesContext, Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UICommand
public Object saveState(javax.faces.context.FacesContext facesContext)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UICommand
public void execute(MapEvent event) throws Exception
execute
in interface MapToolAction
event
- the MapEvent
to execute this tool
Exception
- if an error happens while executing the tool. The
MapControl
aborts processing the current event when this
happens.public void registerMapToolItem(javax.faces.context.FacesContext facesContext)
public void execute(javax.faces.context.FacesContext context)
public void setValueExpression(String name, javax.el.ValueExpression binding)
setValueExpression
in class javax.faces.component.UIComponent
name
- the name of the attribute or property for which to set a ValueBindingbinding
- the ValueBinding to set. If null, remove any currently set ValueBinding.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |