com.google.gwt.dom.client.ObjectElement 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.IsTrustedResourceUri;
import com.google.gwt.safehtml.shared.annotations.SuppressIsTrustedResourceUriCastCheck;
/**
* Generic embedded object.
*
* Note: In principle, all properties on the object element are read-write but
* in some environments some properties may be read-only once the underlying
* object is instantiated.
*
* @see W3C HTML Specification
*/
@TagName(ObjectElement.TAG)
public class ObjectElement extends Element {
public static final String TAG = "object";
/**
* Assert that the given {@link Element} is compatible with this class and
* automatically typecast it.
*/
public static ObjectElement as(Element elem) {
assert is(elem);
return (ObjectElement) 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 ObjectElement() {
}
/**
* Applet class file.
*/
public final native String getCode() /*-{
return this.code;
}-*/;
/**
* The document this object contains, if there is any and it is available, or
* null otherwise.
*/
public final native Document getContentDocument() /*-{
return this.contentDocument;
}-*/;
/**
* A URI specifying the location of the object's data.
*
* @see W3C HTML Specification
*/
public final native String getData() /*-{
return this.data;
}-*/;
/**
* Returns the FORM element containing this control. Returns null if this
* control is not within the context of a form.
*/
public final native FormElement getForm() /*-{
return this.form;
}-*/;
/**
* Override height.
*
* @see W3C HTML Specification
*/
public final native String getHeight() /*-{
return this.height;
}-*/;
/**
* Form control or object name when submitted with a form.
*
* @see W3C HTML Specification
*/
public final native String getName() /*-{
return this.name;
}-*/;
/**
* Content type for data downloaded via data attribute.
*
* @see W3C HTML Specification
*/
public final native String getType() /*-{
return this.type;
}-*/;
/**
* Override width.
*
* @see W3C HTML Specification
*/
public final native String getWidth() /*-{
return this.width;
}-*/;
/**
* Applet class file.
*/
public final native void setCode(String code) /*-{
this.code = code;
}-*/;
/**
* A URI specifying the location of the object's data.
*
* @see W3C HTML Specification
*/
@SuppressIsTrustedResourceUriCastCheck
public final void setData(@IsTrustedResourceUri SafeUri data) {
setData(data.asString());
}
/**
* A URI specifying the location of the object's data.
*
* @see W3C HTML Specification
*/
public final native void setData(@IsTrustedResourceUri String data) /*-{
this.data = data;
}-*/;
/**
* Override height.
*
* @see W3C HTML Specification
*/
public final native void setHeight(String height) /*-{
this.height = height;
}-*/;
/**
* Form control or object name when submitted with a form.
*
* @see W3C HTML Specification
*/
public final native void setName(String name) /*-{
this.name = name;
}-*/;
/**
* Content type for data downloaded via data attribute.
*
* @see W3C HTML Specification
*/
public final native void setType(String type) /*-{
this.type = type;
}-*/;
/**
* Use client-side image map.
*
* @see W3C HTML Specification
*/
public final native void setUseMap(boolean useMap) /*-{
this.useMap = useMap;
}-*/;
/**
* Override width.
*
* @see W3C HTML Specification
*/
public final native void setWidth(String width) /*-{
this.width = width;
}-*/;
/**
* Use client-side image map.
*
* @see W3C HTML Specification
*/
public final native boolean useMap() /*-{
return this.useMap;
}-*/;
}