com.google.gwt.dom.client.FormElement Maven / Gradle / Ivy
/*
* Copyright 2008 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 com.google.gwt.dom.client;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.safehtml.shared.SafeUri;
import com.google.gwt.safehtml.shared.annotations.IsSafeUri;
/**
* The FORM element encompasses behavior similar to a collection and an element.
* It provides direct access to the contained form controls as well as the
* attributes of the form element.
*
* @see W3C HTML Specification
*/
@TagName(FormElement.TAG)
public class FormElement extends Element {
public static final String TAG = "form";
/**
* Assert that the given {@link Element} is compatible with this class and
* automatically typecast it.
*/
public static FormElement as(Element elem) {
assert is(elem);
return (FormElement) elem;
}
/**
* Determines whether the given {@link JavaScriptObject} can be cast to
* this class. A null object will cause this method to
* return false.
*/
public static boolean is(JavaScriptObject o) {
if (Element.is(o)) {
return is((Element) o);
}
return false;
}
/**
* Determine whether the given {@link Node} can be cast to this class.
* A null node will cause this method to return
* false.
*/
public static boolean is(Node node) {
if (Element.is(node)) {
return is((Element) node);
}
return false;
}
/**
* Determine whether the given {@link Element} can be cast to this class.
* A null node will cause this method to return
* false.
*/
public static boolean is(Element elem) {
return elem != null && elem.hasTagName(TAG);
}
protected FormElement() {
}
/**
* List of character sets supported by the server.
*
* @see W3C HTML Specification
*/
public final native String getAcceptCharset() /*-{
return this.acceptCharset;
}-*/;
/**
* Server-side form handler.
*
* @see W3C HTML Specification
*/
public final native String getAction() /*-{
return this.action;
}-*/;
/**
* Returns a collection of all form control elements in the form.
*/
public final native NodeCollection getElements() /*-{
return this.elements;
}-*/;
/**
* The content type of the submitted form, generally
* "application/x-www-form-urlencoded".
*
* Note: The onsubmit even handler is not guaranteed to be triggered when
* invoking this method. The behavior is inconsistent for historical reasons
* and authors should not rely on a particular one.
*
* @see W3C HTML Specification
*/
public final native String getEnctype() /*-{
return this.enctype;
}-*/;
/**
* HTTP method [IETF RFC 2616] used to submit form.
*
* @see W3C HTML Specification
*/
public final native String getMethod() /*-{
return this.method;
}-*/;
/**
* Names the form.
*/
public final native String getName() /*-{
return this.name;
}-*/;
/**
* Frame to render the resource in.
*
* @see W3C HTML Specification
*/
public final native String getTarget() /*-{
return this.target;
}-*/;
/**
* Restores a form element's default values. It performs the same action as a
* reset button.
*/
public final native void reset() /*-{
this.reset();
}-*/;
/**
* List of character sets supported by the server.
*
* @see W3C HTML Specification
*/
public final native void setAcceptCharset(String acceptCharset) /*-{
this.acceptCharset = acceptCharset;
}-*/;
/**
* Server-side form handler.
*
* @see W3C HTML Specification
*/
public final void setAction(SafeUri action) {
setAction(action.asString());
}
/**
* Server-side form handler.
*
* @see W3C HTML Specification
*/
public final native void setAction(@IsSafeUri String action) /*-{
this.action = action;
}-*/;
/**
* The content type of the submitted form, generally
* "application/x-www-form-urlencoded".
*
* Note: The onsubmit even handler is not guaranteed to be triggered when
* invoking this method. The behavior is inconsistent for historical reasons
* and authors should not rely on a particular one.
*
* @see W3C HTML Specification
*/
public final native void setEnctype(String enctype) /*-{
this.enctype = enctype;
}-*/;
/**
* HTTP method [IETF RFC 2616] used to submit form.
*
* @see W3C HTML Specification
*/
public final native void setMethod(String method) /*-{
this.method = method;
}-*/;
/**
* Names the form.
*/
public final native void setName(String name) /*-{
this.name = name;
}-*/;
/**
* Frame to render the resource in.
*
* @see W3C HTML Specification
*/
public final native void setTarget(String target) /*-{
this.target = target;
}-*/;
/**
* Submits the form. It performs the same action as a submit button.
*/
public final native void submit() /*-{
this.submit();
}-*/;
}