de.mindmatters.faces.taglib.jsp
Class AbstractHtmlActionSourceComponentTag

java.lang.Object
  javax.faces.webapp.UIComponentTag
      de.mindmatters.faces.taglib.jsp.AbstractUIComponentTag
          de.mindmatters.faces.taglib.jsp.AbstractHtmlComponentTag
              de.mindmatters.faces.taglib.jsp.AbstractHtmlEventHandlerComponentTag
                  de.mindmatters.faces.taglib.jsp.AbstractHtmlActionSourceComponentTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

HtmlFormTag

public abstract class AbstractHtmlActionSourceComponentTag
extends AbstractHtmlEventHandlerComponentTag

AbstractHtmlActionSourceComponentTag is a convenience base class that implements attributes needed for any concrete HTML action source jsp tag.

Author:

Andreas Kuhrwahl

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

AbstractHtmlActionSourceComponentTag()

Method Summary

java.lang.String	getAction() Returns the action value.
java.lang.String	getActionListener() Returns the actionListener value.
java.lang.String	getImmediate() Returns the immediate value.
void	release() Release any resources allocated during the execution of this tag handler.
void	setAction(java.lang.String action) Sets the action attribute.
void	setActionListener(java.lang.String actionListener) Sets the actionListener attribute.
protected void	setActionListenerProperty(UIComponent component) Sets the actionListener property on the associated UIComponent component.
protected void	setActionProperty(UIComponent component) Sets the action property on the associated UIComponent component.
void	setImmediate(java.lang.String immediate) Sets the immediate attribute.
protected void	setImmediateProperty(UIComponent component) Sets the boolean immediate property on the associated UIComponent component.
protected void	setProperties(UIComponent component) Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set. This method must be called ONLY if the specified UIComponent was in fact created during the execution of this tag handler instance, and this call will occur BEFORE the UIComponent is added to the view. Tag subclasses that want to support additional set properties must ensure that the base class setProperties() method is still called. A typical implementation that supports extra properties foo and bar would look something like this: protected void setProperties(UIComponent component) { super.setProperties(component); if (foo != null) { component.setAttribute("foo", foo); } if (bar != null) { component.setAttribute("bar", bar); } } The default implementation overrides the following properties: rendered - Set if a value for the rendered property is specified for this tag handler instance. rendererType - Set if the getRendererType() method returns a non-null value.

Methods inherited from class de.mindmatters.faces.taglib.jsp.AbstractHtmlEventHandlerComponentTag

getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup

Methods inherited from class de.mindmatters.faces.taglib.jsp.AbstractHtmlComponentTag

getDir, getLang, getStyle, getStyleClass, getTitle, setDir, setLang, setStyle, setStyleClass, setTitle

Methods inherited from class de.mindmatters.faces.taglib.jsp.AbstractUIComponentTag

addValueBindingIfNecessary, setBooleanProperty, setStringProperty

Methods inherited from class javax.faces.webapp.UIComponentTag

doEndTag, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getComponentType, getCreated, getDoEndValue, getDoStartValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, getRendererType, 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

Constructor Detail

AbstractHtmlActionSourceComponentTag

public AbstractHtmlActionSourceComponentTag()

Method Detail

release

public void release()

Release any resources allocated during the execution of this tag handler.

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class AbstractHtmlEventHandlerComponentTag

setProperties

protected void setProperties(UIComponent component)

Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set. This method must be called ONLY if the specified UIComponent was in fact created during the execution of this tag handler instance, and this call will occur BEFORE the UIComponent is added to the view.

Tag subclasses that want to support additional set properties must ensure that the base class setProperties() method is still called. A typical implementation that supports extra properties foo and bar would look something like this:

 protected void setProperties(UIComponent component) {
   super.setProperties(component);
   if (foo != null) {
     component.setAttribute("foo", foo);
   }
   if (bar != null) {
     component.setAttribute("bar", bar);
   }
 }
 

The default implementation overrides the following properties:

• rendered - Set if a value for the rendered property is specified for this tag handler instance.
• rendererType - Set if the getRendererType() method returns a non-null value.

Overrides:

setProperties in class AbstractHtmlEventHandlerComponentTag

Parameters:

component - UIComponent whose properties are to be overridden

setActionProperty

protected void setActionProperty(UIComponent component)

Sets the action property on the associated UIComponent component.

Parameters:

component - The associated UIComponent

setActionListenerProperty

protected void setActionListenerProperty(UIComponent component)

Sets the actionListener property on the associated UIComponent component.

Parameters:

component - The associated UIComponent

setImmediateProperty

protected void setImmediateProperty(UIComponent component)

Sets the boolean immediate property on the associated UIComponent component.

Parameters:

component - The associated UIComponent

getAction

public final java.lang.String getAction()

Returns the action value.

Returns:

The action value

setAction

public final void setAction(java.lang.String action)

Sets the action attribute.

Parameters:

action - The action value.

getActionListener

public final java.lang.String getActionListener()

Returns the actionListener value.

Returns:

The actionListener value

setActionListener

public final void setActionListener(java.lang.String actionListener)

Sets the actionListener attribute.

Parameters:

actionListener - The actionListener value.

getImmediate

public final java.lang.String getImmediate()

Returns the immediate value.

Returns:

The immediate value

setImmediate

public final void setImmediate(java.lang.String immediate)

Sets the immediate attribute.

Parameters:

immediate - The immediate value.