org.apache.myfaces.tobago.component
Class UIIn

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  org.apache.myfaces.tobago.internal.component.AbstractUIInput
                      org.apache.myfaces.tobago.component.UIIn

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, InputSuggest, InputSuggest2, SupportsMarkup, UIInput, Configurable, LayoutBase, LayoutComponent

public class UIIn
extends AbstractUIInput
implements InputSuggest2, UIInput, SupportsMarkup, InputSuggest

Renders a text input field. UIComponent class, generated from template component1.2.stg with class InTagDeclaration.

Field Summary

static String

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UIIn()

Method Summary

Integer	getColumnSpan()
Measure	getCurrentHeight() This value will usually be set by the layout manager.
Markup	getCurrentMarkup()
Measure	getCurrentWidth() This value will usually be set by the layout manager.
Display	getDisplay() This attribute is for internal use only.
Measure	getHeight() This value will usually be set by the layout manager.
Integer	getHorizontalIndex() This attribute is for internal use only.
String	getLabel() A localized user presentable name for this component.
Measure	getLeft() This value will usually be set by the layout manager.
Measure	getMarginBottom()
Measure	getMarginLeft()
Measure	getMarginRight()
Measure	getMarginTop()
Markup	getMarkup()
Measure	getMaximumHeight()
Measure	getMaximumWidth()
Measure	getMinimumHeight()
Measure	getMinimumWidth()
String	getOnchange() Clientside script function to add to this component's onchange handler.
String	getPlaceholder() Displays a short text in the input field, that describes the meaning of this field.
Measure	getPreferredHeight()
Measure	getPreferredWidth()
Integer	getRowSpan()
Integer	getSuggestDelay() Time in milli seconds before the list will be requested.
javax.faces.el.MethodBinding	getSuggestMethod()
javax.el.MethodExpression	getSuggestMethodExpression()
Integer	getSuggestMinChars() Minimum number of chars to type before the list will be requested.
Integer	getTabIndex() Controls the navigation of the focus through the input controls on a page with the Tab-Key.
String	getTip() Text value to display as tooltip.
Measure	getTop() This value will usually be set by the layout manager.
Integer	getVerticalIndex() This attribute is for internal use only.
Measure	getWidth() This value will usually be set by the layout manager.
boolean	isDisabled() Flag indicating that this element is disabled.
boolean	isFocus() Flag indicating this component should receive the focus.
boolean	isInline() Deprecated.
boolean	isPassword() Flag indicating whether or not this component should be rendered as password field , so you will not see the typed charakters.
boolean	isReadonly() Flag indicating that this component will prohibit changes by the user.
boolean	isRequired() Flag indicating that a value is required.
void	restoreState(javax.faces.context.FacesContext context, Object componentState)
Object	saveState(javax.faces.context.FacesContext context)
void	setColumnSpan(Integer columnSpan)
void	setCurrentHeight(Measure currentHeight)
void	setCurrentMarkup(Markup currentMarkup)
void	setCurrentWidth(Measure currentWidth)
void	setDisabled(boolean disabled)
void	setDisplay(Display display)
void	setFocus(boolean focus)
void	setHeight(Measure height)
void	setHorizontalIndex(Integer horizontalIndex)
void	setInline(boolean inline) Deprecated.
void	setLabel(String label)
void	setLeft(Measure left)
void	setMarginBottom(Measure marginBottom)
void	setMarginLeft(Measure marginLeft)
void	setMarginRight(Measure marginRight)
void	setMarginTop(Measure marginTop)
void	setMarkup(Markup markup)
void	setMaximumHeight(Measure maximumHeight)
void	setMaximumWidth(Measure maximumWidth)
void	setMinimumHeight(Measure minimumHeight)
void	setMinimumWidth(Measure minimumWidth)
void	setOnchange(String onchange)
void	setPassword(boolean password)
void	setPlaceholder(String placeholder)
void	setPreferredHeight(Measure preferredHeight)
void	setPreferredWidth(Measure preferredWidth)
void	setReadonly(boolean readonly)
void	setRequired(boolean required)
void	setRowSpan(Integer rowSpan)
void	setSuggestDelay(Integer suggestDelay)
void	setSuggestMethod(javax.faces.el.MethodBinding suggestMethod)
void	setSuggestMethodExpression(javax.el.MethodExpression suggestMethodExpression)
void	setSuggestMinChars(Integer suggestMinChars)
void	setTabIndex(Integer tabIndex)
void	setTip(String tip)
void	setTop(Measure top)
void	setVerticalIndex(Integer verticalIndex)
void	setWidth(Measure width)

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIInput

updateModel

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getConverterMessage, getFamily, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, 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, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getValueExpression, setValueExpression

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.component.UIInput

broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacets, getFacetsAndChildren, getFamily, getId, getParent, getRendererType, getRendersChildren, getValueBinding, isRendered, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, setId, setParent, setRendered, setRendererType, setValueBinding

Methods inherited from interface javax.faces.component.StateHolder

isTransient, setTransient

Methods inherited from interface javax.faces.component.EditableValueHolder

addValidator, addValueChangeListener, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isValid, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setSubmittedValue, setValid, setValidator, setValueChangeListener

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from interface org.apache.myfaces.tobago.layout.LayoutComponent

isRendered

Methods inherited from interface org.apache.myfaces.tobago.config.Configurable

getRendererType

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIIn

public UIIn()

Method Detail

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface SupportsMarkup

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface SupportsMarkup

getMarginLeft

public Measure getMarginLeft()

Specified by:

getMarginLeft in interface LayoutBase

setMarginLeft

public void setMarginLeft(Measure marginLeft)

Specified by:

setMarginLeft in interface LayoutBase

getTabIndex

public Integer getTabIndex()

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:

getTabIndex in class AbstractUIInput

setTabIndex

public void setTabIndex(Integer tabIndex)

getMinimumHeight

public Measure getMinimumHeight()

Specified by:

getMinimumHeight in interface LayoutBase

setMinimumHeight

public void setMinimumHeight(Measure minimumHeight)

Specified by:

setMinimumHeight in interface LayoutBase

isPassword

public boolean isPassword()

Flag indicating whether or not this component should be rendered as password field , so you will not see the typed charakters.
Default: false

setPassword

public void setPassword(boolean password)

getTip

public String getTip()

Text value to display as tooltip.

setTip

public void setTip(String tip)

getSuggestMethod

public javax.faces.el.MethodBinding getSuggestMethod()

Specified by:

getSuggestMethod in interface InputSuggest

setSuggestMethod

public void setSuggestMethod(javax.faces.el.MethodBinding suggestMethod)

Specified by:

setSuggestMethod in interface InputSuggest

Specified by:

setSuggestMethod in interface UIInput

getSuggestMethodExpression

public javax.el.MethodExpression getSuggestMethodExpression()

Specified by:

getSuggestMethodExpression in interface InputSuggest2

setSuggestMethodExpression

public void setSuggestMethodExpression(javax.el.MethodExpression suggestMethodExpression)

Specified by:

setSuggestMethodExpression in interface InputSuggest2

getSuggestDelay

public Integer getSuggestDelay()

Time in milli seconds before the list will be requested.
Default: 500

setSuggestDelay

public void setSuggestDelay(Integer suggestDelay)

getHeight

public Measure getHeight()

This value will usually be set by the layout manager.

Specified by:

getHeight in interface LayoutBase

setHeight

public void setHeight(Measure height)

Specified by:

setHeight in interface LayoutBase

getMinimumWidth

public Measure getMinimumWidth()

Specified by:

getMinimumWidth in interface LayoutBase

setMinimumWidth

public void setMinimumWidth(Measure minimumWidth)

Specified by:

setMinimumWidth in interface LayoutBase

isInline

@Deprecated
public boolean isInline()

Deprecated.

Flag indicating this component should rendered as an inline element.
Default: false

setInline

@Deprecated
public void setInline(boolean inline)

Deprecated.

getRowSpan

public Integer getRowSpan()

Specified by:

getRowSpan in interface LayoutComponent

setRowSpan

public void setRowSpan(Integer rowSpan)

Specified by:

setRowSpan in interface LayoutComponent

getLeft

public Measure getLeft()

This value will usually be set by the layout manager.

Specified by:

getLeft in interface LayoutBase

setLeft

public void setLeft(Measure left)

Specified by:

setLeft in interface LayoutBase

isFocus

public boolean isFocus()

Flag indicating this component should receive the focus.
Default: false

setFocus

public void setFocus(boolean focus)

getColumnSpan

public Integer getColumnSpan()

Specified by:

getColumnSpan in interface LayoutComponent

setColumnSpan

public void setColumnSpan(Integer columnSpan)

Specified by:

setColumnSpan in interface LayoutComponent

getSuggestMinChars

public Integer getSuggestMinChars()

Minimum number of chars to type before the list will be requested.
Default: 2

setSuggestMinChars

public void setSuggestMinChars(Integer suggestMinChars)

isRequired

public boolean isRequired()

Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.
Default: false

Specified by:

isRequired in interface javax.faces.component.EditableValueHolder

Overrides:

isRequired in class javax.faces.component.UIInput

setRequired

public void setRequired(boolean required)

Specified by:

setRequired in interface javax.faces.component.EditableValueHolder

Overrides:

setRequired in class javax.faces.component.UIInput

getTop

public Measure getTop()

This value will usually be set by the layout manager.

Specified by:

getTop in interface LayoutBase

setTop

public void setTop(Measure top)

Specified by:

setTop in interface LayoutBase

getMaximumHeight

public Measure getMaximumHeight()

Specified by:

getMaximumHeight in interface LayoutBase

setMaximumHeight

public void setMaximumHeight(Measure maximumHeight)

Specified by:

setMaximumHeight in interface LayoutBase

getCurrentWidth

public Measure getCurrentWidth()

This value will usually be set by the layout manager. It holds the current width computed by the layout manager.

Specified by:

getCurrentWidth in interface LayoutBase

setCurrentWidth

public void setCurrentWidth(Measure currentWidth)

Specified by:

setCurrentWidth in interface LayoutBase

getMarginTop

public Measure getMarginTop()

Specified by:

getMarginTop in interface LayoutBase

setMarginTop

public void setMarginTop(Measure marginTop)

Specified by:

setMarginTop in interface LayoutBase

getPlaceholder

public String getPlaceholder()

Displays a short text in the input field, that describes the meaning of this field. This is part of HTML 5, the theme should emulate the behaviour, when the browser doesn't support it.

The text will not be displayed, when the input field is readonly or disabled.

Specified by:

getPlaceholder in class AbstractUIInput

setPlaceholder

public void setPlaceholder(String placeholder)

getWidth

public Measure getWidth()

This value will usually be set by the layout manager.

Specified by:

getWidth in interface LayoutBase

setWidth

public void setWidth(Measure width)

Specified by:

setWidth in interface LayoutBase

getMarginRight

public Measure getMarginRight()

Specified by:

getMarginRight in interface LayoutBase

setMarginRight

public void setMarginRight(Measure marginRight)

Specified by:

setMarginRight in interface LayoutBase

getPreferredHeight

public Measure getPreferredHeight()

Specified by:

getPreferredHeight in interface LayoutBase

setPreferredHeight

public void setPreferredHeight(Measure preferredHeight)

Specified by:

setPreferredHeight in interface LayoutBase

getCurrentHeight

public Measure getCurrentHeight()

This value will usually be set by the layout manager. It holds the current height computed by the layout manager.

Specified by:

getCurrentHeight in interface LayoutBase

setCurrentHeight

public void setCurrentHeight(Measure currentHeight)

Specified by:

setCurrentHeight in interface LayoutBase

getLabel

public String getLabel()

A localized user presentable name for this component.

setLabel

public void setLabel(String label)

getDisplay

public Display getDisplay()

This attribute is for internal use only.

Specified by:

getDisplay in interface LayoutComponent

setDisplay

public void setDisplay(Display display)

Specified by:

setDisplay in interface LayoutComponent

getMaximumWidth

public Measure getMaximumWidth()

Specified by:

getMaximumWidth in interface LayoutBase

setMaximumWidth

public void setMaximumWidth(Measure maximumWidth)

Specified by:

setMaximumWidth in interface LayoutBase

getOnchange

public String getOnchange()

Clientside script function to add to this component's onchange handler.

setOnchange

public void setOnchange(String onchange)

getPreferredWidth

public Measure getPreferredWidth()

Specified by:

getPreferredWidth in interface LayoutBase

setPreferredWidth

public void setPreferredWidth(Measure preferredWidth)

Specified by:

setPreferredWidth in interface LayoutBase

getMarginBottom

public Measure getMarginBottom()

Specified by:

getMarginBottom in interface LayoutBase

setMarginBottom

public void setMarginBottom(Measure marginBottom)

Specified by:

setMarginBottom in interface LayoutBase

getVerticalIndex

public Integer getVerticalIndex()

This attribute is for internal use only.

Specified by:

getVerticalIndex in interface LayoutComponent

setVerticalIndex

public void setVerticalIndex(Integer verticalIndex)

Specified by:

setVerticalIndex in interface LayoutComponent

getCurrentMarkup

public Markup getCurrentMarkup()

Specified by:

getCurrentMarkup in interface SupportsMarkup

Specified by:

getCurrentMarkup in interface Configurable

setCurrentMarkup

public void setCurrentMarkup(Markup currentMarkup)

Specified by:

setCurrentMarkup in interface SupportsMarkup

getHorizontalIndex

public Integer getHorizontalIndex()

This attribute is for internal use only.

Specified by:

getHorizontalIndex in interface LayoutComponent

setHorizontalIndex

public void setHorizontalIndex(Integer horizontalIndex)

Specified by:

setHorizontalIndex in interface LayoutComponent

isReadonly

public boolean isReadonly()

Flag indicating that this component will prohibit changes by the user.
Default: false

setReadonly

public void setReadonly(boolean readonly)

isDisabled

public boolean isDisabled()

Flag indicating that this element is disabled.
Default: false

setDisabled

public void setDisabled(boolean disabled)

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIInput

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIInput