|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXCommand
public class UIXCommand
| Type | Phases | Description |
|---|---|---|
javax.faces.event.ActionEvent |
Invoke Application Apply Request Values |
Event delivered when the "action" of the component has been invoked; for example, by clicking on a button. The action may result in page navigation. |
org.apache.myfaces.trinidad.event.ReturnEvent |
Apply Request Values | Event delivered when the dialog has completed successfully. |
org.apache.myfaces.trinidad.event.LaunchEvent |
Invoke Application Apply Request Values |
Event delivered to prompt the command to launch a dialog. |
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
| Field Summary | |
|---|---|
static PropertyKey |
ACTION_EXPRESSION_KEY
|
static PropertyKey |
ACTION_LISTENER_KEY
|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static PropertyKey |
IMMEDIATE_KEY
|
static PropertyKey |
LAUNCH_LISTENER_KEY
|
static PropertyKey |
RETURN_LISTENER_KEY
|
static FacesBean.Type |
TYPE
|
| Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
|---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
| Fields inherited from class javax.faces.component.UIComponent |
|---|
bindings |
| Constructor Summary | |
|---|---|
|
UIXCommand()
Construct an instance of the UIXCommand. |
protected |
UIXCommand(String rendererType)
Construct an instance of the UIXCommand. |
| Method Summary | |
|---|---|
void |
addActionListener(ActionListener listener)
Adds a action listener. |
void |
addLaunchListener(LaunchListener listener)
Adds a launch listener. |
void |
addReturnListener(ReturnListener listener)
Adds a return listener. |
void |
broadcast(FacesEvent event)
|
MethodBinding |
getAction()
|
MethodExpression |
getActionExpression()
Gets a reference to an action method sent by the command component, or the static outcome of an action. |
MethodBinding |
getActionListener()
Gets a method reference to an action listener |
ActionListener[] |
getActionListeners()
Returns an array of attached action listeners. |
protected FacesBean.Type |
getBeanType()
|
String |
getFamily()
|
MethodExpression |
getLaunchListener()
Gets a method reference to a launch listener |
LaunchListener[] |
getLaunchListeners()
Returns an array of attached launch listeners. |
MethodExpression |
getReturnListener()
Gets a method reference to a return listener.This method is used to process dialog returnEvents which are generated as a result of either calling org.apache.myfaces.trinidad.context.RequestContext.returnFromDialog directly or declaratively through the use of a returnActionListener tag. |
ReturnListener[] |
getReturnListeners()
Returns an array of attached return listeners. |
boolean |
isImmediate()
Gets whether data validation - client-side or server-side - will be skipped when events are generated by this component. |
void |
queueEvent(FacesEvent e)
Intercept queueEvent and mark the phaseId for the
event to be PhaseId.APPLY_REQUEST_VALUES if the
immediate flag is true,
PhaseId.INVOKE_APPLICATION otherwise. |
void |
removeActionListener(ActionListener listener)
Removes a action listener. |
void |
removeLaunchListener(LaunchListener listener)
Removes a launch listener. |
void |
removeReturnListener(ReturnListener listener)
Removes a return listener. |
void |
setAction(MethodBinding binding)
|
void |
setActionExpression(MethodExpression actionExpression)
Sets a reference to an action method sent by the command component, or the static outcome of an action. |
void |
setActionListener(MethodBinding actionListener)
Sets a method reference to an action listener |
void |
setImmediate(boolean immediate)
Sets whether data validation - client-side or server-side - will be skipped when events are generated by this component. |
void |
setLaunchListener(MethodBinding binding)
Deprecated. |
void |
setLaunchListener(MethodExpression launchListener)
Sets a method reference to a launch listener |
void |
setReturnListener(MethodBinding binding)
Deprecated. |
void |
setReturnListener(MethodExpression returnListener)
Sets a method reference to a return listener.This method is used to process dialog returnEvents which are generated as a result of either calling org.apache.myfaces.trinidad.context.RequestContext.returnFromDialog directly or declaratively through the use of a returnActionListener tag. |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getContainerClientId |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final FacesBean.Type TYPE
public static final PropertyKey ACTION_EXPRESSION_KEY
public static final PropertyKey ACTION_LISTENER_KEY
public static final PropertyKey RETURN_LISTENER_KEY
public static final PropertyKey LAUNCH_LISTENER_KEY
public static final PropertyKey IMMEDIATE_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
| Constructor Detail |
|---|
public UIXCommand()
protected UIXCommand(String rendererType)
| Method Detail |
|---|
@Deprecated public void setLaunchListener(MethodBinding binding)
@Deprecated public void setReturnListener(MethodBinding binding)
public MethodBinding getAction()
getAction in interface ActionSourcepublic void setAction(MethodBinding binding)
setAction in interface ActionSourcepublic void queueEvent(FacesEvent e)
Intercept queueEvent and mark the phaseId for the
event to be PhaseId.APPLY_REQUEST_VALUES if the
immediate flag is true,
PhaseId.INVOKE_APPLICATION otherwise.
queueEvent in class UIXComponentBase
public void broadcast(FacesEvent event)
throws AbortProcessingException
broadcast in class UIXComponentBaseAbortProcessingExceptionpublic final MethodExpression getActionExpression()
getActionExpression in interface ActionSource2public final void setActionExpression(MethodExpression actionExpression)
setActionExpression in interface ActionSource2actionExpression - the new actionExpression valuepublic final MethodBinding getActionListener()
getActionListener in interface ActionSourcepublic final void setActionListener(MethodBinding actionListener)
setActionListener in interface ActionSourceactionListener - the new actionListener valuepublic final MethodExpression getReturnListener()
getReturnListener in interface DialogSourcepublic final void setReturnListener(MethodExpression returnListener)
setReturnListener in interface DialogSourcereturnListener - the new returnListener valuepublic final MethodExpression getLaunchListener()
getLaunchListener in interface DialogSourcepublic final void setLaunchListener(MethodExpression launchListener)
setLaunchListener in interface DialogSourcelaunchListener - the new launchListener valuepublic final boolean isImmediate()
isImmediate in interface ActionSourcepublic final void setImmediate(boolean immediate)
setImmediate in interface ActionSourceimmediate - the new immediate valuepublic final void addActionListener(ActionListener listener)
addActionListener in interface ActionSourcelistener - the action listener to addpublic final void removeActionListener(ActionListener listener)
removeActionListener in interface ActionSourcelistener - the action listener to removepublic final ActionListener[] getActionListeners()
getActionListeners in interface ActionSourcepublic final void addReturnListener(ReturnListener listener)
addReturnListener in interface DialogSourcelistener - the return listener to addpublic final void removeReturnListener(ReturnListener listener)
removeReturnListener in interface DialogSourcelistener - the return listener to removepublic final ReturnListener[] getReturnListeners()
getReturnListeners in interface DialogSourcepublic final void addLaunchListener(LaunchListener listener)
addLaunchListener in interface DialogSourcelistener - the launch listener to addpublic final void removeLaunchListener(LaunchListener listener)
removeLaunchListener in interface DialogSourcelistener - the launch listener to removepublic final LaunchListener[] getLaunchListeners()
getLaunchListeners in interface DialogSourcepublic String getFamily()
getFamily in class UIXComponentBaseprotected FacesBean.Type getBeanType()
getBeanType in class UIXComponentBase
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||