com.ibm.xsp.component
Class UICommandEx2

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              com.ibm.xsp.component.UICommandEx2

All Implemented Interfaces:

com.ibm.xsp.component.FacesNavigationBehaviour, FacesSaveBehaviour, javax.faces.component.ActionSource, javax.faces.component.StateHolder

Direct Known Subclasses:

UICommandButton, UIEventHandler

public class UICommandEx2
extends javax.faces.component.UICommand
implements com.ibm.xsp.component.FacesNavigationBehaviour, FacesSaveBehaviour

Not intended to be subclassed.

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String	COMPONENT_FAMILY The standard component family for this component.
static java.lang.String	EXEC_COMPLETE
static java.lang.String	EXEC_PARTIAL
static java.lang.String	MODE_COMPLETE
static java.lang.String	MODE_NOREFRESH
static java.lang.String	MODE_PARTIAL

Fields inherited from class javax.faces.component.UICommand

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

UICommandEx2()

Method Summary

boolean	doNavigation(javax.faces.context.FacesContext context, javax.faces.event.ActionEvent event, java.lang.Object outcome)
boolean	doSave(javax.faces.context.FacesContext context, javax.faces.event.ActionEvent event, java.lang.Object outcome) Return true if a save should be performed.
void	encodeBegin(javax.faces.context.FacesContext context)
java.lang.String	getExecId() Get the id of the component to be executed.
java.lang.String	getExecMode() Return the execution mode for this command.
java.lang.String	getFamily()
java.lang.String	getOnComplete() Get the client script to execute after the AJAX request is completed.
java.lang.String	getOnError() Get the client script to execute when an error occurred.
java.lang.String	getOnStart() Get the client script to execute when the AJAX request is triggered.
java.lang.String	getRefreshId() Get the id of the component to be refreshed.
java.lang.String	getRefreshMode() Return the partial refresh mode
boolean	isDisableValidators() Return true if the validators should be disabled when this command is fired
boolean	isNavigate() Return true if navigation should be done for this command.
boolean	isPartialRefresh() Check if the submit mode is a partial refresh.
boolean	isSave() Return true if save should be done for this command.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setDisableValidators(boolean disableValidators) Define if the validators should be disabled when this command is fired
void	setExecId(java.lang.String execId) Set the id of the component to be refreshed.
void	setExecMode(java.lang.String execMode) Set the execution mode.
void	setNavigate(boolean navigate) Set true if navigation should be done for this command.
void	setOnComplete(java.lang.String onComplete) Set the client script to execute after the AJAX request is completed.
void	setOnError(java.lang.String onError) Set the client script to execute when an error occurred.
void	setOnStart(java.lang.String onStart) Set the client script to execute when the AJAX request is triggered.
void	setRefreshId(java.lang.String refreshId) Set the id of the component to be refreshed.
void	setRefreshMode(java.lang.String refreshMode) Set true if a partial refresh should be done for this command.
void	setSave(boolean save) Set true if save should be done for this command.

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

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree

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

MODE_COMPLETE

public static final java.lang.String MODE_COMPLETE

See Also:

Constant Field Values

MODE_PARTIAL

public static final java.lang.String MODE_PARTIAL

See Also:

Constant Field Values

MODE_NOREFRESH

public static final java.lang.String MODE_NOREFRESH

See Also:

Constant Field Values

EXEC_COMPLETE

public static final java.lang.String EXEC_COMPLETE

See Also:

Constant Field Values

EXEC_PARTIAL

public static final java.lang.String EXEC_PARTIAL

See Also:

Constant Field Values

Constructor Detail

UICommandEx2

public UICommandEx2()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand

isNavigate

public boolean isNavigate()

Return true if navigation should be done for this command.

Returns:

setNavigate

public void setNavigate(boolean navigate)

Set true if navigation should be done for this command.

isSave

public boolean isSave()

Return true if save should be done for this command.

Returns:

setSave

public void setSave(boolean save)

Set true if save should be done for this command.

getRefreshMode

public java.lang.String getRefreshMode()

Return the partial refresh mode

Returns:

setRefreshMode

public void setRefreshMode(java.lang.String refreshMode)

Set true if a partial refresh should be done for this command.

isDisableValidators

public boolean isDisableValidators()

Return true if the validators should be disabled when this command is fired

Returns:

setDisableValidators

public void setDisableValidators(boolean disableValidators)

Define if the validators should be disabled when this command is fired

getRefreshId

public java.lang.String getRefreshId()

Get the id of the component to be refreshed.

Returns:

setRefreshId

public void setRefreshId(java.lang.String refreshId)

Set the id of the component to be refreshed.

Parameters:

-

isPartialRefresh

public boolean isPartialRefresh()

Check if the submit mode is a partial refresh.

Returns:

getExecMode

public java.lang.String getExecMode()

Return the execution mode for this command.

Returns:

setExecMode

public void setExecMode(java.lang.String execMode)

Set the execution mode.

getExecId

public java.lang.String getExecId()

Get the id of the component to be executed.

Returns:

setExecId

public void setExecId(java.lang.String execId)

Set the id of the component to be refreshed.

Parameters:

-

getOnStart

public java.lang.String getOnStart()

Get the client script to execute when the AJAX request is triggered.

Returns:

setOnStart

public void setOnStart(java.lang.String onStart)

Set the client script to execute when the AJAX request is triggered.

Parameters:

-

getOnComplete

public java.lang.String getOnComplete()

Get the client script to execute after the AJAX request is completed.

Returns:

setOnComplete

public void setOnComplete(java.lang.String onComplete)

Set the client script to execute after the AJAX request is completed.

Parameters:

-

getOnError

public java.lang.String getOnError()

Get the client script to execute when an error occurred.

Returns:

setOnError

public void setOnError(java.lang.String onError)

Set the client script to execute when an error occurred.

Parameters:

-

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UICommand

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UICommand

doNavigation

public boolean doNavigation(javax.faces.context.FacesContext context,
                            javax.faces.event.ActionEvent event,
                            java.lang.Object outcome)

Specified by:

doNavigation in interface com.ibm.xsp.component.FacesNavigationBehaviour

doSave

public boolean doSave(javax.faces.context.FacesContext context,
                      javax.faces.event.ActionEvent event,
                      java.lang.Object outcome)

Description copied from interface: FacesSaveBehaviour

Return true if a save should be performed.

Specified by:

doSave in interface FacesSaveBehaviour

Returns:

true if navigation should be performed