org.zkoss.zul
Class Applet

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zk.ui.HtmlBasedComponent
          extended by org.zkoss.zul.Applet
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Component, DynamicPropertied, Scope, ComponentCtrl

public class Applet
extends HtmlBasedComponent
implements DynamicPropertied

A generic applet component.

See also HTML applet tag.

Non XUL extension.

Note: AbstractComponent.setVisible(boolean) with false cannot work in IE. (Browser's limitation)

Since:
3.6.0
Author:
Davidchen, Tomyeh
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent
HtmlBasedComponent.ExtraCtrl
 
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
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
Applet()
           
 
Method Summary
 java.lang.String getAlign()
          Returns the alignment of an applet according to surrounding elements.
 java.lang.String getArchive()
          Returns the location of an archive file (URL).
 java.lang.String getCode()
          Return the applet class to run.
 java.lang.String getCodebase()
          Returns a relative base URL for applets specified in setCode(java.lang.String) (URL).
 java.lang.Object getDynamicProperty(java.lang.String name)
          Returns the property value of the specified name.
 java.lang.String getHspace()
          Returns the horizontal spacing around an applet.
 java.util.Map<java.lang.String,java.lang.String> getParams()
          Returns a map of parameters (never null).
 java.lang.String getVspace()
          Returns the vertical spacing around an applet.
 boolean hasDynamicProperty(java.lang.String name)
          Returns whether a dynamic property is defined.
 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.
protected  boolean isChildable()
          No child is allowed.
 boolean isMayscript()
          Returns whether the applet is allowed to access the scripting object.
protected  void renderProperties(ContentRenderer renderer)
          Renders the content of this component, excluding the enclosing tags and children.
 void setAlign(java.lang.String align)
          Sets the alignment of an applet according to surrounding elements.
 void setArchive(java.lang.String archive)
          Sets the location of an archive file (URL).
 void setCode(java.lang.String code)
          Sets the applet class to run.
 void setCodebase(java.lang.String codebase)
          Sets a relative base URL for applets specified in setCode(java.lang.String) (URL).
 void setDynamicProperty(java.lang.String name, java.lang.Object value)
          Sets a property with the specified name and value.
 void setField(java.lang.String field, java.lang.String value)
          Sets the value of the specified filed.
 void setHspace(java.lang.String hspace)
          Sets the horizontal spacing in pixels around an applet.
 void setMayscript(boolean mayscript)
          Sets whether the applet is allowed to access the scripting object.
 java.lang.String setParam(java.lang.String name, java.lang.String value)
          Sets a parameter.
 void setParams(java.util.Map<java.lang.String,java.lang.String> params)
          Sets a map of parameters (all existent parameters are removed first).
 void setVspace(java.lang.String vspace)
          Sets the vertical spacing in pixels around an applet.
 
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, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Applet

public Applet()
Method Detail

getCode

public java.lang.String getCode()
Return the applet class to run. Example: MyApplet.


setCode

public void setCode(java.lang.String code)
Sets the applet class to run.


getCodebase

public java.lang.String getCodebase()
Returns a relative base URL for applets specified in setCode(java.lang.String) (URL).

Default: null (no codebase at all).

Since:
3.6.2

setCodebase

public void setCodebase(java.lang.String codebase)
Sets a relative base URL for applets specified in setCode(java.lang.String) (URL).

Notice that, if URI is specified, it will be encoded (Execution.encodeURL(java.lang.String)).

Since:
3.6.2

isMayscript

public boolean isMayscript()
Returns whether the applet is allowed to access the scripting object.

Default: false.

It is only necessary for the applet to control the page script objects. It is not necessary for the page objects to control the applet.

Since:
5.0.3

setMayscript

public void setMayscript(boolean mayscript)
Sets whether the applet is allowed to access the scripting object.

Since:
5.0.3

getArchive

public java.lang.String getArchive()
Returns the location of an archive file (URL).

Default: null (no archive at all)

Since:
5.0.3

setArchive

public void setArchive(java.lang.String archive)
Sets the location of an archive file (URL).

Notice that, if URI is specified, it will be encoded (Execution.encodeURL(java.lang.String)).

Since:
5.0.3

getAlign

public java.lang.String getAlign()
Returns the alignment of an applet according to surrounding elements.

Default: null (browser default)

Since:
5.0.3

setAlign

public void setAlign(java.lang.String align)
Sets the alignment of an applet according to surrounding elements.

Refer to HTML <applet> Tagfor more information.

Since:
5.0.3

getHspace

public java.lang.String getHspace()
Returns the horizontal spacing around an applet.

Default: null (browser default)

Since:
5.0.3

setHspace

public void setHspace(java.lang.String hspace)
Sets the horizontal spacing in pixels around an applet.

Since:
5.0.3

getVspace

public java.lang.String getVspace()
Returns the vertical spacing around an applet.

Default: null (browser default)

Since:
5.0.3

setVspace

public void setVspace(java.lang.String vspace)
Sets the vertical spacing in pixels around an applet.

Since:
5.0.3

setParams

public void setParams(java.util.Map<java.lang.String,java.lang.String> params)
Sets a map of parameters (all existent parameters are removed first).


getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()
Returns a map of parameters (never null).


setParam

public java.lang.String setParam(java.lang.String name,
                                 java.lang.String value)
Sets a parameter. If the value is null, the parameter is removed.


getDynamicProperty

public java.lang.Object getDynamicProperty(java.lang.String name)
Description copied from interface: DynamicPropertied
Returns the property value of the specified name.

Specified by:
getDynamicProperty in interface DynamicPropertied

hasDynamicProperty

public boolean hasDynamicProperty(java.lang.String name)
Description copied from interface: DynamicPropertied
Returns whether a dynamic property is defined.

Specified by:
hasDynamicProperty in interface DynamicPropertied

setDynamicProperty

public void setDynamicProperty(java.lang.String name,
                               java.lang.Object value)
                        throws WrongValueException
Description copied from interface: DynamicPropertied
Sets a property with the specified name and value.

If a component supports only String-type values, it could use org.zkoss.lang.Objects.toString() to convert the value to a String instance.

Specified by:
setDynamicProperty in interface DynamicPropertied
Throws:
WrongValueException

invoke

public void invoke(java.lang.String function)
Invokes the function of the applet running at the client.


invoke

public void invoke(java.lang.String function,
                   java.lang.String argument)
Invokes the function of the applet running at the client with one argument.


invoke

public 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

public void setField(java.lang.String field,
                     java.lang.String value)
Sets the value of the specified filed.


isChildable

protected boolean isChildable()
No child is allowed.

Overrides:
isChildable in class AbstractComponent

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException
Description copied from class: HtmlBasedComponent
Renders the content of this component, excluding the enclosing tags and children.

See also ZK Client-side Reference: Property Rendering

Overrides:
renderProperties in class HtmlBasedComponent
Throws:
java.io.IOException


Copyright © 2005-2011 Potix Corporation. All Rights Reserved. SourceForge.net Logo