com.saperion.ngc.ngapplet

Class NgApplet

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

com.saperion.ngc.ngapplet.NgApplet

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.api.HtmlBasedComponent, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

Direct Known Subclasses:

MailAppletImpl

public class NgApplet
extends org.zkoss.zk.ui.HtmlBasedComponent

The NgApplet embeds an applet by using the OBJECT tag instead of the deprecated APPLET tag.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
NgApplet()

Method Summary

Modifier and Type	Method and Description
String	getArchive()
String	getCode()
String	getCodebase()
Properties	getParameters()
void	invoke(String function) Invokes the function of the applet running at the client.
void	invoke(String function, String argument) Invokes the function of the applet running at the client with one argument.
void	invoke(String function, String[] arguments) Invokes the function of the applet running at the client with variable number argument.
boolean	isIgnoreInvokeErrors() Checks if invoke errors will be ignored.
void	notifyWhenReady(int timeout, int attempts) This method can be called after the applet was attached to a page.
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	setArchive(String archive) Sets the archive parameter.
void	setCode(String code) Sets the code parameter.
void	setCodebase(String codebase) Sets the codebase.
void	setIgnoreInvokeErrors(boolean ignoreInvokeErrors) If set to true, all errors that occur when a method of the applet is called by JavaScript will be ignored.
void	setJsonParameters(String jsonParameters) Sets the json parameters.
String	setParam(String name, String value) Sets the parameter with the specified name.
void	setParameters(Map<String,String> params) Sets the parameters.
void	setParameters(Properties params) Sets the parameters.

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

clone, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, newExtraCtrl, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, renderIdSpace, response, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zk.ui.Component

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, unsetVariable

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Constructor Detail

NgApplet

public NgApplet()

Method Detail

getCodebase

public String getCodebase()

Returns:

the applet's codebase parameter

setCodebase

public void setCodebase(String codebase)

Sets the codebase.

Parameters:

codebase - the new codebase

getCode

public String getCode()

Returns:

the code parameter

setCode

public void setCode(String code)

Sets the code parameter.

Parameters:

code - the new code

getArchive

public String getArchive()

Returns:

the applet's archive parameter

setArchive

public void setArchive(String archive)

Sets the archive parameter.

Parameters:

archive - the new archive

getParameters

public Properties getParameters()

Returns:

the parameters

setParameters

public void setParameters(Map<String,String> params)

Sets the parameters.

Parameters:

params - the params

setParameters

public void setParameters(Properties params)

Sets the parameters.

Parameters:

params - the new parameters

setJsonParameters

public void setJsonParameters(String jsonParameters)

Sets the json parameters.

Parameters:

jsonParameters - a json string containing the parameters

setParam

public String setParam(String name,
                       String value)

Sets the parameter with the specified name.

Parameters:

name - the name

value - the value

Returns:

the previous value of the parameter or null if it did not yet exist

isIgnoreInvokeErrors

public boolean isIgnoreInvokeErrors()

Checks if invoke errors will be ignored.

Returns:

true, if invoke errors will be ignored

setIgnoreInvokeErrors

public void setIgnoreInvokeErrors(boolean ignoreInvokeErrors)

If set to true, all errors that occur when a method of the applet is called by JavaScript will be ignored.

Parameters:

ignoreInvokeErrors - whether to ignore invoke errors or not

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException

Overrides:

renderProperties in class org.zkoss.zk.ui.HtmlBasedComponent

Throws:

IOException

See Also:

HtmlBasedComponent.renderProperties(org.zkoss.zk.ui.sys.ContentRenderer)

invoke

public void invoke(String function)

Invokes the function of the applet running at the client.

Parameters:

function - name of the function

invoke

public void invoke(String function,
                   String argument)

Invokes the function of the applet running at the client with one argument.

Parameters:

function - name of the function

argument - the argument

invoke

public void invoke(String function,
                   String[] arguments)

Invokes the function of the applet running at the client with variable number argument.

Parameters:

function - name of the function

arguments - the arguments

notifyWhenReady

public void notifyWhenReady(int timeout,
                            int attempts)

This method can be called after the applet was attached to a page. If called, a JavaScript method is invoked that will try for attempts times to check if the applet is ready. A delay of timeout milliseconds will be used between two attempts. If the applet is ready, an onAppletReady event will be fired.

Parameters:

timeout - timeout between attempts

attempts - number of attempts