|
|||||||||
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.TaskControl
public class TaskControl
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 |
DEFAULT_XSL_FILE_NAME
The name of the XSL file used to render this control by default. |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
TaskControl()
Initializes the TaskControl. |
Method Summary | |
---|---|
String |
getFamily()
Returns the family of this control. |
String |
getMapId()
Returns the map control id associated with the control. |
protected javax.faces.render.Renderer |
getRenderer(javax.faces.context.FacesContext context)
Returns a design-time renderer if the component is used in an IDE. |
String |
getStyle()
Returns the style attributes of toolbar control. |
String |
getStyleClass()
Returns the file name where the CSS style attributes are defined. |
Object |
getTask()
Returns the Object task bean associated with this control. |
TaskInfo |
getTaskInfo()
Return the task info object by introspecting the task bean. |
Class |
getTaskInfoClass()
Returns the task info class. |
URL |
getXslUrl()
Returns the URL of the XSL file used to render the control. |
boolean |
isClientPostBack()
Indicates whether the control supports client side post back. |
boolean |
isInit()
Returns an indicator whether this control is initialized. |
boolean |
isWindowingSupport()
Indicates whether the control should display in a window object or not. |
void |
processAction(javax.faces.event.ActionEvent event)
Processes an action fired by this control. |
void |
processToolAction(String toolName,
MapEvent event)
|
TaskEvent |
queueTaskEvent(javax.faces.context.FacesContext facesContext,
Object task,
TaskActionDescriptorModel action)
|
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 |
setClientPostBack(boolean clientPostBack)
Sets whether the control supports client side post back. |
void |
setInit(boolean init)
Sets an indicator whether to initialize the control. |
void |
setMapId(String mapId)
Sets the control ID. |
void |
setStyle(String style)
Sets the default style for the toolbar control. |
void |
setStyleClass(String styleClass)
Sets the CSS class name where the CSS style attributes are defined. |
void |
setTaskInfoClass(Class taskInfoClass)
Sets the task info class. |
void |
setTaskInfoXML(URL url)
|
void |
setValueExpression(String name,
javax.el.ValueExpression binding)
Sets the value binding. |
void |
setWindowingSupport(boolean windowingSupport)
Sets whether the control should display in a window object or not. |
void |
setXslUrl(URL xslUrl)
Sets the URL of the XSL file used to render the control. |
Methods inherited from class javax.faces.component.UICommand |
---|
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, 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, 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
public static final String DEFAULT_XSL_FILE_NAME
Constructor Detail |
---|
public TaskControl()
Method Detail |
---|
public String getFamily()
getFamily
in class javax.faces.component.UICommand
String
- the COMPONENT_FAMILY
protected javax.faces.render.Renderer getRenderer(javax.faces.context.FacesContext context)
getRenderer
in class javax.faces.component.UIComponentBase
context
- the FacesContext
Renderer
- the renderer objectpublic void processToolAction(String toolName, MapEvent event)
public void processAction(javax.faces.event.ActionEvent event) throws javax.faces.event.AbortProcessingException
processAction
in interface javax.faces.event.ActionListener
event
- the ActionEvent
javax.faces.event.AbortProcessingException
- if the task results can not be fetchedpublic TaskEvent queueTaskEvent(javax.faces.context.FacesContext facesContext, Object task, TaskActionDescriptorModel action)
public Object getTask()
Object
task bean associated with this control.
Object
- the task bean associated with this controlpublic TaskInfo getTaskInfo()
TaskInfo
- the task info objectpublic Class getTaskInfoClass()
Class
- the task info classpublic void setTaskInfoClass(Class taskInfoClass)
taskInfoClass
- the task info classpublic void setTaskInfoXML(URL url)
public void setInit(boolean init)
init
- if true, initialize the controlpublic boolean isInit()
public String getMapId()
String
- the map control idpublic void setMapId(String mapId)
mapId
- the map control idpublic 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.public void setXslUrl(URL xslUrl)
xslUrl
- the URL of the XSL filepublic URL getXslUrl()
URL
- the URL objectpublic String getStyle()
String
- the style attributespublic void setStyle(String style)
style
- the default style for the toolbar controlpublic String getStyleClass()
String
- the CSS classpublic void setStyleClass(String styleClass)
styleClass
- the CSS classpublic boolean isWindowingSupport()
public void setWindowingSupport(boolean windowingSupport)
windowingSupport
- if true, shows this control in a window objectpublic boolean isClientPostBack()
public void setClientPostBack(boolean clientPostBack)
clientPostBack
- if true, the client side post back is supportedpublic Object saveState(javax.faces.context.FacesContext facesContext)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UICommand
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.UICommand
facesContext
- the associated FacesContextstate
- the object to restore the state of the control from
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |