Package org.zkoss.zuti.zul

Class TemplateBasedShadowElement

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.AfterCompose, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.ShadowElement, org.zkoss.zk.ui.ShadowElementCtrl, org.zkoss.zk.ui.sys.ComponentCtrl
    Direct Known Subclasses:
    Apply, Choose, ForEach, If, Otherwise
    public abstract class TemplateBasedShadowElement
extends org.zkoss.zk.ui.HtmlShadowElement
    A template based skeleton class
    Since:
    8.0.0
    Author:
    jumperchen
    See Also:
    Serialized Form

    • Nested Class Summary

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

        org.zkoss.zk.ui.HtmlShadowElement.Direction

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

        org.zkoss.zk.ui.AbstractComponent.Children, org.zkoss.zk.ui.AbstractComponent.ForwardInfo, org.zkoss.zk.ui.AbstractComponent.TargetInfo

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean _dirtyBinding  
      static java.lang.String FOREACH_RENDERED_COMPONENTS
      foreach support list model (Component developer use only)
      static java.lang.String ON_BINDING_READY
      Component developer use only
      static java.lang.String SHADOW_VARIABLE
      Component developer use only

      • Fields inherited from class org.zkoss.zk.ui.HtmlShadowElement

        _afterComposed, _dynamicValue, BIND_ANNO, BINDER, FOREACH_IN_RENDER, INIT_ANNO, LOAD_ANNO, ON_REBUILD_SHADOW_TREE_LATER, REFERENCE_ANNO, SAVE_ANNO, SKIP_DISTRIBUTED_CHILDREN_PROPERTY_CHANGE

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addBindingListener()  
      void afterCompose()  
      java.lang.Object clone()  
      protected void compose​(org.zkoss.zk.ui.Component host)  
      void detach()  
      protected void docheck0()  
      protected boolean isBindingReady()
      Returns the current phase is in a binding ready state, if any.
      boolean isDirtyBinding()
      Internal used only
      boolean isDynamicValue()  
      protected boolean isEffective()  
      void onChildAdded​(org.zkoss.zk.ui.Component child)  
      void onChildRemoved​(org.zkoss.zk.ui.Component child)  
      protected void rebuildSubShadowTree()  
      protected void removeBindingListener()  

      • Methods inherited from class org.zkoss.zk.ui.HtmlShadowElement

        afterHostChildAdded, afterHostChildRemoved, asShadow, beforeChildAdded, beforeHostChildAdded, beforeHostChildRemoved, beforeHostParentChanged, beforeParentChanged, clearChildren, destroyIndexCacheMap, getDistributedChildren, getFirstInsertion, getIndex, getIndexCacheMap, getLastInsertion, getNextInsertion, getNextInsertionComponentIfAny, getPreviousInsertion, getPreviousInsertionComponentIfAny, getShadowHost, getShadowHostIfAny, initClone, initIndexCacheMap, inRange, invalidate, isDynamicValue, mergeSubTree, mergeToHost, onHostAttached, onHostChildAdded, onHostChildRemoved, onHostDetached, recreate, removeFromParent, resolveVariable, setDynamicValue, setParent, setPrevInsertion, setShadowHost, shrinkRange, stretchRange, toString, updateFirstInsertion, updateLastInsertion, updateNextInsertion, updatePreviousInsertion, updateSubBindingAnnotationCount

      • 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, beforeChildRemoved, 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, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getForwards, getId, getLastChild, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getPropertyAccess, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, isChildable, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onPageAttached, onPageDetached, onParentChanged, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, renderProperties, renderPropertiesOnly, replace, response, response, response, service, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ON_BINDING_READY

        public static java.lang.String ON_BINDING_READY
        Component developer use only

      • SHADOW_VARIABLE

        public static java.lang.String SHADOW_VARIABLE
        Component developer use only

      • FOREACH_RENDERED_COMPONENTS

        public static final java.lang.String FOREACH_RENDERED_COMPONENTS
        foreach support list model (Component developer use only)
        See Also:
        Constant Field Values

      • _dirtyBinding

        protected boolean _dirtyBinding

    • Constructor Detail

      • TemplateBasedShadowElement

        public TemplateBasedShadowElement()

    • Method Detail

      • onChildRemoved

        public void onChildRemoved​(org.zkoss.zk.ui.Component child)
        Specified by:
        onChildRemoved in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        onChildRemoved in class org.zkoss.zk.ui.AbstractComponent

      • onChildAdded

        public void onChildAdded​(org.zkoss.zk.ui.Component child)
        Specified by:
        onChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        onChildAdded in class org.zkoss.zk.ui.HtmlShadowElement

      • afterCompose

        public void afterCompose()
        Specified by:
        afterCompose in interface org.zkoss.zk.ui.ext.AfterCompose
        Overrides:
        afterCompose in class org.zkoss.zk.ui.HtmlShadowElement

      • isDynamicValue

        public boolean isDynamicValue()
        Specified by:
        isDynamicValue in interface org.zkoss.zk.ui.ShadowElementCtrl
        Overrides:
        isDynamicValue in class org.zkoss.zk.ui.HtmlShadowElement

      • rebuildSubShadowTree

        protected void rebuildSubShadowTree()
        Overrides:
        rebuildSubShadowTree in class org.zkoss.zk.ui.HtmlShadowElement

      • compose

        protected void compose​(org.zkoss.zk.ui.Component host)
        Specified by:
        compose in class org.zkoss.zk.ui.HtmlShadowElement

      • addBindingListener

        protected void addBindingListener()

      • removeBindingListener

        protected void removeBindingListener()

      • detach

        public void detach()
        Specified by:
        detach in interface org.zkoss.zk.ui.Component
        Specified by:
        detach in interface org.zkoss.zk.ui.ShadowElement
        Overrides:
        detach in class org.zkoss.zk.ui.HtmlShadowElement

      • isBindingReady

        protected boolean isBindingReady()
        Returns the current phase is in a binding ready state, if any. It is used for sub-class to check the state in a HtmlShadowElement.recreate() method.

      • isEffective

        protected boolean isEffective()
        Specified by:
        isEffective in class org.zkoss.zk.ui.HtmlShadowElement

      • clone

        public java.lang.Object clone()
        Specified by:
        clone in interface org.zkoss.zk.ui.Component
        Overrides:
        clone in class org.zkoss.zk.ui.HtmlShadowElement

      • docheck0

        protected void docheck0()

      • isDirtyBinding

        public boolean isDirtyBinding()
        Internal used only