de.mindmatters.faces.taglib.jsp
Class HtmlFormTag

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
                      de.mindmatters.faces.taglib.jsp.HtmlFormTag

All Implemented Interfaces:

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

public class HtmlFormTag
extends AbstractHtmlActionSourceComponentTag

HtmlFormTag represents the HTML jsp tag for UIComponent HtmlForm.

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

HtmlFormTag()

Method Summary

java.lang.String	getAccept() Returns the accept attribute value.
java.lang.String	getAcceptCharset() Returns the acceptCharset attribute value.
java.lang.String	getComponentType() Return the component type for the component that is or will be bound to this tag.
java.lang.String	getEnctype() Returns the enctype attribute value.
java.lang.String	getMethod() Returns the method attribute value.
java.lang.String	getName() Returns the name attribute value.
java.lang.String	getOnreset() Returns the onreset attribute value.
java.lang.String	getOnsubmit() Returns the onsubmit attribute value.
java.lang.String	getRendererType() Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly.
java.lang.String	getTarget() Returns the target attribute value.
java.lang.String	getTransient() Returns the transient attribute value.
void	release() Release any resources allocated during the execution of this tag handler.
void	setAccept(java.lang.String accept) Sets the accept attribute value.
void	setAcceptCharset(java.lang.String acceptCharset) Sets the acceptCharset attribute value.
protected void	setActionProperty(UIComponent component) Sets the action property on the associated UIComponent component.
void	setEnctype(java.lang.String enctype) Sets the enctype attribute value.
void	setMethod(java.lang.String method) Sets the method attribute value.
void	setName(java.lang.String name) Sets the name attribute value.
void	setOnreset(java.lang.String onreset) Sets the onreset attribute value.
void	setOnsubmit(java.lang.String onsubmit) Sets the onsubmit attribute value.
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.
void	setTarget(java.lang.String target) Sets the target attribute value.
void	setTransient(java.lang.String transientValue) Sets the transient attribute value.

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

getAction, getActionListener, getImmediate, setAction, setActionListener, setActionListenerProperty, setImmediate, setImmediateProperty

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, 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

Constructor Detail

HtmlFormTag

public HtmlFormTag()

Method Detail

getComponentType

public java.lang.String getComponentType()

Return the component type for the component that is or will be bound to this tag. This value can be passed to Application.createComponent(java.lang.String) to create the UIComponent instance for this tag. Subclasses must override this method to return the appropriate value.

Specified by:

getComponentType in class UIComponentTag

getRendererType

public java.lang.String getRendererType()

Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly. Subclasses must override this method to return the appropriate value.

Specified by:

getRendererType in class UIComponentTag

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 AbstractHtmlActionSourceComponentTag

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 AbstractHtmlActionSourceComponentTag

Parameters:

component - UIComponent whose properties are to be overridden

setActionProperty

protected void setActionProperty(UIComponent component)

Sets the action property on the associated UIComponent component.

Overrides:

setActionProperty in class AbstractHtmlActionSourceComponentTag

Parameters:

component - The associated UIComponent

getAccept

public final java.lang.String getAccept()

Returns the accept attribute value.

Returns:

The accept attribute value

setAccept

public final void setAccept(java.lang.String accept)

Sets the accept attribute value.

Parameters:

accept - The accept attribute value

getAcceptCharset

public final java.lang.String getAcceptCharset()

Returns the acceptCharset attribute value.

Returns:

The acceptCharset attribute value

setAcceptCharset

public final void setAcceptCharset(java.lang.String acceptCharset)

Sets the acceptCharset attribute value.

Parameters:

acceptCharset - The acceptCharset attribute value

getEnctype

public final java.lang.String getEnctype()

Returns the enctype attribute value.

Returns:

The enctype attribute value

setEnctype

public final void setEnctype(java.lang.String enctype)

Sets the enctype attribute value.

Parameters:

enctype - The enctype attribute value

getName

public final java.lang.String getName()

Returns the name attribute value.

Returns:

The name attribute value

setName

public final void setName(java.lang.String name)

Sets the name attribute value.

Parameters:

name - The name attribute value

getOnreset

public final java.lang.String getOnreset()

Returns the onreset attribute value.

Returns:

The onreset attribute value

setOnreset

public final void setOnreset(java.lang.String onreset)

Sets the onreset attribute value.

Parameters:

onreset - The onreset attribute value

getOnsubmit

public final java.lang.String getOnsubmit()

Returns the onsubmit attribute value.

Returns:

The onsubmit attribute value

setOnsubmit

public final void setOnsubmit(java.lang.String onsubmit)

Sets the onsubmit attribute value.

Parameters:

onsubmit - The onsubmit attribute value

getTarget

public final java.lang.String getTarget()

Returns the target attribute value.

Returns:

The target attribute value

setTarget

public final void setTarget(java.lang.String target)

Sets the target attribute value.

Parameters:

target - The target attribute value

getMethod

public final java.lang.String getMethod()

Returns the method attribute value.

Returns:

The method attribute value

setMethod

public final void setMethod(java.lang.String method)

Sets the method attribute value.

Parameters:

method - The method attribute value

Throws:

java.lang.IllegalArgumentException - if method is 'GET' and no ViewBuilder is configured

getTransient

public final java.lang.String getTransient()

Returns the transient attribute value.

Returns:

The transient attribute value

setTransient

public final void setTransient(java.lang.String transientValue)

Sets the transient attribute value.

Parameters:

transientValue - the transient value