org.apache.myfaces.component.html.ext
Class HtmlInputText

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.html.HtmlInputText
                      org.apache.myfaces.component.html.ext.AbstractHtmlInputText
                          org.apache.myfaces.component.html.ext.HtmlInputText

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, AlignProperty, DataProperties, DisplayValueOnlyAware, ForceIdAware, UserRoleAware, DisplayValueOnlyCapable

Direct Known Subclasses:

AbstractHtmlInputCalendar, AbstractHtmlInputTextHelp, InputHtml

public class HtmlInputText
extends AbstractHtmlInputText

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER_TYPE

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR

Constructor Summary

HtmlInputText()

Method Summary

String	getAlign() HTML: Specifies the horizontal alignment of this element.
String	getAutocomplete() Non HTML standard attribute to disable browser's autocomplete function.
String	getDatafld() Reserved for future use.
String	getDataformatas() Reserved for future use.
String	getDatasrc() Reserved for future use.
Boolean	getDisplayValueOnly() If true, renders only the value of the component, but no input widget.
String	getDisplayValueOnlyStyle() Style used when displayValueOnly is true.
String	getDisplayValueOnlyStyleClass() Style class used when displayValueOnly is true.
String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
String	getFamily()
String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
boolean	isDisabledOnClientSide() If true the input is rendered disabled on the client side and a hidden input is used to actualy submit his value back to the server.
boolean	isForceId() If true, this component will force the use of the specified id when rendering.
boolean	isForceIdIndex() If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
void	restoreState(javax.faces.context.FacesContext facesContext, Object state)
Object	saveState(javax.faces.context.FacesContext facesContext)
void	setAlign(String align)
void	setAutocomplete(String autocomplete)
void	setDatafld(String datafld)
void	setDataformatas(String dataformatas)
void	setDatasrc(String datasrc)
void	setDisabledOnClientSide(boolean disabledOnClientSide)
void	setDisplayValueOnly(Boolean displayValueOnly)
void	setDisplayValueOnlyStyle(String displayValueOnlyStyle)
void	setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)
void	setEnabledOnUserRole(String enabledOnUserRole)
void	setForceId(boolean forceId)
void	setForceIdIndex(boolean forceIdIndex)
void	setVisibleOnUserRole(String visibleOnUserRole)

Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlInputText

getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly

Methods inherited from class javax.faces.component.html.HtmlInputText

getAccesskey, getAlt, getDir, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setAlt, setDir, setDisabled, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setSize, setStyle, setStyleClass, setTabindex, setTitle

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlInputText

public HtmlInputText()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

isDisabledOnClientSide

public boolean isDisabledOnClientSide()

Description copied from class: AbstractHtmlInputText

If true the input is rendered disabled on the client side and a hidden input is used to actualy submit his value back to the server.

Specified by:

isDisabledOnClientSide in class AbstractHtmlInputText

setDisabledOnClientSide

public void setDisabledOnClientSide(boolean disabledOnClientSide)

getAutocomplete

public String getAutocomplete()

Description copied from class: AbstractHtmlInputText

Non HTML standard attribute to disable browser's autocomplete function.

Specified by:

getAutocomplete in class AbstractHtmlInputText

setAutocomplete

public void setAutocomplete(String autocomplete)

getDisplayValueOnly

public Boolean getDisplayValueOnly()

Description copied from interface: DisplayValueOnlyAware

If true, renders only the value of the component, but no input widget. Default is false.

setDisplayValueOnly

public void setDisplayValueOnly(Boolean displayValueOnly)

getDisplayValueOnlyStyle

public String getDisplayValueOnlyStyle()

Description copied from interface: DisplayValueOnlyAware

Style used when displayValueOnly is true.

setDisplayValueOnlyStyle

public void setDisplayValueOnlyStyle(String displayValueOnlyStyle)

getDisplayValueOnlyStyleClass

public String getDisplayValueOnlyStyleClass()

Description copied from interface: DisplayValueOnlyAware

Style class used when displayValueOnly is true.

setDisplayValueOnlyStyleClass

public void setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)

getEnabledOnUserRole

public String getEnabledOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)

getVisibleOnUserRole

public String getVisibleOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)

isForceId

public boolean isForceId()

Description copied from interface: ForceIdAware

If true, this component will force the use of the specified id when rendering.

Returns:

setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()

Description copied from interface: ForceIdAware

If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Returns:

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

getDatafld

public String getDatafld()

Description copied from interface: DataProperties

Reserved for future use.

setDatafld

public void setDatafld(String datafld)

getDatasrc

public String getDatasrc()

Description copied from interface: DataProperties

Reserved for future use.

setDatasrc

public void setDatasrc(String datasrc)

getDataformatas

public String getDataformatas()

Description copied from interface: DataProperties

Reserved for future use.

setDataformatas

public void setDataformatas(String dataformatas)

getAlign

public String getAlign()

Description copied from interface: AlignProperty

HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.

setAlign

public void setAlign(String align)

saveState

public Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.html.HtmlInputText

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.html.HtmlInputText