Package org.primefaces.extensions.component.inputotp

Class InputOtp

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.primefaces.component.api.AbstractPrimeHtmlInputText
org.primefaces.extensions.component.inputotp.InputOtp
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.primefaces.component.api.InputHolder, org.primefaces.component.api.RTLAware, org.primefaces.component.api.Widget
public class InputOtp extends org.primefaces.component.api.AbstractPrimeHtmlInputText implements org.primefaces.component.api.Widget, org.primefaces.component.api.InputHolder, org.primefaces.component.api.RTLAware
InputOtp component.
Since:
14.0.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    InputOtp.PropertyKeys
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CELL_STYLE_CLASS
     
    static final String
    COMPONENT_FAMILY
     
    static final String
    COMPONENT_TYPE
     
    static final String
    DEFAULT_RENDERER
     
    static final String
    HIDDEN_SUFFIX
     
    static final List<String>
    INPUT_OTP_ATTRIBUTES_WITHOUT_EVENTS
     
    static final String
    INPUT_SUFFIX
     
    static final String
    RTL_STYLE_CLASS
     
    static final String
    SEPARATOR_STYLE_CLASS
     
    static final String
    STYLE_CLASS
     

    Fields inherited from class org.primefaces.component.api.AbstractPrimeHtmlInputText

    EVENT_NAMES

    Fields inherited from class javax.faces.component.UIInput

    ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

    Fields inherited from class javax.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

    Fields inherited from interface org.primefaces.component.api.Widget

    ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

  • Constructor Summary

    Constructors
    Constructor
    Description
    InputOtp()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAriaLabel()
     
    String
    getAutocomplete()
     
    String
    getFamily()
     
    String
    getInputClientId()
     
    String
    getInputStyle()
     
    String
    getInputStyleClass()
     
    String
    getLabelledBy()
     
    int
    getLength()
     
    String
    getPlaceholder()
     
    String
    getSeparator()
     
    String
    getValidatableInputClientId()
     
    boolean
    isIntegerOnly()
     
    boolean
    isMask()
     
    void
    setAriaLabel(String ariaLabel)
     
    void
    setInputStyle(String inputStyle)
     
    void
    setInputStyleClass(String inputStyleClass)
     
    void
    setIntegerOnly(boolean integerOnly)
     
    void
    setLabelledBy(String labelledBy)
     
    void
    setLength(int length)
     
    void
    setMask(boolean mask)
     
    void
    setPlaceholder(String placeholder)
     
    void
    setSeparator(String separator)
     
    protected void
    validateValue(javax.faces.context.FacesContext context, Object newValue)
     

    Methods inherited from class org.primefaces.component.api.AbstractPrimeHtmlInputText

    getEventNames, getInputmode, getOncontextmenu, getOncopy, getOncut, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOninput, getOninvalid, getOnpaste, getOnreset, getOnscroll, getOnsearch, getOnwheel, setInputmode, setOncontextmenu, setOncopy, setOncut, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOninput, setOninvalid, setOnpaste, setOnreset, setOnscroll, setOnsearch, setOnwheel

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

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

    Methods inherited from class javax.faces.component.UIInput

    addValidator, addValueChangeListener, 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

    Methods inherited from class javax.faces.component.UIOutput

    getConverter, getLocalValue, setConverter

    Methods inherited from class javax.faces.component.UIComponentBase

    addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

    Methods inherited from class javax.faces.component.UIComponent

    encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

    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 org.primefaces.component.api.RTLAware

    getDir, isRTL

    Methods inherited from interface javax.faces.component.ValueHolder

    getConverter, getLocalValue, setConverter

    Methods inherited from interface org.primefaces.component.api.Widget

    resolveWidgetVar, resolveWidgetVar

  • Field Details

  • Constructor Details

    • InputOtp

      public InputOtp()

  • Method Details

    • getFamily

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

    • getInputClientId

      public String getInputClientId()
      Specified by:
      getInputClientId in interface org.primefaces.component.api.InputHolder

    • getValidatableInputClientId

      public String getValidatableInputClientId()
      Specified by:
      getValidatableInputClientId in interface org.primefaces.component.api.InputHolder

    • getLabelledBy

      public String getLabelledBy()
      Specified by:
      getLabelledBy in interface org.primefaces.component.api.InputHolder

    • setLabelledBy

      public void setLabelledBy(String labelledBy)
      Specified by:
      setLabelledBy in interface org.primefaces.component.api.InputHolder

    • getPlaceholder

      public String getPlaceholder()

    • setPlaceholder

      public void setPlaceholder(String placeholder)

    • getAutocomplete

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

    • isIntegerOnly

      public boolean isIntegerOnly()

    • setIntegerOnly

      public void setIntegerOnly(boolean integerOnly)

    • getInputStyle

      public String getInputStyle()

    • setInputStyle

      public void setInputStyle(String inputStyle)

    • getInputStyleClass

      public String getInputStyleClass()

    • setInputStyleClass

      public void setInputStyleClass(String inputStyleClass)

    • getSeparator

      public String getSeparator()

    • setSeparator

      public void setSeparator(String separator)

    • getAriaLabel

      public String getAriaLabel()

    • setAriaLabel

      public void setAriaLabel(String ariaLabel)

    • getLength

      public int getLength()

    • setLength

      public void setLength(int length)

    • isMask

      public boolean isMask()

    • setMask

      public void setMask(boolean mask)

    • validateValue

      protected void validateValue(javax.faces.context.FacesContext context, Object newValue)
      Overrides:
      validateValue in class javax.faces.component.UIInput