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

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

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.ActionSource, javax.faces.component.StateHolder, javax.faces.event.ActionListener, javax.faces.event.FacesListener

public class TaskControl
extends javax.faces.component.UICommand
implements javax.faces.event.ActionListener

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	DEFAULT_XSL_FILE_NAME The name of the XSL file used to render this control by default.

Constructor Summary

TaskControl()
Initializes the TaskControl.

Method Summary

java.lang.String	getFamily() Returns the family of this control.
java.lang.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.
java.lang.String	getStyle() Returns the style attributes of toolbar control.
java.lang.String	getStyleClass() Returns the file name where the CSS style attributes are defined.
java.lang.Object	getTask() Returns the Object task bean associated with this control.
TaskInfo	getTaskInfo() Return the task info object by introspecting the task bean.
java.lang.Class	getTaskInfoClass() Returns the task info class.
java.net.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(java.lang.String toolName, MapEvent event)
TaskEvent	queueTaskEvent(javax.faces.context.FacesContext facesContext, java.lang.Object task, TaskActionDescriptorModel action)
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	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(java.lang.String mapId) Sets the control ID.
void	setStyle(java.lang.String style) Sets the default style for the toolbar control.
void	setStyleClass(java.lang.String styleClass) Sets the CSS class name where the CSS style attributes are defined.
void	setTaskInfoClass(java.lang.Class taskInfoClass) Sets the task info class.
void	setTaskInfoXML(java.net.URL url)
void	setValueBinding(java.lang.String name, javax.faces.el.ValueBinding binding) Sets the value binding.
void	setWindowingSupport(boolean windowingSupport) Sets whether the control should display in a window object or not.
void	setXslUrl(java.net.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, getActionListener, getActionListeners, getValue, 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, 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

DEFAULT_XSL_FILE_NAME

public static final java.lang.String DEFAULT_XSL_FILE_NAME

The name of the XSL file used to render this control by default.

See Also:

Constant Field Values

Constructor Detail

TaskControl

public TaskControl()

Initializes the TaskControl. The renderer type is set and the control is registered as an ActionListener.

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

getRenderer

protected javax.faces.render.Renderer getRenderer(javax.faces.context.FacesContext context)

Returns a design-time renderer if the component is used in an IDE.

Overrides:

getRenderer in class javax.faces.component.UIComponentBase

Parameters:

context - the FacesContext

Returns:

Renderer- the renderer object

processToolAction

public void processToolAction(java.lang.String toolName,
                              MapEvent event)

processAction

public void processAction(javax.faces.event.ActionEvent event)
                   throws javax.faces.event.AbortProcessingException

Processes an action fired by this control. The task control performs a operation using the input provided.

Specified by:

processAction in interface javax.faces.event.ActionListener

Parameters:

event - the ActionEvent

Throws:

javax.faces.event.AbortProcessingException - if the task results can not be fetched

queueTaskEvent

public TaskEvent queueTaskEvent(javax.faces.context.FacesContext facesContext,
                                java.lang.Object task,
                                TaskActionDescriptorModel action)

getTask

public java.lang.Object getTask()

Returns the Object task bean associated with this control.

Returns:

Object- the task bean associated with this control

getTaskInfo

public TaskInfo getTaskInfo()

Return the task info object by introspecting the task bean.

Returns:

TaskInfo- the task info object

getTaskInfoClass

public java.lang.Class getTaskInfoClass()

Returns the task info class.

Returns:

Class- the task info class

setTaskInfoClass

public void setTaskInfoClass(java.lang.Class taskInfoClass)

Sets the task info class.

Parameters:

taskInfoClass - the task info class

setTaskInfoXML

public void setTaskInfoXML(java.net.URL url)

setInit

public void setInit(boolean init)

Sets an indicator whether to initialize the control.

Parameters:

init - if true, initialize the control

isInit

public boolean isInit()

Returns an indicator whether this control is initialized.

Returns:

boolean- if true, the control is initialized

getMapId

public java.lang.String getMapId()

Returns the map control id associated with the control.

Returns:

String - the map control id

setMapId

public void setMapId(java.lang.String mapId)

Sets the control ID. The map control id.

Parameters:

mapId - the map control id

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.

setXslUrl

public void setXslUrl(java.net.URL xslUrl)

Sets the URL of the XSL file used to render the control.

Parameters:

xslUrl - the URL of the XSL file

getXslUrl

public java.net.URL getXslUrl()

Returns the URL of the XSL file used to render the control.

Returns:

URL- the URL object

getStyle

public java.lang.String getStyle()

Returns the style attributes of toolbar control.

Returns:

String- the style attributes

setStyle

public void setStyle(java.lang.String style)

Sets the default style for the toolbar control.

Parameters:

style - the default style for the toolbar 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

isWindowingSupport

public boolean isWindowingSupport()

Indicates whether the control should display in a window object or not.

Returns:

boolean- if true, shows this control in a window object

setWindowingSupport

public void setWindowingSupport(boolean windowingSupport)

Sets whether the control should display in a window object or not.

Parameters:

windowingSupport - if true, shows this control in a window object

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

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.UICommand

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.UICommand

Parameters:

facesContext - the associated FacesContext

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