com.sun.faces.ext.taglib

Class FocusTag

java.lang.Object

javax.faces.webapp.UIComponentTagBase

javax.faces.webapp.UIComponentClassicTagBase

javax.faces.webapp.UIComponentELTag

com.sun.faces.ext.taglib.FocusTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class FocusTag
extends UIComponentELTag

Tag to set focus to a given field. Uses a single attribute, for, which is the id of the field which should receive the focus.

Author:

driscoll

Field Summary

Fields

Modifier and Type	Field and Description
javax.el.ValueExpression	forID

Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase

bodyContent, pageContext, UNIQUE_ID_PREFIX

Fields inherited from class javax.faces.webapp.UIComponentTagBase

log

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

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

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

EVAL_BODY_AGAIN

Constructor Summary

Constructors

Constructor and Description
FocusTag()

Method Summary

Modifier and Type	Method and Description
String	getComponentType() Return the component type for the component that is or will be bound to this tag.
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.
void	release() Release any resources allocated during the execution of this tag handler.
void	setFor(javax.el.ValueExpression forID)
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.

Methods inherited from class javax.faces.webapp.UIComponentELTag

createComponent, getELContext, hasBinding, setBinding, setRendered

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase

addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, 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

Field Detail

forID

public javax.el.ValueExpression forID

Constructor Detail

FocusTag

public FocusTag()

Method Detail

getComponentType

public String getComponentType()

Description copied from class: UIComponentTagBase

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 UIComponentTagBase

Returns:

the component type

setProperties

protected void setProperties(UIComponent component)

Description copied from class: UIComponentELTag

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 UIComponentELTag

Parameters:

component - UIComponent whose properties are to be overridden

getRendererType

public String getRendererType()

Description copied from class: UIComponentTagBase

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 UIComponentTagBase

Returns:

the renderer type

release

public void release()

Description copied from class: UIComponentELTag

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 UIComponentELTag

setFor

public void setFor(javax.el.ValueExpression forID)