Package org.zkoss.zk.ui

Class HtmlNativeComponent

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlNativeComponent

All Implemented Interfaces:

Serializable, Cloneable, Component, DynamicPropertied, DynamicTag, Native, NonFellow, Scope, ComponentCtrl

public class HtmlNativeComponent
extends AbstractComponent
implements DynamicTag, Native

A component used to represent XML elements that are associated with the native namespace (http://www.zkoss.org/2005/zk/native).

It contains the content that shall be sent directly to client. It has three parts: prolog, children and epilog. The prolog (getPrologContent()) and epilog (getEpilogContent()) are both String.

When this component is rendered (redraw(java.io.Writer)), it generates the prolog first, the children and then the epilog.

Since:

3.0.0

Author:

tomyeh

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	HtmlNativeComponent.ExtraCtrl
static class	HtmlNativeComponent.HtmlHelper	The HTML helper.

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

AbstractComponent.Children, AbstractComponent.ForwardInfo, AbstractComponent.TargetInfo

Nested classes/interfaces inherited from interface org.zkoss.zk.ui.ext.Native

Native.Helper

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

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

AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_CLONED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor	Description
HtmlNativeComponent()	Constructs a HtmlNativeComponent component.
HtmlNativeComponent(String tag)	Constructs a HtmlNativeComponent component with the specified tag name.
HtmlNativeComponent(String tag, String prolog, String epilog)	Constructs a HtmlNativeComponent component with the specified prolog and epilog.

Method Summary

Modifier and Type	Method	Description
void	addDeclaredNamespace(org.zkoss.idom.Namespace ns)	Adds a declared namespace.
List<org.zkoss.idom.Namespace>	getDeclaredNamespaces()	Returns a readonly list of the declared namespaces (Namespace), or empty if no declared namespace.
Map<String,Object>	getDynamicProperties()	Returns all available dynamic properties.
Object	getDynamicProperty(String name)	Returns the property value of the specified name.
String	getEpilogContent()	Returns the epilog content.
Object	getExtraCtrl()	Returns the extra controls that tell ZK how to handle this component specially.
Native.Helper	getHelper()	Returns the helper to generate the output of the native components.
String	getPrologContent()	Returns the prolog content.
PropertyAccess	getPropertyAccess(String prop)	Returns the corresponding property access object from the given property name, if any.
String	getTag()	Returns the tag name, or null if plain text.
String	getWidgetClass()	Returns the widget class, "zk.Native".
boolean	hasDynamicProperty(String name)	Returns whether a dynamic property is defined.
boolean	hasTag(String tag)	Returns whether the specified tag is allowed.
void	redraw(Writer out)	Redraws this component and all its descendants.
protected void	renderProperties(ContentRenderer renderer)	Called by (ComponentCtrl.redraw(java.io.Writer)) to render the properties, excluding the enclosing tag and children.
void	setDynamicProperty(String name, Object value)	Sets a property with the specified name and value.
void	setEpilogContent(String epilog)	Sets the epilog content.
void	setPrologContent(String prolog)	Sets the prolog content.
void	setTag(String tag)	Sets the tag name.
boolean	setVisible(boolean visible)	Sets whether this component is visible.

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

addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, clone, destroyIndexCacheMap, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, disableHostChanged, enableBindingAnnotation, enableHostChanged, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getForwards, getId, getIndexCacheMap, getLastChild, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getStubonlyDescendants, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttributeNames, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, initIndexCacheMap, insertBefore, invalidate, isChildable, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onParentChanged, onWrongValue, query, queryAll, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, renderPropertiesOnly, replace, response, response, response, service, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setStubonlyDescendants, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlNativeComponent

public HtmlNativeComponent()

Constructs a HtmlNativeComponent component.

HtmlNativeComponent

public HtmlNativeComponent(String tag)

Constructs a HtmlNativeComponent component with the specified tag name.

Parameters:

tag - the tag name. If null or empty, plain text is assumed.

HtmlNativeComponent

public HtmlNativeComponent(String tag,
 String prolog,
 String epilog)

Constructs a HtmlNativeComponent component with the specified prolog and epilog.

Parameters:

tag - the tag name. If null or empty, plain text is assumed.

prolog - the content right before the children, if any.

epilog - the content right after the children, if any.

Method Details

getWidgetClass

public String getWidgetClass()

Returns the widget class, "zk.Native".

Specified by:

getWidgetClass in interface Component

Overrides:

getWidgetClass in class AbstractComponent

Since:

5.0.0

See Also:

• Component.setWidgetClass(java.lang.String)

getTag

public String getTag()

Returns the tag name, or null if plain text.

getDeclaredNamespaces

public List<org.zkoss.idom.Namespace> getDeclaredNamespaces()

Description copied from interface: Native

Returns a readonly list of the declared namespaces (Namespace), or empty if no declared namespace.

Specified by:

getDeclaredNamespaces in interface Native

addDeclaredNamespace

public void addDeclaredNamespace(org.zkoss.idom.Namespace ns)

Description copied from interface: Native

Adds a declared namespace. The added declared namespace will be generated to the output.

Specified by:

addDeclaredNamespace in interface Native

Parameters:

ns - the namespace (never null).

getPrologContent

public String getPrologContent()

Description copied from interface: Native

Returns the prolog content. It is the content generated before the child components, if any.

Default: empty ("").

Specified by:

getPrologContent in interface Native

setPrologContent

public void setPrologContent(String prolog)

Description copied from interface: Native

Sets the prolog content. It is the content generated before the child components, if any.

Specified by:

setPrologContent in interface Native

getEpilogContent

public String getEpilogContent()

Description copied from interface: Native

Returns the epilog content. It is the content generated before the child components, if any.

Default: empty ("").

Specified by:

getEpilogContent in interface Native

setEpilogContent

public void setEpilogContent(String epilog)

Description copied from interface: Native

Sets the epilog content. It is the content generated before the child components, if any.

Specified by:

setEpilogContent in interface Native

getHelper

public Native.Helper getHelper()

Description copied from interface: Native

Returns the helper to generate the output of the native components.

Specified by:

getHelper in interface Native

setVisible

public boolean setVisible(boolean visible)

Description copied from interface: Component

Sets whether this component is visible. A component is visible by default. Both visible and invisible components are rendered in a browser's DOM. But an invisible component's DOM elements with CSS display:none. Since a DOM element will inherit its parent's CSS rules, a component is visible only if all of its parents are also visible.
To remove a component's DOM elements, use Component.detach().

Specified by:

setVisible in interface Component

Overrides:

setVisible in class AbstractComponent

Returns:

the previous visibility

redraw

public void redraw(Writer out)
            throws IOException

Description copied from class: AbstractComponent

Redraws this component and all its descendants.

Default: It uses JsContentRenderer to render all information in JavaScript codes. For devices that don't support JavaScript, it must override this method.

To generate all information, it first invokes AbstractComponent.renderProperties(org.zkoss.zk.ui.sys.ContentRenderer) to render component's properties, and then AbstractComponent.redrawChildren(java.io.Writer) to redraw children (and descendants) (by calling their AbstractComponent.redraw(java.io.Writer)).

If a derived class wants to render more properties, it can override AbstractComponent.renderProperties(org.zkoss.zk.ui.sys.ContentRenderer).

If a derived class renders only a subset of its children (such as paging/cropping), it could override AbstractComponent.redrawChildren(java.io.Writer).

If a deriving class wants to do something before AbstractComponent.renderProperties(org.zkoss.zk.ui.sys.ContentRenderer), it has to override AbstractComponent.redraw(java.io.Writer).

If a deriving class doesn't want to render in JavaScript codes, it has to override AbstractComponent.redraw(java.io.Writer) with the proper implementation of ContentRenderer.

Specified by:

redraw in interface ComponentCtrl

Overrides:

redraw in class AbstractComponent

Throws:

IOException

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws IOException

Description copied from class: AbstractComponent

Called by (ComponentCtrl.redraw(java.io.Writer)) to render the properties, excluding the enclosing tag and children.

Default: it renders AbstractComponent.getId() if it was assigned, and event names if listened (and listed in AbstractComponent.getClientEvents()).

Note: it doesn't render AbstractComponent.getWidgetClass(), AbstractComponent.getUuid() and AbstractComponent.getMold(), which are caller's job.

Overrides:

renderProperties in class AbstractComponent

Throws:

IOException

setTag

public void setTag(String tag)
            throws WrongValueException

Sets the tag name.

Specified by:

setTag in interface DynamicTag

Parameters:

tag - the tag name. If null or empty, plain text is assumed.

Throws:

WrongValueException

hasTag

public boolean hasTag(String tag)

Description copied from interface: DynamicTag

Returns whether the specified tag is allowed.

Specified by:

hasTag in interface DynamicTag

hasDynamicProperty

public boolean hasDynamicProperty(String name)

Description copied from interface: DynamicPropertied

Returns whether a dynamic property is defined.

Specified by:

hasDynamicProperty in interface DynamicPropertied

getDynamicProperty

public Object getDynamicProperty(String name)

Description copied from interface: DynamicPropertied

Returns the property value of the specified name.

Specified by:

getDynamicProperty in interface DynamicPropertied

getDynamicProperties

public Map<String,Object> getDynamicProperties()

Description copied from interface: DynamicPropertied

Returns all available dynamic properties.

Specified by:

getDynamicProperties in interface DynamicPropertied

setDynamicProperty

public void setDynamicProperty(String name,
 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

getPropertyAccess

public PropertyAccess getPropertyAccess(String prop)

Description copied from interface: ComponentCtrl

Returns the corresponding property access object from the given property name, if any.

Specified by:

getPropertyAccess in interface ComponentCtrl

Overrides:

getPropertyAccess in class AbstractComponent

Parameters:

prop - the name of the property

Returns:

null it means not to support for the property name.

getExtraCtrl

public Object getExtraCtrl()

Description copied from class: AbstractComponent

Returns the extra controls that tell ZK how to handle this component specially. It is used only by component developers.

Default: null.

Specified by:

getExtraCtrl in interface ComponentCtrl

Overrides:

getExtraCtrl in class AbstractComponent

Returns:

null if no special handling required. If the component requires some special controls, it could return an object that implements one or several interfaces in the org.zkoss.zk.ui.ext.render package. For example, Cropper.

See Also:

• ComponentCtrl.getExtraCtrl()