Source for org.w3c.dom.html2.HTMLFormElement

   1: /*
   2:  * Copyright (c) 2003 World Wide Web Consortium,
   3:  * (Massachusetts Institute of Technology, Institut National de
   4:  * Recherche en Informatique et en Automatique, Keio University). All
   5:  * Rights Reserved. This program is distributed under the W3C's Software
   6:  * Intellectual Property License. This program is distributed in the
   7:  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
   8:  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
   9:  * PURPOSE.
  10:  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  11:  */
  12: 
  13: package org.w3c.dom.html2;
  14: 
  15: /**
  16:  * The <code>FORM</code> element encompasses behavior similar to a collection
  17:  * and an element. It provides direct access to the contained form controls
  18:  * as well as the attributes of the form element. See the FORM element
  19:  * definition in HTML 4.01.
  20:  * <p>See also the <a href='http://www.w3.org/TR/2003/REC-DOM-Level-2-HTML-20030109'>Document Object Model (DOM) Level 2 HTML Specification</a>.
  21:  */
  22: public interface HTMLFormElement extends HTMLElement {
  23:     /**
  24:      * Returns a collection of all form control elements in the form.
  25:      */
  26:     public HTMLCollection getElements();
  27: 
  28:     /**
  29:      * The number of form controls in the form.
  30:      */
  31:     public int getLength();
  32: 
  33:     /**
  34:      * Names the form.
  35:      */
  36:     public String getName();
  37:     /**
  38:      * Names the form.
  39:      */
  40:     public void setName(String name);
  41: 
  42:     /**
  43:      * List of character sets supported by the server. See the accept-charset
  44:      * attribute definition in HTML 4.01.
  45:      */
  46:     public String getAcceptCharset();
  47:     /**
  48:      * List of character sets supported by the server. See the accept-charset
  49:      * attribute definition in HTML 4.01.
  50:      */
  51:     public void setAcceptCharset(String acceptCharset);
  52: 
  53:     /**
  54:      * Server-side form handler. See the action attribute definition in HTML
  55:      * 4.01.
  56:      */
  57:     public String getAction();
  58:     /**
  59:      * Server-side form handler. See the action attribute definition in HTML
  60:      * 4.01.
  61:      */
  62:     public void setAction(String action);
  63: 
  64:     /**
  65:      * The content type of the submitted form, generally
  66:      * "application/x-www-form-urlencoded". See the enctype attribute
  67:      * definition in HTML 4.01. The onsubmit even handler is not guaranteed
  68:      * to be triggered when invoking this method. The behavior is
  69:      * inconsistent for historical reasons and authors should not rely on a
  70:      * particular one.
  71:      */
  72:     public String getEnctype();
  73:     /**
  74:      * The content type of the submitted form, generally
  75:      * "application/x-www-form-urlencoded". See the enctype attribute
  76:      * definition in HTML 4.01. The onsubmit even handler is not guaranteed
  77:      * to be triggered when invoking this method. The behavior is
  78:      * inconsistent for historical reasons and authors should not rely on a
  79:      * particular one.
  80:      */
  81:     public void setEnctype(String enctype);
  82: 
  83:     /**
  84:      * HTTP method [<a href='http://www.ietf.org/rfc/rfc2616.txt'>IETF RFC 2616</a>] used to submit form. See the method attribute definition
  85:      * in HTML 4.01.
  86:      */
  87:     public String getMethod();
  88:     /**
  89:      * HTTP method [<a href='http://www.ietf.org/rfc/rfc2616.txt'>IETF RFC 2616</a>] used to submit form. See the method attribute definition
  90:      * in HTML 4.01.
  91:      */
  92:     public void setMethod(String method);
  93: 
  94:     /**
  95:      * Frame to render the resource in. See the target attribute definition in
  96:      * HTML 4.01.
  97:      */
  98:     public String getTarget();
  99:     /**
 100:      * Frame to render the resource in. See the target attribute definition in
 101:      * HTML 4.01.
 102:      */
 103:     public void setTarget(String target);
 104: 
 105:     /**
 106:      * Submits the form. It performs the same action as a submit button.
 107:      */
 108:     public void submit();
 109: 
 110:     /**
 111:      * Restores a form element's default values. It performs the same action
 112:      * as a reset button.
 113:      */
 114:     public void reset();
 115: 
 116: }