org.apache.myfaces.tobago.taglib.component
Class AbstractCommandTag

java.lang.Object
  javax.faces.webapp.UIComponentTag
      org.apache.myfaces.tobago.taglib.component.TobagoTag
          org.apache.myfaces.tobago.taglib.component.AbstractCommandTag

All Implemented Interfaces:

JspTag, Tag, AbstractCommandTagDeclaration, TobagoTagDeclaration, HasAction, HasActionListener, HasLink, HasOnclick, HasResource, IsImmediateCommand, IsTransition

Direct Known Subclasses:

ButtonTag, CommandTag, DatePickerTag, LinkTag, MenuCommandTag, SelectBooleanCommandTag, SelectOneCommandTag, ToolBarCommandTag

public abstract class AbstractCommandTag
extends TobagoTag
implements AbstractCommandTagDeclaration

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentTag

pageContext

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

AbstractCommandTag()

Method Summary

String	getAction()
String	getActionListener()
String	getComponentType()
String	getImmediate()
String	getType()
void	release()
void	setAction(String action) Action to invoke when clicked.
void	setActionListener(String actionListener) MethodBinding representing an action listener method that will be notified when this component is activated by the user.
void	setDisabled(String disabled)
void	setImmediate(String immediate) Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
void	setJsfResource(String jsfResource) Flag indicating that the resource referenced by the resource attribute is a jsf resource.
void	setLink(String link) Link to an arbitrary URL, either an internal link or an external link.
void	setOnclick(String onclick) Script to be invoked when clicked
protected void	setProperties(UIComponent component)
void	setResource(String resource) Link to an internal resource.
void	setTransition(String transition) Specify, if the command calls an JSF-Action.
void	setType(String type)

Methods inherited from class org.apache.myfaces.tobago.taglib.component.TobagoTag

doEndTag, doStartTag, getDisabled, getHeight, getHidden, getInline, getLabel, getReadonly, getRendererType, getTitle, getWidth, setHeight, setHidden, setInline, setLabel, setReadonly, setTitle, setWidth

Methods inherited from class javax.faces.webapp.UIComponentTag

encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getDoStartValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, setPageContext, setParent

Constructor Detail

AbstractCommandTag

public AbstractCommandTag()

Method Detail

getComponentType

public String getComponentType()

Specified by:

getComponentType in class UIComponentTag

setProperties

protected void setProperties(UIComponent component)

Overrides:

setProperties in class TobagoTag

release

public void release()

Specified by:

release in interface Tag

Overrides:

release in class TobagoTag

getAction

public String getAction()

setAction

public void setAction(String action)

Description copied from interface: HasAction

Action to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The String is directly passed to the Navigationhandler.

Specified by:

setAction in interface HasAction

setOnclick

public void setOnclick(String onclick)

Description copied from interface: HasOnclick

Script to be invoked when clicked

Specified by:

setOnclick in interface HasOnclick

setLink

public void setLink(String link)

Description copied from interface: HasLink

Link to an arbitrary URL, either an internal link or an external link.

internal absolute link

Starts with a slash '/' character. The context path will be added. A session id will be added, if needed.

external link

Contains a colon ':' character. The link will not be modified.

internal relative link

Any other strings. A session id will be added, if needed.

Specified by:

setLink in interface HasLink

Parameters:

link - The external or internal link.

setResource

public void setResource(String resource)

Description copied from interface: HasResource

Link to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.

Specified by:

setResource in interface HasResource

Parameters:

resource - The internal resource.

See Also:

HasResource.setJsfResource(String)

setJsfResource

public void setJsfResource(String jsfResource)

Description copied from interface: HasResource

Flag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.

Specified by:

setJsfResource in interface HasResource

Parameters:

jsfResource - Is the Resource a JSF page or not?

getActionListener

public String getActionListener()

setActionListener

public void setActionListener(String actionListener)

Description copied from interface: HasActionListener

MethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.

Specified by:

setActionListener in interface HasActionListener

getType

public String getType()

setType

public void setType(String type)

getImmediate

public String getImmediate()

setImmediate

public void setImmediate(String immediate)

Description copied from interface: IsImmediateCommand

Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.

Specified by:

setImmediate in interface IsImmediateCommand

setDisabled

public void setDisabled(String disabled)

Overrides:

setDisabled in class TobagoTag

setTransition

public void setTransition(String transition)

Description copied from interface: IsTransition

Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.

Specified by:

setTransition in interface IsTransition

Parameters:

transition - Indicates the transition.