|
| |
|
| java.lang.Object
 javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
All known Subclasses: javax.faces.component.html.HtmlCommandLink, javax.faces.component.html.HtmlCommandButton,
| UICommand | | public class UICommand extends UIComponentBase implements ActionSource2(Code) | | Events:
| Type |
Phases |
Description |
javax.faces.event.ActionEvent |
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. |
|
| Constructor Summary | |
| public | UICommand()
Construct an instance of the UICommand. |
| COMPONENT_FAMILY | | final public static String COMPONENT_FAMILY(Code) | | |
| COMPONENT_TYPE | | final public static String COMPONENT_TYPE(Code) | | |
| UICommand | | public UICommand()(Code) | | Construct an instance of the UICommand.
|
| addActionListener | | public void addActionListener(ActionListener listener)(Code) | | Adds a action listener.
Parameters:
listener - the action listener to add |
| getActionExpression | | public MethodExpression getActionExpression()(Code) | | Gets Specifies the action to take when this command is invoked.
If the value is an expression, it is expected to be a method
binding EL expression that identifies an action method. An action method
accepts no parameters and has a String return value, called the action
outcome, that identifies the next view displayed. The phase that this
event is fired in can be controlled via the immediate attribute.
If the value is a string literal, it is treated as a navigation outcome
for the current view. This is functionally equivalent to a reference to
an action method that returns the string literal.
the new actionExpression value |
| getActionListener | | public MethodBinding getActionListener()(Code) | | Gets A method binding EL expression that identifies an action listener method
to be invoked if this component is activated by the user. An action
listener method accepts a parameter of type javax.faces.event.ActionEvent
and returns void. The phase that this event is fired in can be controlled
via the immediate attribute.
the new actionListener value |
| getActionListeners | | public ActionListener[] getActionListeners()(Code) | | Returns an array of attached action listeners.
an array of attached action listeners. |
| getValue | | public Object getValue()(Code) | | Gets The initial value of this component.
the new value value |
| isImmediate | | public boolean isImmediate()(Code) | | Gets A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
the new immediate value |
| removeActionListener | | public void removeActionListener(ActionListener listener)(Code) | | Removes a action listener.
Parameters:
listener - the action listener to remove |
| setActionExpression | | public void setActionExpression(MethodExpression actionExpression)(Code) | | Sets Specifies the action to take when this command is invoked.
If the value is an expression, it is expected to be a method
binding EL expression that identifies an action method. An action method
accepts no parameters and has a String return value, called the action
outcome, that identifies the next view displayed. The phase that this
event is fired in can be controlled via the immediate attribute.
If the value is a string literal, it is treated as a navigation outcome
for the current view. This is functionally equivalent to a reference to
an action method that returns the string literal.
Parameters:
actionExpression - the new actionExpression value |
| setActionListener | | public void setActionListener(MethodBinding actionListener)(Code) | | Sets A method binding EL expression that identifies an action listener method
to be invoked if this component is activated by the user. An action
listener method accepts a parameter of type javax.faces.event.ActionEvent
and returns void. The phase that this event is fired in can be controlled
via the immediate attribute.
Parameters:
actionListener - the new actionListener value |
| setImmediate | | public void setImmediate(boolean immediate)(Code) | | Sets A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
Parameters:
immediate - the new immediate value |
| setValue | | public void setValue(Object value)(Code) | | Sets The initial value of this component.
Parameters:
value - the new value value |
| Methods inherited from javax.faces.component.UIComponentBase | protected void addFacesListener(FacesListener listener)(Code)(Java Doc)
public void broadcast(FacesEvent event) throws AbortProcessingException(Code)(Java Doc)
public void decode(FacesContext context)(Code)(Java Doc)
public void encodeBegin(FacesContext context) throws IOException(Code)(Java Doc)
public void encodeChildren(FacesContext context) throws IOException(Code)(Java Doc)
public void encodeEnd(FacesContext context) throws IOException(Code)(Java Doc)
public UIComponent findComponent(String expr)(Code)(Java Doc)
public Map<String, Object> getAttributes()(Code)(Java Doc)
public int getChildCount()(Code)(Java Doc)
public List<UIComponent> getChildren()(Code)(Java Doc)
public String getClientId(FacesContext context)(Code)(Java Doc)
T getExpressionValue(String attribute, T explizitValue, T defaultValueIfExpressionNull)(Code)(Java Doc)
protected FacesContext getFacesContext()(Code)(Java Doc)
protected FacesListener[] getFacesListeners(Class clazz)(Code)(Java Doc)
public UIComponent getFacet(String name)(Code)(Java Doc)
public int getFacetCount()(Code)(Java Doc)
public Map<String, UIComponent> getFacets()(Code)(Java Doc)
public Iterator<UIComponent> getFacetsAndChildren()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
public UIComponent getParent()(Code)(Java Doc)
protected Renderer getRenderer(FacesContext context)(Code)(Java Doc)
public String getRendererType()(Code)(Java Doc)
public boolean getRendersChildren()(Code)(Java Doc)
public ValueBinding getValueBinding(String name)(Code)(Java Doc)
public boolean invokeOnComponent(FacesContext context, String clientId, ContextCallback callback) throws FacesException(Code)(Java Doc)
public boolean isRendered()(Code)(Java Doc)
public boolean isTransient()(Code)(Java Doc)
public void processDecodes(FacesContext context)(Code)(Java Doc)
public void processRestoreState(FacesContext context, Object state)(Code)(Java Doc)
public Object processSaveState(FacesContext context)(Code)(Java Doc)
public void processUpdates(FacesContext context)(Code)(Java Doc)
public void processValidators(FacesContext context)(Code)(Java Doc)
public void queueEvent(FacesEvent event)(Code)(Java Doc)
protected void removeFacesListener(FacesListener listener)(Code)(Java Doc)
public static Object restoreAttachedState(FacesContext context, Object stateObj) throws IllegalStateException(Code)(Java Doc)
public void restoreState(FacesContext context, Object state)(Code)(Java Doc)
public static Object saveAttachedState(FacesContext context, Object attachedObject)(Code)(Java Doc)
public Object saveState(FacesContext context)(Code)(Java Doc)
public void setId(String id)(Code)(Java Doc)
public void setParent(UIComponent parent)(Code)(Java Doc)
public void setRendered(boolean rendered)(Code)(Java Doc)
public void setRendererType(String rendererType)(Code)(Java Doc)
public void setTransient(boolean transientFlag)(Code)(Java Doc)
public void setValueBinding(String name, ValueBinding binding)(Code)(Java Doc)
|
|
|
|