/*
* Smart GWT (GWT for SmartClient)
* Copyright 2008 and beyond, Isomorphic Software, Inc.
*
* Smart GWT is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation. Smart GWT is also
* available under typical commercial license terms - see
* http://smartclient.com/license
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package com.smartgwt.client.widgets.plugins;
import com.smartgwt.client.event.*;
import com.smartgwt.client.core.*;
import com.smartgwt.client.types.*;
import com.smartgwt.client.data.*;
import com.smartgwt.client.data.events.*;
import com.smartgwt.client.rpc.*;
import com.smartgwt.client.widgets.*;
import com.smartgwt.client.widgets.events.*;
import com.smartgwt.client.widgets.form.*;
import com.smartgwt.client.widgets.form.validator.*;
import com.smartgwt.client.widgets.form.fields.*;
import com.smartgwt.client.widgets.tile.*;
import com.smartgwt.client.widgets.tile.events.*;
import com.smartgwt.client.widgets.grid.*;
import com.smartgwt.client.widgets.grid.events.*;
import com.smartgwt.client.widgets.chart.*;
import com.smartgwt.client.widgets.layout.*;
import com.smartgwt.client.widgets.layout.events.*;
import com.smartgwt.client.widgets.menu.*;
import com.smartgwt.client.widgets.tab.*;
import com.smartgwt.client.widgets.toolbar.*;
import com.smartgwt.client.widgets.tree.*;
import com.smartgwt.client.widgets.tree.events.*;
import com.smartgwt.client.widgets.viewer.*;
import com.smartgwt.client.widgets.calendar.*;
import com.smartgwt.client.widgets.calendar.events.*;
import com.smartgwt.client.widgets.cube.*;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.HashMap;
import com.google.gwt.user.client.ui.Widget;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.user.client.Element;
import com.smartgwt.client.util.*;
import com.google.gwt.event.shared.*;
import com.google.gwt.event.shared.HasHandlers;
/**
* Smart GWT abstraction for Applets. This class provides Java<->Smart GWT interoperability. When embedding
* Applets into Smart GWT-based pages, please use this wrapper class to instantiate the Applet. Doing so will provide the
* following benefits: <p> <ul> <li>Drag and drop interactions on the page can target the Applet (can drop on applet).
* <li>When a drag interaction transits an Applet, Smart GWT will ensure that the dragTarget appears above the Applet
* (prevents burn-through). <li>Allows you to easily embed the Applet into Smart GWT containers such as Windows and
* Layouts, providing automatic masking to ensure the correct z-index order. But see notes below for limitations. </ul>
* <p> <u>Known issues</u><br><br> <ul> <li>Resizing Applets can cause Firefox to lock up and require the user to
* terminate the process manually. The cause is currently unknown, but likely causes include applets attempting to
* control their own size, or to attempt to re-render on resize. More recent JVMs (1.6+) appear to make this problem less
* frequent. This may also simply be caused by applet code being unable to deal with certain combination sizes and
* crashing. <li>In Firefox, when using a JVM older than 1.6, Applets cannot be resized smaller than their originally
* drawn size. Doing so causes them to stick at the originally drawn size, and to overflow the boundary of any Smart GWT
* component they are embedded in. <li>In Firefox, Applets do not handle the z-index ordering correctly with respect to
* IFRAMEs or other Applets. Therefore, in Firefox you cannot layer Applets on top of each other or on top of Smart GWT
* components containing IFRAMEs and have them render in the correct order. </ul> For a general overview of applets and
* an applet tutorial see: <a href='http://java.sun.com/docs/books/tutorial/applet/'
* onclick="window.open('http://java.sun.com/docs/books/tutorial/applet/');return
* false;">http://java.sun.com/docs/books/tutorial/applet/</a>
*/
public class Applet extends BrowserPlugin {
public static Applet getOrCreateRef(JavaScriptObject jsObj) {
if(jsObj == null) return null;
BaseWidget obj = BaseWidget.getRef(jsObj);
if(obj != null) {
return (Applet) obj;
} else {
return new Applet(jsObj);
}
}
public Applet(){
scClassName = "Applet";
}
public Applet(JavaScriptObject jsObj){
super(jsObj);
}
protected native JavaScriptObject create()/*-{
var config = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
var scClassName = this.@com.smartgwt.client.widgets.BaseWidget::scClassName;
var widget = $wnd.isc[scClassName].create(config);
this.@com.smartgwt.client.widgets.BaseWidget::doInit()();
return widget;
}-*/;
// ********************* Properties / Attributes ***********************
/**
* This text is displayed if the browser understands the tag used for the applet html element, but can't run the applet
* for some reason.
*
* @param alt alt Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.plugins.Applet#setAltHTML
* @see com.smartgwt.client.widgets.plugins.Applet#setUseTag
*/
public void setAlt(String alt) throws IllegalStateException {
setAttribute("alt", alt, false);
}
/**
* This text is displayed if the browser understands the tag used for the applet html element, but can't run the applet
* for some reason.
*
*
* @return String
* @see com.smartgwt.client.widgets.plugins.Applet#getAltHTML
* @see com.smartgwt.client.widgets.plugins.Applet#getUseTag
*/
public String getAlt() {
return getAttributeAsString("alt");
}
/**
* This text is displayed if the browser does not understand the tag used for the applet html element.
*
* @param altHTML altHTML Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.plugins.Applet#setAlt
* @see com.smartgwt.client.widgets.plugins.Applet#setUseTag
*/
public void setAltHTML(String altHTML) throws IllegalStateException {
setAttribute("altHTML", altHTML, false);
}
/**
* This text is displayed if the browser does not understand the tag used for the applet html element.
*
*
* @return String
* @see com.smartgwt.client.widgets.plugins.Applet#getAlt
* @see com.smartgwt.client.widgets.plugins.Applet#getUseTag
*/
public String getAltHTML() {
return getAttributeAsString("altHTML");
}
/**
* URL to the applet JAR or ZIP archive.
*
* @param archive archive Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.plugins.Applet#setCode
* @see com.smartgwt.client.widgets.plugins.Applet#setCodeBase
*/
public void setArchive(String archive) throws IllegalStateException {
setAttribute("archive", archive, false);
}
/**
* URL to the applet JAR or ZIP archive.
*
*
* @return String
* @see com.smartgwt.client.widgets.plugins.Applet#getCode
* @see com.smartgwt.client.widgets.plugins.Applet#getCodeBase
*/
public String getArchive() {
return getAttributeAsString("archive");
}
/**
* This attribute is used only with useTag: "object". In combination with {@link
* com.smartgwt.client.widgets.plugins.Applet#getObjectCodeBase objectCodeBase} this tag specifies the minimum JVM version
* required to view this applet and the URL from which the JVM can be downloaded. <p> The default settings match the
* default behavior of the <applet> tag which requires JVM 1.3 or higher. <p> The default classID is:
* "clsid:8AD9C840-044E-11D1-B3E9-00805F499D93" <p> For notes on this feature see: <a
* href='http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie'
* onclick="window.open('http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie');return
* false;">http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie</a>
*
* @param classID classID Default value is see below
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.plugins.Applet#setObjectCodeBase
*/
public void setClassID(String classID) throws IllegalStateException {
setAttribute("classID", classID, false);
}
/**
* This attribute is used only with useTag: "object". In combination with {@link
* com.smartgwt.client.widgets.plugins.Applet#getObjectCodeBase objectCodeBase} this tag specifies the minimum JVM version
* required to view this applet and the URL from which the JVM can be downloaded. <p> The default settings match the
* default behavior of the <applet> tag which requires JVM 1.3 or higher. <p> The default classID is:
* "clsid:8AD9C840-044E-11D1-B3E9-00805F499D93" <p> For notes on this feature see: <a
* href='http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie'
* onclick="window.open('http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie');return
* false;">http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie</a>
*
*
* @return String
* @see com.smartgwt.client.widgets.plugins.Applet#getObjectCodeBase
*/
public String getClassID() {
return getAttributeAsString("classID");
}
/**
* A URL that points to the class of the applet.
*
* @param code code Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.plugins.Applet#setCodeBase
* @see com.smartgwt.client.widgets.plugins.Applet#setArchive
*/
public void setCode(String code) throws IllegalStateException {
setAttribute("code", code, false);
}
/**
* A URL that points to the class of the applet.
*
*
* @return String
* @see com.smartgwt.client.widgets.plugins.Applet#getCodeBase
* @see com.smartgwt.client.widgets.plugins.Applet#getArchive
*/
public String getCode() {
return getAttributeAsString("code");
}
/**
* The base URL of the applet if the {@link com.smartgwt.client.widgets.plugins.Applet#getCode code} attribute is relative
*
* @param codeBase codeBase Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.plugins.Applet#setCode
* @see com.smartgwt.client.widgets.plugins.Applet#setArchive
*/
public void setCodeBase(String codeBase) throws IllegalStateException {
setAttribute("codeBase", codeBase, false);
}
/**
* The base URL of the applet if the {@link com.smartgwt.client.widgets.plugins.Applet#getCode code} attribute is relative
*
*
* @return String
* @see com.smartgwt.client.widgets.plugins.Applet#getCode
* @see com.smartgwt.client.widgets.plugins.Applet#getArchive
*/
public String getCodeBase() {
return getAttributeAsString("codeBase");
}
/**
* Any additional HTML you want to throw into the tag that specifies the applet element.
*
* @param extraHTML extraHTML Default value is true
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setExtraHTML(Boolean extraHTML) throws IllegalStateException {
setAttribute("extraHTML", extraHTML, false);
}
/**
* Any additional HTML you want to throw into the tag that specifies the applet element.
*
*
* @return Boolean
*/
public Boolean getExtraHTML() {
return getAttributeAsBoolean("extraHTML");
}
/**
* Usable only in IE: if true allows Java->JS LiveConnect (other platforms that support LiveConnect have it enabled by
* default and do not allow it to be disabled).
*
* @param mayScript mayScript Default value is true
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.plugins.Applet#setScriptable
*/
public void setMayScript(Boolean mayScript) throws IllegalStateException {
setAttribute("mayScript", mayScript, false);
}
/**
* Usable only in IE: if true allows Java->JS LiveConnect (other platforms that support LiveConnect have it enabled by
* default and do not allow it to be disabled).
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.plugins.Applet#getScriptable
*/
public Boolean getMayScript() {
return getAttributeAsBoolean("mayScript");
}
/**
* Sets the 'name' attribute on the applet object. If a name is not provided it will be auto-generated. Note that in
* general you don't need to set this. If you have a handle to your ISC Applet object you can simply call {@link
* com.smartgwt.client.widgets.plugins.Applet#getPluginHandle Applet.getPluginHandle} to get a handle to the element.
*
* @param name name Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.plugins.Applet#getPluginHandle
*/
public void setName(String name) throws IllegalStateException {
setAttribute("name", name, false);
}
/**
* Sets the 'name' attribute on the applet object. If a name is not provided it will be auto-generated. Note that in
* general you don't need to set this. If you have a handle to your ISC Applet object you can simply call {@link
* com.smartgwt.client.widgets.plugins.Applet#getPluginHandle Applet.getPluginHandle} to get a handle to the element.
*
*
* @return String
* @see com.smartgwt.client.widgets.plugins.Applet#getPluginHandle
*/
public String getName() {
return getAttributeAsString("name");
}
/**
* This attribute is used only with useTag: "object". In combination with {@link
* com.smartgwt.client.widgets.plugins.Applet#getClassID classID} this tag specifies the minimum JVM version required to
* view this applet and the URL from which the JVM can be downloaded. <p> The default settings match the default
* behavior of the <applet> tag which requires JVM 1.3 or higher. <p> The default objectCodeBase is:
* "http://java.sun.com/products/plugin/1.3/jinstall-13-win32.cab#Version=1,3,0,0" <p> For notes on this feature see: <a
* href='http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie'
* onclick="window.open('http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie');return
* false;">http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie</a>
*
* @param objectCodeBase objectCodeBase Default value is see below
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.plugins.Applet#setClassID
*/
public void setObjectCodeBase(String objectCodeBase) throws IllegalStateException {
setAttribute("objectCodeBase", objectCodeBase, false);
}
/**
* This attribute is used only with useTag: "object". In combination with {@link
* com.smartgwt.client.widgets.plugins.Applet#getClassID classID} this tag specifies the minimum JVM version required to
* view this applet and the URL from which the JVM can be downloaded. <p> The default settings match the default
* behavior of the <applet> tag which requires JVM 1.3 or higher. <p> The default objectCodeBase is:
* "http://java.sun.com/products/plugin/1.3/jinstall-13-win32.cab#Version=1,3,0,0" <p> For notes on this feature see: <a
* href='http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie'
* onclick="window.open('http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie');return
* false;">http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html#in-ie</a>
*
*
* @return String
* @see com.smartgwt.client.widgets.plugins.Applet#getClassID
*/
public String getObjectCodeBase() {
return getAttributeAsString("objectCodeBase");
}
/**
* Usable only in IE: if true allows JS->Java LiveConnect (other platforms that support LiveConnect have it enabled by
* default and do not allow it to be disabled).
*
* @param scriptable scriptable Default value is true
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.plugins.Applet#setMayScript
*/
public void setScriptable(Boolean scriptable) throws IllegalStateException {
setAttribute("scriptable", scriptable, false);
}
/**
* Usable only in IE: if true allows JS->Java LiveConnect (other platforms that support LiveConnect have it enabled by
* default and do not allow it to be disabled).
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.plugins.Applet#getMayScript
*/
public Boolean getScriptable() {
return getAttributeAsBoolean("scriptable");
}
/**
* A URL that points to the class of this applet. This is the same as the 'code' attribute. Note that if you specify both
* the src and the code attributes, the src attribute will be ignored in favor of the code attribute.
*
* @param src src Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setSrc(String src) throws IllegalStateException {
setAttribute("src", src, false);
}
/**
* A URL that points to the class of this applet. This is the same as the 'code' attribute. Note that if you specify both
* the src and the code attributes, the src attribute will be ignored in favor of the code attribute.
*
*
* @return String
*/
public String getSrc() {
return getAttributeAsString("src");
}
/**
* Specifies the type of tag to use for the applet html. See <a
* href='http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html'
* onclick="window.open('http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html');return
* false;">http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html</a> for a discussion of
* different tags.
*
* @param useTag useTag Default value is "applet"
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setUseTag(String useTag) throws IllegalStateException {
setAttribute("useTag", useTag, false);
}
/**
* Specifies the type of tag to use for the applet html. See <a
* href='http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html'
* onclick="window.open('http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html');return
* false;">http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/using_tags.html</a> for a discussion of
* different tags.
*
*
* @return String
*/
public String getUseTag() {
return getAttributeAsString("useTag");
}
// ********************* Methods ***********************
/**
* Returns a handle to the applet DOM element (valid only after the component has been drawn).
*/
public native void getPluginHandle() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.getPluginHandle();
}-*/;
// ********************* Static Methods ***********************
/**
* Class level method to set the default properties of this class. If set, then all subsequent instances of this
* class will automatically have the default properties that were set when this method was called. This is a powerful
* feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default
* properties of this class. Can also be used for skinning / styling purposes.
* <P>
* <b>Note:</b> This method is intended for setting default attributes only and will effect all instances of the
* underlying class (including those automatically generated in JavaScript).
* This method should not be used to apply standard EventHandlers or override methods for
* a class - use a custom subclass instead.
*
* @param appletProperties properties that should be used as new defaults when instances of this class are created
*/
public static native void setDefaultProperties(Applet appletProperties) /*-{
var properties = $wnd.isc.addProperties({},appletProperties.@com.smartgwt.client.widgets.BaseWidget::getConfig()());
delete properties.ID;
$wnd.isc.Applet.addProperties(properties);
}-*/;
// ***********************************************************
/**
* A map of key/value pairs to pass to the applet as parameters. These are typically accessible within the Java applet
* code.
*
* @param params Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setParams(Map params) throws IllegalStateException {
JavaScriptObject paramsJS = JSOHelper.convertMapToJavascriptObject(params);
setAttribute("params", paramsJS, false);
}
/**
* A map of key/value pairs to pass to the applet as parameters. These are typically accessible within the Java applet
* code.
*
*
* @return params for this applet
*/
public native Map getParams() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var paramsJS = self.params;
return paramsJS == null ? null : @com.smartgwt.client.util.JSOHelper::convertToMap(Lcom/google/gwt/core/client/JavaScriptObject;)(paramsJS);
}-*/;
}