elemental.html.InputElement Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package elemental.html;
import elemental.dom.Element;
import elemental.events.EventListener;
import elemental.dom.NodeList;

import elemental.events.*;
import elemental.util.*;
import elemental.dom.*;
import elemental.html.*;
import elemental.css.*;
import elemental.stylesheets.*;

import java.util.Date;

/**
  * DOM Input objects expose the HTMLInputElement (or 
HTML 4 HTMLInputElement) interface, which provides special properties and methods (beyond the regular element object interface they also have available to them by inheritance) for manipulating the layout and presentation of input elements.
  */
public interface InputElement extends Element {


  /**
    * Reflects the 

accept
 HTML attribute, containing comma-separated list of file types accepted by the server when type is file.
    */
  String getAccept();

  void setAccept(String arg);


  /**
    * Alignment of the element.

Obsolete in 
HTML5
    */
  String getAlign();

  void setAlign(String arg);


  /**
    * Reflects the 

alt
 HTML attribute, containing alternative text to use when type is image.
    */
  String getAlt();

  void setAlt(String arg);


  /**
    * Reflects the {{htmlattrxref("autocomplete", "input)}} HTML attribute, indicating whether the value of the control can be automatically completed by the browser. Ignored if the value of the type attribute is hidden, checkbox, radio, file, or a button type (button, submit, reset, image). Possible values are:  off: The user must explicitly enter a value into this field for every use, or the document provides its own auto-completion method; the browser does not automatically complete the entry.
 on: The browser can automatically complete the value based on values that the user has entered during previous uses.
 
    */
  String getAutocomplete();

  void setAutocomplete(String arg);


  /**
    * Reflects the 

autofocus
 HTML attribute, which specifies that a form control should have input focus when the page loads, unless the user overrides it, for example by typing in a different control. Only one form element in a document can have the autofocus attribute. It cannot be applied if the type attribute is set to hidden (that is, you cannot automatically set focus to a hidden control).
    */
  boolean isAutofocus();

  void setAutofocus(boolean arg);


  /**
    * The current state of the element when type is checkbox or radio.
    */
  boolean isChecked();

  void setChecked(boolean arg);


  /**
    * The default state of a radio button or checkbox as originally specified in HTML that created this object.
    */
  boolean isDefaultChecked();

  void setDefaultChecked(boolean arg);


  /**
    * The default value as originally specified in HTML that created this object.
    */
  String getDefaultValue();

  void setDefaultValue(String arg);

  String getDirName();

  void setDirName(String arg);


  /**
    * Reflects the 

disabled
 HTML attribute, indicating that the control is not available for interaction.
    */
  boolean isDisabled();

  void setDisabled(boolean arg);


  /**
    * A list of selected files.
    */
  FileList getFiles();

  void setFiles(FileList arg);


  /**
    * The containing form element, if this element is in a form. If this element is not contained in a form element:
  
HTML5 this can be the 

id
 attribute of any <form>
 element in the same document. Even if the attribute is set on <input>
, this property will be null, if it isn't the id of a <form>
 element.
 
HTML 4 this must be null.
 
    */
  FormElement getForm();


  /**
    * Reflects the 

formaction
 HTML attribute, containing the URI of a program that processes information submitted by the element. If specified, this attribute overrides the 

action
 attribute of the <form>
 element that owns this element.
    */
  String getFormAction();

  void setFormAction(String arg);

  String getFormEnctype();

  void setFormEnctype(String arg);


  /**
    * Reflects the 

formmethod
 HTML attribute, containing the HTTP method that the browser uses to submit the form. If specified, this attribute overrides the 

method
 attribute of the <form>
 element that owns this element.
    */
  String getFormMethod();

  void setFormMethod(String arg);


  /**
    * Reflects the 

formnovalidate
 HTML attribute, indicating that the form is not to be validated when it is submitted. If specified, this attribute overrides the 

novalidate
 attribute of the <form>
 element that owns this element.
    */
  boolean isFormNoValidate();

  void setFormNoValidate(boolean arg);


  /**
    * Reflects the 

formtarget
 HTML attribute, containing a name or keyword indicating where to display the response that is received after submitting the form. If specified, this attribute overrides the 

target
 attribute of the <form>
 element that owns this element.
    */
  String getFormTarget();

  void setFormTarget(String arg);


  /**
    * Reflects the 

height
 HTML attribute, which defines the height of the image displayed for the button, if the value of type is image.
    */
  int getHeight();

  void setHeight(int arg);

  boolean isIncremental();

  void setIncremental(boolean arg);


  /**
    * Indicates that a checkbox is neither on nor off.
    */
  boolean isIndeterminate();

  void setIndeterminate(boolean arg);


  /**
    * A list of <label>
 elements that are labels for this element.
    */
  NodeList getLabels();


  /**
    * Reflects the 

max
 HTML attribute, containing the maximum (numeric or date-time) value for this item, which must not be less than its minimum (min attribute) value.
    */
  String getMax();

  void setMax(String arg);


  /**
    * Reflects the 

maxlength
 HTML attribute, containing the maximum length of text (in Unicode code points) that the value can be changed to. The constraint is evaluated only when the value is changed
 Note: If you set maxlength to a negative value programmatically, an exception will be thrown.
    */
  int getMaxLength();

  void setMaxLength(int arg);


  /**
    * Reflects the 

min
 HTML attribute, containing the minimum (numeric or date-time) value for this item, which must not be greater than its maximum (max attribute) value.
    */
  String getMin();

  void setMin(String arg);


  /**
    * Reflects the 

multiple
 HTML attribute, indicating whether more than one value is possible (e.g., multiple files).
    */
  boolean isMultiple();

  void setMultiple(boolean arg);


  /**
    * Reflects the 

name
 HTML attribute, containing a name that identifies the element when submitting the form.
    */
  String getName();

  void setName(String arg);

  EventListener getOnwebkitspeechchange();

  void setOnwebkitspeechchange(EventListener arg);


  /**
    * Reflects the 

pattern
 HTML attribute, containing a regular expression that the control's value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is text, search, tel, url or email; otherwise it is ignored.
    */
  String getPattern();

  void setPattern(String arg);


  /**
    * Reflects the 

placeholder
 HTML attribute, containing a hint to the user of what can be entered in the control. The placeholder text must not contain carriage returns or line-feeds. This attribute applies when the value of the type attribute is text, search, tel, url or email; otherwise it is ignored.
    */
  String getPlaceholder();

  void setPlaceholder(String arg);


  /**
    * Reflects the 

readonly
 HTML attribute, indicating that the user cannot modify the value of the control.
 HTML 5 This is ignored if the value of the type attribute is hidden, range, color, checkbox, radio, file, or a button type.
    */
  boolean isReadOnly();

  void setReadOnly(boolean arg);


  /**
    * Reflects the 

required
 HTML attribute, indicating that the user must fill in a value before submitting a form.
    */
  boolean isRequired();

  void setRequired(boolean arg);


  /**
    * The direction in which selection occurred. This is "forward" if selection was performed in the start-to-end direction of the current locale, or "backward" for the opposite direction. This can also be "none" if the direction is unknown."
    */
  String getSelectionDirection();

  void setSelectionDirection(String arg);


  /**
    * The index of the end of selected text.
    */
  int getSelectionEnd();

  void setSelectionEnd(int arg);


  /**
    * The index of the beginning of selected text.
    */
  int getSelectionStart();

  void setSelectionStart(int arg);


  /**
    * Reflects the 

size
 HTML attribute, containing size of the control. This value is in pixels unless the value of type is text or password, in which case, it is an integer number of characters. 
HTML5 Applies only when type is set to text, search, tel, url, email, or password; otherwise it is ignored.
    */
  int getSize();

  void setSize(int arg);


  /**
    * Reflects the 

src
 HTML attribute, which specifies a URI for the location of an image to display on the graphical submit button, if the value of type is image; otherwise it is ignored.
    */
  String getSrc();

  void setSrc(String arg);


  /**
    * Reflects the 

step
 HTML attribute, which works with min and max to limit the increments at which a numeric or date-time value can be set. It can be the string any or a positive floating point number. If this is not set to any, the control accepts only values at multiples of the step value greater than the minimum.
    */
  String getStep();

  void setStep(String arg);


  /**
    * Reflects the 

type
 HTML attribute, indicating the type of control to display. See 

type
 attribute of <input>
 for possible values.
    */
  String getType();

  void setType(String arg);


  /**
    * A client-side image map. 

Obsolete in 
HTML5
    */
  String getUseMap();

  void setUseMap(String arg);


  /**
    * A localized message that describes the validation constraints that the control does not satisfy (if any). This is the empty string if the control is not a candidate for constraint validation (willValidate is false), or it satisfies its constraints.
    */
  String getValidationMessage();


  /**
    * The validity states that this element is in. 
    */
  ValidityState getValidity();


  /**
    * Current value in the control.
    */
  String getValue();

  void setValue(String arg);


  /**
    * The value of the element, interpreted as a date, or null if conversion is not possible.
    */
  Date getValueAsDate();

  void setValueAsDate(Date arg);


  /**
    * The value of the element, interpreted as one of the following in order:
  a time value
 a number
 null if conversion is not possible
 
    */
  double getValueAsNumber();

  void setValueAsNumber(double arg);

  boolean isWebkitGrammar();

  void setWebkitGrammar(boolean arg);

  boolean isWebkitSpeech();

  void setWebkitSpeech(boolean arg);

  boolean isWebkitdirectory();

  void setWebkitdirectory(boolean arg);


  /**
    * Reflects the 

width
 HTML attribute, which defines the width of the image displayed for the button, if the value of type is image.
    */
  int getWidth();

  void setWidth(int arg);


  /**
    * Indicates whether the element is a candidate for constraint validation. It is false if any conditions bar it from constraint validation.
    */
  boolean isWillValidate();


  /**
    * Returns false if the element is a candidate for constraint validation, and it does not satisfy its constraints. In this case, it also fires an invalid event at the element. It returns true if the element is not a candidate for constraint validation, or if it satisfies its constraints.
    */
  boolean checkValidity();


  /**
    * Selects the input text in the element, and focuses it so the user can subsequently replace the whole entry.
    */
  void select();


  /**
    * Sets a custom validity message for the element. If this message is not the empty string, then the element is suffering from a custom validity error, and does not validate.
    */
  void setCustomValidity(String error);


  /**
    * Selects a range of text in the element (but does not focus it). The optional selectionDirection parameter may be "forward" or "backward" to establish the direction in which selection was set, or "none"if the direction is unknown or not relevant. The default is "none". Specifying selectionDirection sets the value of the selectionDirection property.
    */
  void setSelectionRange(int start, int end);


  /**
    * Selects a range of text in the element (but does not focus it). The optional selectionDirection parameter may be "forward" or "backward" to establish the direction in which selection was set, or "none"if the direction is unknown or not relevant. The default is "none". Specifying selectionDirection sets the value of the selectionDirection property.
    */
  void setSelectionRange(int start, int end, String direction);


  /**
    * Decrements the value by (step * n), where n defaults to 1 if not specified. Throws an INVALID_STATE_ERR exception:
  if the method is not applicable to for the current type value.
 if the element has no step value.
 if the value cannot be converted to a number.
 if the resulting value is above the max or below the min. 
 
    */
  void stepDown();


  /**
    * Decrements the value by (step * n), where n defaults to 1 if not specified. Throws an INVALID_STATE_ERR exception:
  if the method is not applicable to for the current type value.
 if the element has no step value.
 if the value cannot be converted to a number.
 if the resulting value is above the max or below the min. 
 
    */
  void stepDown(int n);


  /**
    * Increments the value by (step * n), where n defaults to 1 if not specified. Throws an INVALID_STATE_ERR exception:
  if the method is not applicable to for the current type value.
 if the element has no step value.
 if the value cannot be converted to a number.
 if the resulting value is above the max or below the min.
 
    */
  void stepUp();


  /**
    * Increments the value by (step * n), where n defaults to 1 if not specified. Throws an INVALID_STATE_ERR exception:
  if the method is not applicable to for the current type value.
 if the element has no step value.
 if the value cannot be converted to a number.
 if the resulting value is above the max or below the min.
 
    */
  void stepUp(int n);
}