org.zkoss.zul.api
Interface Applet

All Superinterfaces:

java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable, XulElement

All Known Implementing Classes:

Applet

public interface Applet
extends XulElement

A generic applet component.

Since:

3.6.0

Author:

tomyeh

Field Summary

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

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

Method Summary

java.lang.String	getCode() Return the code of the applet, i.e., the URI of the Java class.
java.util.Map	getParams() Returns a map of parameters (never null).
void	invoke(java.lang.String function) Invokes the function of the applet running at the client.
void	invoke(java.lang.String function, java.lang.String argument) Invokes the function of the applet running at the client with one argument.
void	invoke(java.lang.String function, java.lang.String[] arguments) Invokes the function of the applet running at the client with variable number argument.
void	setCode(java.lang.String code) Sets the code of the applet, i.e., the URI of the Java class.
void	setField(java.lang.String field, java.lang.String value) Sets the value of the specified filed.
java.lang.String	setParam(java.lang.String name, java.lang.String value) Sets a parameter.
void	setParams(java.util.Map params) Sets a map of parameters (all existent parameters are removed first).

Methods inherited from interface org.zkoss.zul.impl.api.XulElement

getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

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

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, unsetVariable

Method Detail

getCode

java.lang.String getCode()

Return the code of the applet, i.e., the URI of the Java class.

setCode

void setCode(java.lang.String code)

Sets the code of the applet, i.e., the URI of the Java class.

setParams

void setParams(java.util.Map params)

Sets a map of parameters (all existent parameters are removed first).

getParams

java.util.Map getParams()

Returns a map of parameters (never null).

setParam

java.lang.String setParam(java.lang.String name,
                          java.lang.String value)

Sets a parameter. If the value is null, the parameter is removed.

invoke

void invoke(java.lang.String function)

Invokes the function of the applet running at the client.

invoke

void invoke(java.lang.String function,
            java.lang.String argument)

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

invoke

void invoke(java.lang.String function,
            java.lang.String[] arguments)

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

setField

void setField(java.lang.String field,
              java.lang.String value)

Sets the value of the specified filed.