|
|||||||||
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
com.esri.adf.web.faces.component.ToolControl
public class ToolControl
The Tool Control executes the client action followed by the server side action.
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
The standard component family for this component. |
static String |
COMPONENT_TYPE
The standard component type for this component. |
static String |
CONTROLID_DELIMITER
The delimiter for the control ID. |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
ToolControl()
Initializes the Tool Control and sets the renderer type to null. |
Method Summary | |
---|---|
Element |
generateXML()
Generates an XML representation of the control. |
String |
getClientAction()
Returns the client action method associated with this tool. |
String |
getCursor()
Returns the cursor that is used for this control. |
String |
getDefaultImage()
Returns the default image that is set for this control. |
String |
getDisabledImage()
Returns the disabled 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 |
getLineColor()
Returns the color of the line. |
int |
getLineWidth()
Returns the width of the line. |
String |
getSelectedImage()
Returns the selected image that is set for this control. |
String |
getServerAction()
Returns the server side tool action name. |
String |
getServerMethod()
Returns the expression string for server side tool action method binding. |
String |
getStyle()
Returns the style attributes of the tool control. |
String |
getStyleClass()
Returns the file name where the CSS style attributes are defined. |
String |
getToolText()
Returns the tool text that is set for this control. |
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,
Object state)
Restores the state of the control. |
Object |
saveState(javax.faces.context.FacesContext facesContext)
Saves the state of this control. |
void |
setClientAction(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(String cursor)
Sets the cursor for this control. |
void |
setDefaultImage(String defaultImage)
Sets the default image for this control. |
void |
setDisabled(boolean disabled)
Sets an indicator whether to disable the control. |
void |
setDisabledImage(String disabledImage)
Sets the disabled image for this control. |
void |
setHoverImage(String hoverImage)
Sets the hover image for this control. |
void |
setInit(boolean init)
Sets an indicator whether to initialize the control. |
void |
setLineColor(String lineColor)
Sets the line color for this control. |
void |
setLineWidth(int lineWidth)
Sets the line width for this control. |
void |
setSelectedImage(String selectedImage)
Sets the selected image for this control. |
void |
setServerAction(String serverAction)
Sets the server side tool action name. |
void |
setServerMethod(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(String style)
Sets the default style for the tool control. |
void |
setStyleClass(String styleClass)
Sets the CSS class name where the CSS style attributes are defined. |
void |
setToolText(String toolText)
Sets the text to be displayed for this control. |
void |
setToolTip(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, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getValueExpression, setValueExpression |
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
public static final String CONTROLID_DELIMITER
Constructor Detail |
---|
public ToolControl()
Method Detail |
---|
public String getFamily()
getFamily
in class javax.faces.component.UIComponent
String
- the COMPONENT_FAMILY
public boolean isInit()
public void setInit(boolean init)
init
- if true, initialize the controlpublic String getClientAction()
String
- the client action method name.public void setClientAction(String clientAction)
clientAction
- the client action method to be used for this tool.public String getServerAction()
String
- the server side tool action namepublic void setServerAction(String serverAction)
serverAction
- the server side tool action namepublic String getServerMethod()
String
- the expression string for the server side tool action method bindingpublic void setServerMethod(String serverMethod)
serverMethod
- the expression string for the server side tool action method bindingpublic String getStyle()
String
- the style attributespublic void setStyle(String style)
style
- the default style for the tool controlpublic String getStyleClass()
String
- the CSS classpublic void setStyleClass(String styleClass)
styleClass
- the CSS classpublic String getToolTip()
String
- the tool tippublic void setToolTip(String toolTip)
toolTip
- the alternate text for this controlpublic String getToolText()
String
- the tool textpublic void setToolText(String toolText)
toolText
- the text for this controlpublic String getDefaultImage()
String
- the default imagepublic void setDefaultImage(String defaultImage)
defaultImage
- the default image for this controlpublic String getHoverImage()
String
- the hover imagepublic void setHoverImage(String hoverImage)
hoverImage
- the hover image for this controlpublic String getSelectedImage()
String
- the selected imagepublic void setSelectedImage(String selectedImage)
selectedImage
- the selected image for this controlpublic String getDisabledImage()
String
- the disabled imagepublic void setDisabledImage(String disabledImage)
disabledImage
- the disabled image for this controlpublic String getCursor()
String
- the cursor namepublic void setCursor(String cursor)
cursor
- the cursor for this controlpublic boolean isDisabled()
public void setDisabled(boolean disabled)
disabled
- if true, disable the controlpublic boolean isShowLoadingImage()
public void setShowLoadingImage(boolean showLoadingImage)
showLoadingImage
- if true, the loading image is shownpublic boolean isClientPostBack()
public void setClientPostBack(boolean clientPostBack)
clientPostBack
- if true, the client side post back is supportedpublic void setLineColor(String lineColor)
lineColor
- an HTML color stringpublic String getLineColor()
String
- the line colorpublic void setLineWidth(int lineWidth)
lineWidth
- the line width in pixelspublic int getLineWidth()
public Object saveState(javax.faces.context.FacesContext facesContext)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
facesContext
- the associated FacesContext
Object
- the object to be savedpublic void restoreState(javax.faces.context.FacesContext facesContext, Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
facesContext
- the associated FacesContextstate
- the object from which to restore the state of the controlpublic Element generateXML()
generateXML
in interface ToolbarItem
Element
- the XML element of the control
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |