org.pepstock.charba.client.dom.BaseHtmlDocument Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of charba Show documentation

Charba, GWT Chart library based on CHART.JS

There is a newer version: 6.5-gwt

/**
    Copyright 2017 Andrea "Stock" Stocchero

    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 org.pepstock.charba.client.dom;

import org.pepstock.charba.client.commons.NativeName;
import org.pepstock.charba.client.dom.elements.Body;

import jsinterop.annotations.JsMethod;
import jsinterop.annotations.JsPackage;
import jsinterop.annotations.JsProperty;
import jsinterop.annotations.JsType;

/**
 * Extends the document to include methods and properties that are specific to HTML documents.
 * 
 * @author Andrea "Stock" Stocchero
 *
 */
@JsType(isNative = true, name = NativeName.DOM_HTML_DOCUMENT, namespace = JsPackage.GLOBAL)
public final class BaseHtmlDocument extends BaseDocument {

	/**
	 * To avoid any instantiation
	 */
	BaseHtmlDocument() {
		// do nothing
	}

	/**
	 * Returns the <body> or <frameset> node of the current document, or null if no such element exists.
	 *
	 * @return the <body> or <frameset> node of the current document, or null if no such element exists
	 */
	@JsProperty
	public native Body getBody();

	/**
	 * Creates an event of the type specified.

	 * The returned object should be first initialized and can then be dispatched.
	 * 
	 * @param type a string that represents the type of event to be created.
	 * @return an event of the type specified
	 * @see BaseEventTypes
	 */
	@JsMethod
	native BaseNativeEvent createEvent(String type);

}