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

java.lang.Object
  extended by javax.faces.webapp.UIComponentTag
      extended by org.apache.myfaces.tobago.taglib.component.TobagoTag
          extended by 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
 java.lang.String getAction()
           
 java.lang.String getActionListener()
           
 java.lang.String getComponentType()
           
 java.lang.String getImmediate()
           
 java.lang.String getType()
           
 void release()
           
 void setAction(java.lang.String action)
          Action to invoke when clicked.
 void setActionListener(java.lang.String actionListener)
          MethodBinding representing an action listener method that will be notified when this component is activated by the user.
 void setDisabled(java.lang.String disabled)
           
 void setImmediate(java.lang.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(java.lang.String jsfResource)
          Flag indicating that the resource referenced by the resource attribute is a jsf resource.
 void setLink(java.lang.String link)
          Link to an arbitrary URL, either an internal link or an external link.
 void setOnclick(java.lang.String onclick)
          Script to be invoked when clicked
protected  void setProperties(UIComponent component)
           
 void setResource(java.lang.String resource)
          Link to an internal resource.
 void setTransition(java.lang.String transition)
          Specify, if the command calls an JSF-Action.
 void setType(java.lang.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 java.lang.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 java.lang.String getAction()

setAction

public void setAction(java.lang.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(java.lang.String onclick)
Description copied from interface: HasOnclick
Script to be invoked when clicked

Specified by:
setOnclick in interface HasOnclick

setLink

public void setLink(java.lang.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(java.lang.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(java.lang.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 java.lang.String getActionListener()

setActionListener

public void setActionListener(java.lang.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 java.lang.String getType()

setType

public void setType(java.lang.String type)

getImmediate

public java.lang.String getImmediate()

setImmediate

public void setImmediate(java.lang.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(java.lang.String disabled)
Overrides:
setDisabled in class TobagoTag

setTransition

public void setTransition(java.lang.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.


Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.