org.apache.myfaces.html5.component.input
Class Html5BaseInputText

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by javax.faces.component.html.HtmlInputText
                      extended by org.apache.myfaces.html5.component.input.AbstractHtml5BaseInputText
                          extended by org.apache.myfaces.html5.component.input.Html5BaseInputText
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Draggable, Html5GlobalProperties, Html5InputProperties
Direct Known Subclasses:
AbstractHtmlInputColor, AbstractHtmlInputDateTime, AbstractHtmlInputEmail, AbstractHtmlInputNumberSlider, AbstractHtmlInputText

public class Html5BaseInputText
extends AbstractHtml5BaseInputText
implements javax.faces.component.behavior.ClientBehaviorHolder


Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIInput
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
Html5BaseInputText()
           
 
Method Summary
 String getAnimationEnd()
          HTML : Script to run when the animation ends on Html element.
 String getDataList()
          Id of <hx:datalist> or HTML <datalist> for suggestions mechanism.
 String getDefaultEventName()
           
 String getDir()
          HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 Collection<String> getEventNames()
           
 String getFamily()
           
 String getLang()
          HTML: The base language of this document.
 String getOndrag()
          HTML: Handler for event that is fired when the element is dragged.
 String getOndragend()
          HTML: Handler for event that is fired when the drag operation is ended.
 String getOndragenter()
          HTML: Handler for event that is fired when the element is dragged into a valid drop target.
 String getOndragleave()
          HTML: Handler for event that is fired when the element leaves a valid drop target.
 String getOndragover()
          HTML: Handler for event that is fired when the element is being dragged over a valid drop target.
 String getOndragstart()
          HTML: Handler for event that is fired when the drag operation starts.
 String getOndrop()
          HTML: Handler for event that is fired when the element is being dropped.
 String getOnformchange()
          HTML: Script to be invoked when the state of the owner form is changed.
 String getOnforminput()
          HTML: Script to be invoked when the owner form gets user input.
 String getOninput()
          HTML: Script to be invoked when the element gets user input.
 String getOninvalid()
          HTML: Script to be invoked when the owner form is validated and this element could not pass the validation.
 String getOnmousewheel()
          HTML: Script to be invoked when the pointing device is wheeled over this element.
 String getStyle()
          HTML: CSS styling instructions.
 String getStyleClass()
          The CSS class for this element.
 Object getSuggestions()
          Static(not Ajax) suggestion values.
 String getTitle()
          HTML: An advisory title for this element.
 boolean isAutoFocus()
          If this property is set to true, it will allow the user to just start typing without having to manually focus the main control when the page is loaded.
 boolean isDraggable()
          HTML: Specifies whether the element is draggable.
 boolean isHidden()
          HTML: Whether the element is relevant.
 void setAnimationEnd(String animationEnd)
           
 void setAutoFocus(boolean autoFocus)
           
 void setDataList(String dataList)
           
 void setDir(String dir)
           
 void setDraggable(boolean draggable)
           
 void setHidden(boolean hidden)
           
 void setLang(String lang)
           
 void setOndrag(String ondrag)
           
 void setOndragend(String ondragend)
           
 void setOndragenter(String ondragenter)
           
 void setOndragleave(String ondragleave)
           
 void setOndragover(String ondragover)
           
 void setOndragstart(String ondragstart)
           
 void setOndrop(String ondrop)
           
 void setOnformchange(String onformchange)
           
 void setOnforminput(String onforminput)
           
 void setOninput(String oninput)
           
 void setOninvalid(String oninvalid)
           
 void setOnmousewheel(String onmousewheel)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setSuggestions(Object suggestions)
           
 void setTitle(String title)
           
 
Methods inherited from class javax.faces.component.html.HtmlInputText
getAccesskey, getAlt, getAutocomplete, getLabel, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getTabindex, isDisabled, isReadonly, setAccesskey, setAlt, setAutocomplete, setDisabled, setLabel, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setSize, setTabindex
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
 
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.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
 
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
Constructor Detail

Html5BaseInputText

public Html5BaseInputText()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.html.HtmlInputText

getEventNames

public Collection<String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getEventNames in class javax.faces.component.html.HtmlInputText

getDefaultEventName

public String getDefaultEventName()
Specified by:
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getDefaultEventName in class javax.faces.component.html.HtmlInputText

getDir

public String getDir()
Description copied from interface: Html5GlobalProperties
HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Specified by:
getDir in interface Html5GlobalProperties
Overrides:
getDir in class javax.faces.component.html.HtmlInputText

setDir

public void setDir(String dir)
Overrides:
setDir in class javax.faces.component.html.HtmlInputText

getLang

public String getLang()
Description copied from interface: Html5GlobalProperties
HTML: The base language of this document.

Specified by:
getLang in interface Html5GlobalProperties
Overrides:
getLang in class javax.faces.component.html.HtmlInputText

setLang

public void setLang(String lang)
Overrides:
setLang in class javax.faces.component.html.HtmlInputText

getTitle

public String getTitle()
Description copied from interface: Html5GlobalProperties
HTML: An advisory title for this element. Often used by the user agent as a tooltip.

Specified by:
getTitle in interface Html5GlobalProperties
Overrides:
getTitle in class javax.faces.component.html.HtmlInputText

setTitle

public void setTitle(String title)
Overrides:
setTitle in class javax.faces.component.html.HtmlInputText

getStyle

public String getStyle()
Description copied from interface: Html5GlobalProperties
HTML: CSS styling instructions.

Specified by:
getStyle in interface Html5GlobalProperties
Overrides:
getStyle in class javax.faces.component.html.HtmlInputText

setStyle

public void setStyle(String style)
Overrides:
setStyle in class javax.faces.component.html.HtmlInputText

getStyleClass

public String getStyleClass()
Description copied from interface: Html5GlobalProperties
The CSS class for this element. Corresponds to the HTML 'class' attribute.

Specified by:
getStyleClass in interface Html5GlobalProperties
Overrides:
getStyleClass in class javax.faces.component.html.HtmlInputText

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class javax.faces.component.html.HtmlInputText

isHidden

public boolean isHidden()
Description copied from interface: Html5GlobalProperties
HTML: Whether the element is relevant.

Specified by:
isHidden in interface Html5GlobalProperties

setHidden

public void setHidden(boolean hidden)

isDraggable

public boolean isDraggable()
Description copied from interface: Html5GlobalProperties
HTML: Specifies whether the element is draggable.

Specified by:
isDraggable in interface Html5GlobalProperties

setDraggable

public void setDraggable(boolean draggable)
Specified by:
setDraggable in interface Draggable

getOndrag

public String getOndrag()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the element is dragged.

Specified by:
getOndrag in interface Html5GlobalProperties

setOndrag

public void setOndrag(String ondrag)

getOndragend

public String getOndragend()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the drag operation is ended. Successfully or not, this handler will run.

Specified by:
getOndragend in interface Html5GlobalProperties

setOndragend

public void setOndragend(String ondragend)

getOndragenter

public String getOndragenter()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the element is dragged into a valid drop target.

Specified by:
getOndragenter in interface Html5GlobalProperties

setOndragenter

public void setOndragenter(String ondragenter)

getOndragleave

public String getOndragleave()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the element leaves a valid drop target.

Specified by:
getOndragleave in interface Html5GlobalProperties

setOndragleave

public void setOndragleave(String ondragleave)

getOndragover

public String getOndragover()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the element is being dragged over a valid drop target.

Specified by:
getOndragover in interface Html5GlobalProperties

setOndragover

public void setOndragover(String ondragover)

getOndragstart

public String getOndragstart()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the drag operation starts.

Specified by:
getOndragstart in interface Html5GlobalProperties

setOndragstart

public void setOndragstart(String ondragstart)

getOndrop

public String getOndrop()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the element is being dropped.

Specified by:
getOndrop in interface Html5GlobalProperties

setOndrop

public void setOndrop(String ondrop)

getOnmousewheel

public String getOnmousewheel()
Description copied from interface: Html5GlobalProperties
HTML: Script to be invoked when the pointing device is wheeled over this element.

Specified by:
getOnmousewheel in interface Html5GlobalProperties

setOnmousewheel

public void setOnmousewheel(String onmousewheel)

getAnimationEnd

public String getAnimationEnd()
Description copied from interface: Html5GlobalProperties
HTML : Script to run when the animation ends on Html element.

Specified by:
getAnimationEnd in interface Html5GlobalProperties

setAnimationEnd

public void setAnimationEnd(String animationEnd)

isAutoFocus

public boolean isAutoFocus()
Description copied from interface: Html5InputProperties
If this property is set to true, it will allow the user to just start typing without having to manually focus the main control when the page is loaded. Default to false.

Specified by:
isAutoFocus in interface Html5InputProperties

setAutoFocus

public void setAutoFocus(boolean autoFocus)

getSuggestions

public Object getSuggestions()
Description copied from interface: Html5InputProperties
Static(not Ajax) suggestion values. This attribute should not be defined if "list" is set.

Specified by:
getSuggestions in interface Html5InputProperties
See Also:
property

setSuggestions

public void setSuggestions(Object suggestions)

getDataList

public String getDataList()
Description copied from interface: Html5InputProperties
Id of <hx:datalist> or HTML <datalist> for suggestions mechanism. By this way, suggestion options(datalist) can be shared across several input elements. If this attribute is set, other suggestion mechanisms(with f:selectItem(s) children or 'suggestions' attribute) should not be used

Specified by:
getDataList in interface Html5InputProperties

setDataList

public void setDataList(String dataList)

getOnformchange

public String getOnformchange()
Description copied from interface: Html5InputProperties
HTML: Script to be invoked when the state of the owner form is changed.

Specified by:
getOnformchange in interface Html5InputProperties

setOnformchange

public void setOnformchange(String onformchange)

getOnforminput

public String getOnforminput()
Description copied from interface: Html5InputProperties
HTML: Script to be invoked when the owner form gets user input.

Specified by:
getOnforminput in interface Html5InputProperties

setOnforminput

public void setOnforminput(String onforminput)

getOninput

public String getOninput()
Description copied from interface: Html5InputProperties
HTML: Script to be invoked when the element gets user input.

Specified by:
getOninput in interface Html5InputProperties

setOninput

public void setOninput(String oninput)

getOninvalid

public String getOninvalid()
Description copied from interface: Html5InputProperties
HTML: Script to be invoked when the owner form is validated and this element could not pass the validation.

Specified by:
getOninvalid in interface Html5InputProperties

setOninvalid

public void setOninvalid(String oninvalid)


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.