Interface HTMLInputElement

All Superinterfaces:
Element, EventTarget, HTMLElement, InnerHTML, Node, NonDocumentTypeChildNode, ParentNode
All Known Implementing Classes:
HTMLInputElementImpl

public interface HTMLInputElement extends HTMLElement
Provides special properties and methods for manipulating the options, layout, and presentation of <input> elements.
  • Method Details

    • getAccept

      String getAccept()
      Sets or retrieves a comma-separated list of content types.
      Returns:
      a String object.
    • setAccept

      void setAccept(String accept)

      setAccept.

      Parameters:
      accept - a String object.
    • getAlign

      @Deprecated String getAlign()
      Deprecated.
      Sets or retrieves how the object is aligned with adjacent text.
      Returns:
      a String object.
    • setAlign

      @Deprecated void setAlign(String align)
      Deprecated.

      setAlign.

      Parameters:
      align - a String object.
    • getAlt

      String getAlt()
      Sets or retrieves a text alternative to the graphic.
      Returns:
      a String object.
    • setAlt

      void setAlt(String alt)

      setAlt.

      Parameters:
      alt - a String object.
    • isAutocomplete

      boolean isAutocomplete()
      Specifies whether autocomplete is applied to an editable text field.
      Returns:
      a boolean.
    • setAutocomplete

      void setAutocomplete(String autocomplete)

      setAutocomplete.

      Parameters:
      autocomplete - a String object.
    • isAutofocus

      boolean isAutofocus()
      Provides a way to direct a user to a specific field when a document loads. This can provide both direction and convenience for a user, reducing the need to click or tab to a field when a page opens. This attribute is true when present on an element, and false when missing.
      Returns:
      a boolean.
    • setAutofocus

      void setAutofocus(boolean autofocus)

      setAutofocus.

      Parameters:
      autofocus - a boolean.
    • isChecked

      boolean isChecked()
      Sets or retrieves the state of the check box or radio button.
      Returns:
      a boolean.
    • setChecked

      void setChecked(boolean checked)

      setChecked.

      Parameters:
      checked - a boolean.
    • isDefaultChecked

      boolean isDefaultChecked()
      Sets or retrieves the state of the check box or radio button.
      Returns:
      a boolean.
    • setDefaultChecked

      void setDefaultChecked(boolean defaultChecked)

      setDefaultChecked.

      Parameters:
      defaultChecked - a boolean.
    • getDefaultValue

      String getDefaultValue()
      Sets or retrieves the initial contents of the object.
      Returns:
      a String object.
    • setDefaultValue

      void setDefaultValue(String defaultValue)

      setDefaultValue.

      Parameters:
      defaultValue - a String object.
    • getDirName

      String getDirName()

      getDirName.

      Returns:
      a String object.
    • setDirName

      void setDirName(String dirName)

      setDirName.

      Parameters:
      dirName - a String object.
    • isDisabled

      boolean isDisabled()

      isDisabled.

      Returns:
      a boolean.
    • setDisabled

      void setDisabled(boolean disabled)

      setDisabled.

      Parameters:
      disabled - a boolean.
    • getForm

      HTMLFormElement getForm()
      Retrieves a reference to the form that the object is embedded in.
      Returns:
      a HTMLFormElement object.
    • getFormAction

      String getFormAction()
      Overrides the action attribute (where the data on a form is sent) on the parent form element.
      Returns:
      a String object.
    • setFormAction

      void setFormAction(String formAction)

      setFormAction.

      Parameters:
      formAction - a String object.
    • getFormEnctype

      String getFormEnctype()
      Used to override the encoding (formEnctype attribute) specified on the form element.
      Returns:
      a String object.
    • setFormEnctype

      void setFormEnctype(String formEnctype)

      setFormEnctype.

      Parameters:
      formEnctype - a String object.
    • getFormMethod

      String getFormMethod()
      Overrides the submit method attribute previously specified on a form element.
      Returns:
      a String object.
    • setFormMethod

      void setFormMethod(String formMethod)

      setFormMethod.

      Parameters:
      formMethod - a String object.
    • isFormNoValidate

      boolean isFormNoValidate()
      Overrides any validation or required attributes on a form or form elements to allow it to be submitted without validation. This can be used to create a "save draft"-type submit option.
      Returns:
      a boolean.
    • setFormNoValidate

      void setFormNoValidate(boolean formNoValidate)

      setFormNoValidate.

      Parameters:
      formNoValidate - a boolean.
    • getFormTarget

      String getFormTarget()
      Overrides the target attribute on a form element.
      Returns:
      a String object.
    • setFormTarget

      void setFormTarget(String formTarget)

      setFormTarget.

      Parameters:
      formTarget - a String object.
    • getHeight

      double getHeight()
      Sets or retrieves the height of the object.
      Returns:
      a double.
    • setHeight

      void setHeight(double height)

      setHeight.

      Parameters:
      height - a double.
    • isIndeterminate

      boolean isIndeterminate()

      isIndeterminate.

      Returns:
      a boolean.
    • setIndeterminate

      void setIndeterminate(boolean indeterminate)

      setIndeterminate.

      Parameters:
      indeterminate - a boolean.
    • getLabels

      NodeList getLabels()

      getLabels.

      Returns:
      a NodeList object.
    • getList

      HTMLElement getList()
      Specifies the ID of a pre-defined datalist of options for an input element.
      Returns:
      a HTMLElement object.
    • getMax

      String getMax()
      Defines the maximum acceptable value for an input element with type="number".When used with the min and step attributes, lets you control the range and increment (such as only even numbers) that the user can enter into an input field.
      Returns:
      a String object.
    • setMax

      void setMax(String max)

      setMax.

      Parameters:
      max - a String object.
    • getMaxLength

      int getMaxLength()
      Sets or retrieves the maximum number of characters that the user can enter in a text control.
      Returns:
      a Integer object.
    • setMaxLength

      void setMaxLength(int maxLength)

      setMaxLength.

      Parameters:
      maxLength - a Integer object.
    • getMin

      String getMin()
      Defines the minimum acceptable value for an input element with type="number". When used with the max and step attributes, lets you control the range and increment (such as even numbers only) that the user can enter into an input field.
      Returns:
      a String object.
    • setMin

      void setMin(String min)

      setMin.

      Parameters:
      min - a String object.
    • getMinLength

      int getMinLength()

      getMinLength.

      Returns:
      a Integer object.
    • setMinLength

      void setMinLength(int minLength)

      setMinLength.

      Parameters:
      minLength - a Integer object.
    • isMultiple

      boolean isMultiple()
      Sets or retrieves the Boolean value indicating whether multiple items can be selected from a list.
      Returns:
      a boolean.
    • setMultiple

      void setMultiple(boolean multiple)

      setMultiple.

      Parameters:
      multiple - a boolean.
    • getName

      String getName()
      Sets or retrieves the name of the object.
      Returns:
      a String object.
    • setName

      void setName(String name)

      setName.

      Parameters:
      name - a String object.
    • getPattern

      String getPattern()
      Gets or sets a string containing a regular expression that the user's input must match.
      Returns:
      a String object.
    • setPattern

      void setPattern(String pattern)

      setPattern.

      Parameters:
      pattern - a String object.
    • getPlaceholder

      String getPlaceholder()
      Gets or sets a text string that is displayed in an input field as a hint or prompt to users as the format or type of information they need to enter.The text appears in an input field until the user puts focus on the field.
      Returns:
      a String object.
    • setPlaceholder

      void setPlaceholder(String placeholder)

      setPlaceholder.

      Parameters:
      placeholder - a String object.
    • isReadOnly

      boolean isReadOnly()

      isReadOnly.

      Returns:
      a boolean.
    • setReadOnly

      void setReadOnly(boolean readOnly)

      setReadOnly.

      Parameters:
      readOnly - a boolean.
    • isRequired

      boolean isRequired()
      When present, marks an element that can't be submitted without a value.
      Returns:
      a boolean.
    • setRequired

      void setRequired(boolean required)

      setRequired.

      Parameters:
      required - a boolean.
    • getSelectionDirection

      String getSelectionDirection()

      getSelectionDirection.

      Returns:
      a String object.
    • setSelectionDirection

      void setSelectionDirection(String selectionDirection)

      setSelectionDirection.

      Parameters:
      selectionDirection - a String object.
    • getSelectionEnd

      int getSelectionEnd()
      Gets or sets the end position or offset of a text selection.
      Returns:
      a Integer object.
    • setSelectionEnd

      void setSelectionEnd(int selectionEnd)

      setSelectionEnd.

      Parameters:
      selectionEnd - a Integer object.
    • getSelectionStart

      int getSelectionStart()
      Gets or sets the starting position or offset of a text selection.
      Returns:
      a Integer object.
    • setSelectionStart

      void setSelectionStart(int selectionStart)

      setSelectionStart.

      Parameters:
      selectionStart - a Integer object.
    • getSize

      int getSize()

      getSize.

      Returns:
      a Integer object.
    • setSize

      void setSize(int size)

      setSize.

      Parameters:
      size - a Integer object.
    • getSrc

      String getSrc()
      The address or URL of the a media resource that is to be considered.
      Returns:
      a String object.
    • setSrc

      void setSrc(String src)

      setSrc.

      Parameters:
      src - a String object.
    • getStep

      String getStep()
      Defines an increment or jump between values that you want to allow the user to enter. When used with the max and min attributes, lets you control the range and increment (for example, allow only even numbers) that the user can enter into an input field.
      Returns:
      a String object.
    • setStep

      void setStep(String step)

      setStep.

      Parameters:
      step - a String object.
    • getType

      String getType()
      Returns the content type of the object.
      Returns:
      a String object.
    • setType

      void setType(String type)

      setType.

      Parameters:
      type - a String object.
    • getUseMap

      @Deprecated String getUseMap()
      Deprecated.
      Sets or retrieves the URL, often with a bookmark extension (#name), to use as a client-side image map.
      Returns:
      a String object.
    • setUseMap

      void setUseMap(String useMap)

      setUseMap.

      Parameters:
      useMap - a String object.
    • getValidationMessage

      String getValidationMessage()
      Returns the error message that would be displayed if the user submits the form, or an empty string if no error message. It also triggers the standard error message, such as "this is a required field". The result is that the user sees validation messages without actually submitting.
      Returns:
      a String object.
    • getValidity

      ValidityState getValidity()
      Returns a ValidityState object that represents the validity states of an element.
      Returns:
      a ValidityState object.
    • getValue

      String getValue()
      Returns the value of the data at the cursor's current position.
      Returns:
      a String object.
    • setValue

      void setValue(String value)

      setValue.

      Parameters:
      value - a String object.
    • getValueAsNumber

      double getValueAsNumber()
      Returns the input field value as a number.
      Returns:
      a double.
    • setValueAsNumber

      void setValueAsNumber(double valueAsNumber)

      setValueAsNumber.

      Parameters:
      valueAsNumber - a double.
    • getWidth

      double getWidth()
      Sets or retrieves the width of the object.
      Returns:
      a double.
    • setWidth

      void setWidth(double width)

      setWidth.

      Parameters:
      width - a double.
    • isWillValidate

      boolean isWillValidate()
      Returns whether an element will successfully validate based on forms validation rules and constraints.
      Returns:
      a boolean.
    • checkValidity

      boolean checkValidity()
      Returns whether a form will validate when it is submitted, without having to submit it.
      Returns:
      a boolean.
    • reportValidity

      boolean reportValidity()

      reportValidity.

      Returns:
      a boolean.
    • select

      void select()
      Makes the selection equal to the current object.
    • setCustomValidity

      void setCustomValidity(String error)
      Sets a custom error message that is displayed when a form is submitted.
      Parameters:
      error - Sets a custom error message that is displayed when a form is submitted.
    • setRangeText

      void setRangeText(String replacement)

      setRangeText.

      Parameters:
      replacement - a String object.
    • setRangeText

      void setRangeText(String replacement, int start, int end)

      setRangeText.

      Parameters:
      replacement - a String object.
      start - a Integer object.
      end - a Integer object.
    • setRangeText

      void setRangeText(String select, int start, int end, String preserve)

      setRangeText.

      Parameters:
      select - a String object.
      start - a Integer object.
      end - a Integer object.
      preserve - a String object.
    • setSelectionRange

      void setSelectionRange(int start, int end, Direction direction)
      Sets the start and end positions of a selection in a text field.
      Parameters:
      start - The offset into the text field for the start of the selection.
      end - The offset into the text field for the end of the selection.
      direction - The direction in which the selection is performed.
    • setSelectionRange

      void setSelectionRange(int start, int end)

      setSelectionRange.

      Parameters:
      start - a Integer object.
      end - a Integer object.
    • stepDown

      void stepDown(double n)
      Decrements a range input control's value by the value given by the Step attribute. If the optional parameter is used, it will decrement the input control's step value multiplied by the parameter's value.
      Parameters:
      n - Value to decrement the value by.
    • stepDown

      void stepDown()

      stepDown.

    • stepUp

      void stepUp(double n)
      Increments a range input control's value by the value given by the Step attribute. If the optional parameter is used, will increment the input control's value by that value.
      Parameters:
      n - Value to increment the value by.
    • stepUp

      void stepUp()

      stepUp.