org.apache.myfaces.tobago.taglib.extension
Class InExtensionTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by org.apache.myfaces.tobago.taglib.extension.InExtensionTag
All Implemented Interfaces:
Serializable, BodyTag, IterationTag, JspTag, Tag, HasBinding, HasConverter, HasId, HasIdBindingAndRendered, HasLabel, HasLabelWidth, HasMarkup, HasOnchange, HasSuggestMethod, HasTabIndex, HasTip, HasValidator, HasValue, HasValueChangeListener, IsDisabled, IsFocus, IsPassword, IsReadonly, IsRendered, IsRequired

public class InExtensionTag
extends BodyTagSupport
implements HasValue, HasValueChangeListener, HasValidator, HasIdBindingAndRendered, HasConverter, IsReadonly, IsDisabled, HasOnchange, HasMarkup, IsRequired, HasTip, HasLabel, HasLabelWidth, IsPassword, IsFocus, HasSuggestMethod, HasTabIndex

Renders a text input field with a label.
Short syntax of:

 <tc:panel>
   <f:facet name="layout">
     <tc:gridLayout columns="fixed;*"/>
   </f:facet>
   <tc:label value="#{label}" for="@auto"/>
   <tc:in value="#{value}">
     ...
   </tc:in>
 </tc:panel>
 

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
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
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
InExtensionTag()
           
 
Method Summary
 int doEndTag()
           
 int doStartTag()
           
 void release()
           
 void setBinding(String binding)
          The value binding expression linking this component to a property in a backing bean.
 void setConverter(String converter)
          An expression that specifies the Converter for this component.
 void setDisabled(String disabled)
          Flag indicating that this element is disabled.
 void setFocus(String focus)
          Flag indicating this component should recieve the focus.
 void setLabel(String label)
          Text value to display as label.
 void setLabelWidth(String labelWidth)
          The width for the label component.
 void setMarkup(String markup)
          Indicate markup of this component.
 void setOnchange(String onchange)
          Clientside script function to add to this component's onchange handler.
 void setPassword(String password)
          Flag indicating whether or not this component should be rendered as password field , so you will not see the typed charakters.
 void setReadonly(String readonly)
          Flag indicating that this component will prohibit changes by the user.
 void setRendered(String rendered)
          Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
 void setRequired(String required)
          Flag indicating that a value is required.
 void setSuggestMethod(String suggestMethod)
          MethodBinding which generates a list of suggested input values based on a passed prefix -- the currently entered text.
 void setTabIndex(String tabIndex)
          Controls the navigation of the focus through the input controls on a page with the Tab-Key.
 void setTip(String tip)
          Text value to display as tooltip.
 void setValidator(String validator)
          A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.
 void setValue(String value)
          The current value of this component.
 void setValueChangeListener(String valueChangeListener)
          MethodBinding representing a value change listener method that will be notified when a new value has been set for this input component.
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasId
setId
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Constructor Detail

InExtensionTag

public InExtensionTag()
Method Detail

doStartTag

public int doStartTag()
               throws JspException
Specified by:
doStartTag in interface Tag
Overrides:
doStartTag in class BodyTagSupport
Throws:
JspException

doEndTag

public int doEndTag()
             throws JspException
Specified by:
doEndTag in interface Tag
Overrides:
doEndTag in class BodyTagSupport
Throws:
JspException

release

public void release()
Specified by:
release in interface Tag
Overrides:
release in class BodyTagSupport

setMarkup

public void setMarkup(String markup)
Description copied from interface: HasMarkup
Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme.

Specified by:
setMarkup in interface HasMarkup

setValue

public void setValue(String value)
Description copied from interface: HasValue
The current value of this component.

Specified by:
setValue in interface HasValue

setValueChangeListener

public void setValueChangeListener(String valueChangeListener)
Description copied from interface: HasValueChangeListener
MethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.

Specified by:
setValueChangeListener in interface HasValueChangeListener

setLabel

public void setLabel(String label)
Description copied from interface: HasLabel
Text value to display as label. If text contains an underscore the next character is used as accesskey.

Specified by:
setLabel in interface HasLabel

setFocus

public void setFocus(String focus)
Description copied from interface: IsFocus
Flag indicating this component should recieve the focus.

Specified by:
setFocus in interface IsFocus

setBinding

public void setBinding(String binding)
Description copied from interface: HasBinding
The value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:

Specified by:
setBinding in interface HasBinding

setRendered

public void setRendered(String rendered)
Description copied from interface: IsRendered
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.

Specified by:
setRendered in interface IsRendered

setConverter

public void setConverter(String converter)
Description copied from interface: HasConverter
An expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.

Specified by:
setConverter in interface HasConverter

setOnchange

public void setOnchange(String onchange)
Description copied from interface: HasOnchange
Clientside script function to add to this component's onchange handler.

Specified by:
setOnchange in interface HasOnchange

setSuggestMethod

public void setSuggestMethod(String suggestMethod)
Description copied from interface: HasSuggestMethod
MethodBinding which generates a list of suggested input values based on a passed prefix -- the currently entered text. The expression has to evaluate to a public method which has a String parameter and a List<String> as return type.

Specified by:
setSuggestMethod in interface HasSuggestMethod

setValidator

public void setValidator(String validator)
Description copied from interface: HasValidator
A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.

Specified by:
setValidator in interface HasValidator

setPassword

public void setPassword(String password)
Description copied from interface: IsPassword
Flag indicating whether or not this component should be rendered as password field , so you will not see the typed charakters.

Specified by:
setPassword in interface IsPassword

setReadonly

public void setReadonly(String readonly)
Description copied from interface: IsReadonly
Flag indicating that this component will prohibit changes by the user.

Specified by:
setReadonly in interface IsReadonly

setDisabled

public void setDisabled(String disabled)
Description copied from interface: IsDisabled
Flag indicating that this element is disabled.

Specified by:
setDisabled in interface IsDisabled

setRequired

public void setRequired(String required)
Description copied from interface: IsRequired
Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.

Specified by:
setRequired in interface IsRequired

setTip

public void setTip(String tip)
Description copied from interface: HasTip
Text value to display as tooltip.

Specified by:
setTip in interface HasTip

setLabelWidth

public void setLabelWidth(String labelWidth)
Description copied from interface: HasLabelWidth
The width for the label component. Default: 'fixed'. This value is used in the gridLayouts columns attribute. See gridLayout tag for valid values.

Specified by:
setLabelWidth in interface HasLabelWidth

setTabIndex

public void setTabIndex(String tabIndex)
Description copied from interface: HasTabIndex
Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.

Specified by:
setTabIndex in interface HasTabIndex


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.