org.zkoss.zml
Class XmlNativeComponent

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zml.XmlNativeComponent
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.DynamicPropertied, org.zkoss.zk.ui.ext.DynamicTag, org.zkoss.zk.ui.ext.Native, org.zkoss.zk.ui.ext.NonFellow, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class XmlNativeComponent
extends org.zkoss.zk.ui.AbstractComponent
implements org.zkoss.zk.ui.ext.DynamicTag, org.zkoss.zk.ui.ext.Native

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

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 renderred (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
static class XmlNativeComponent.XmlHelper
          The HTML helper.
 
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.AbstractComponent.Children
 
Nested classes/interfaces inherited from interface org.zkoss.zk.ui.ext.Native
org.zkoss.zk.ui.ext.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
CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
 
Constructor Summary
XmlNativeComponent()
           
XmlNativeComponent(java.lang.String tag)
           
 
Method Summary
 void addDeclaredNamespace(org.zkoss.idom.Namespace ns)
           
 java.util.List<org.zkoss.idom.Namespace> getDeclaredNamespaces()
           
 java.lang.Object getDynamicProperty(java.lang.String name)
           
 java.lang.String getEpilogContent()
           
 org.zkoss.zk.ui.ext.Native.Helper getHelper()
           
 java.lang.String getPrologContent()
           
 java.lang.String getTag()
          Returns the tag name, or null if plain text.
 boolean hasDynamicProperty(java.lang.String name)
           
 boolean hasTag(java.lang.String tag)
           
 void redraw(java.io.Writer out)
           
 void setDynamicProperty(java.lang.String name, java.lang.Object value)
           
 void setEpilogContent(java.lang.String epilog)
           
 void setId(java.lang.String id)
           
 void setPrologContent(java.lang.String prolog)
           
 void setTag(java.lang.String tag)
          Sets the tag name.
 boolean setVisible(boolean visible)
           
 
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, clone, 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, getExtraCtrl, 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, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, renderProperties, replace, response, response, response, service, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, 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

XmlNativeComponent

public XmlNativeComponent()

XmlNativeComponent

public XmlNativeComponent(java.lang.String tag)
Method Detail

getTag

public java.lang.String getTag()
Returns the tag name, or null if plain text.


getDeclaredNamespaces

public java.util.List<org.zkoss.idom.Namespace> getDeclaredNamespaces()
Specified by:
getDeclaredNamespaces in interface org.zkoss.zk.ui.ext.Native

addDeclaredNamespace

public void addDeclaredNamespace(org.zkoss.idom.Namespace ns)
Specified by:
addDeclaredNamespace in interface org.zkoss.zk.ui.ext.Native

getPrologContent

public java.lang.String getPrologContent()
Specified by:
getPrologContent in interface org.zkoss.zk.ui.ext.Native

setPrologContent

public void setPrologContent(java.lang.String prolog)
Specified by:
setPrologContent in interface org.zkoss.zk.ui.ext.Native

getEpilogContent

public java.lang.String getEpilogContent()
Specified by:
getEpilogContent in interface org.zkoss.zk.ui.ext.Native

setEpilogContent

public void setEpilogContent(java.lang.String epilog)
Specified by:
setEpilogContent in interface org.zkoss.zk.ui.ext.Native

getHelper

public org.zkoss.zk.ui.ext.Native.Helper getHelper()
Specified by:
getHelper in interface org.zkoss.zk.ui.ext.Native

setId

public void setId(java.lang.String id)
Specified by:
setId in interface org.zkoss.zk.ui.Component
Overrides:
setId in class org.zkoss.zk.ui.AbstractComponent

setVisible

public boolean setVisible(boolean visible)
Specified by:
setVisible in interface org.zkoss.zk.ui.Component
Overrides:
setVisible in class org.zkoss.zk.ui.AbstractComponent

redraw

public void redraw(java.io.Writer out)
            throws java.io.IOException
Specified by:
redraw in interface org.zkoss.zk.ui.sys.ComponentCtrl
Overrides:
redraw in class org.zkoss.zk.ui.AbstractComponent
Throws:
java.io.IOException

setTag

public void setTag(java.lang.String tag)
            throws org.zkoss.zk.ui.WrongValueException
Sets the tag name.

Specified by:
setTag in interface org.zkoss.zk.ui.ext.DynamicTag
Parameters:
tag - the tag name. If null or empty, plain text is assumed.
Throws:
org.zkoss.zk.ui.WrongValueException

hasTag

public boolean hasTag(java.lang.String tag)
Specified by:
hasTag in interface org.zkoss.zk.ui.ext.DynamicTag

hasDynamicProperty

public boolean hasDynamicProperty(java.lang.String name)
Specified by:
hasDynamicProperty in interface org.zkoss.zk.ui.ext.DynamicPropertied

getDynamicProperty

public java.lang.Object getDynamicProperty(java.lang.String name)
Specified by:
getDynamicProperty in interface org.zkoss.zk.ui.ext.DynamicPropertied

setDynamicProperty

public void setDynamicProperty(java.lang.String name,
                               java.lang.Object value)
                        throws org.zkoss.zk.ui.WrongValueException
Specified by:
setDynamicProperty in interface org.zkoss.zk.ui.ext.DynamicPropertied
Throws:
org.zkoss.zk.ui.WrongValueException


Copyright © 2012. All Rights Reserved.