Uses of Interface
org.zkoss.zk.ui.Component
-
-
Uses of Component in org.zkoss.zk.au
Methods in org.zkoss.zk.au with type parameters of type Component Modifier and Type Method Description static <T extends Component>
java.util.Set<T>AuRequests. convertToItems(Desktop desktop, java.util.List<java.lang.String> uuids)Converts the data of the specified request to a set of Component.Methods in org.zkoss.zk.au that return Component Modifier and Type Method Description ComponentAuRequest. getComponent()Returns the component that this request is applied for, or null if it applies to the whole page or a general request.Constructors in org.zkoss.zk.au with parameters of type Component Constructor Description AuResponse(java.lang.String cmd, Component depends, java.lang.Object data)Constructs a response with one or zero data.AuResponse(java.lang.String cmd, Component depends, java.lang.Object[] data)Constructs a response with multiple data.JSONComponent(Component comp) -
Uses of Component in org.zkoss.zk.au.out
Methods in org.zkoss.zk.au.out with parameters of type Component Modifier and Type Method Description static java.lang.ObjectAuEcho. getData(Component comp, java.lang.Object key)Retrieves the data associated with an echo event.Constructors in org.zkoss.zk.au.out with parameters of type Component Constructor Description AuAppendChild(Component comp, java.util.Collection<java.lang.String> contents)AuClearBusy(Component comp)Constructs a command to remove a busy message covering only the specified component.AuClearWrongValue(Component comp)Unlike other constructors, the object instantiated by this method depends on the specified comp.AuClearWrongValue(Component[] comps)AuEcho(Component comp, java.lang.String evtnm, java.lang.Object data)Constructs an echo response that will cause an event to fire when the client echoes back.AuEcho(Component comp, java.lang.String evtnm, java.lang.String data)Constructs an echo response that will cause an event to fire when the client echoes back.AuFocus(Component comp)AuInsertAfter(Component anchor, java.util.Collection<java.lang.String> contents)AuInsertBefore(Component anchor, java.util.Collection<java.lang.String> contents)AuInvoke(Component comp, java.lang.String function)Construct AuInvoke to call the peer widget's member function with no argument.AuInvoke(Component comp, java.lang.String function, boolean arg)Construct AuInvoke to call the peer widget's member function with one boolean argument.AuInvoke(Component comp, java.lang.String function, double arg)Construct AuInvoke to call the peer widget's member function with one double argument.AuInvoke(Component comp, java.lang.String function, int arg)Construct AuInvoke to call the peer widget's member function with one int argument.AuInvoke(Component comp, java.lang.String function, java.lang.Object arg)Construct AuInvoke to call the peer widget's member function with one argument.AuInvoke(Component comp, java.lang.String function, java.lang.Object... args)Construct AuInvoke to call the peer widget's member function with an array of the given arguments.AuInvoke(Component comp, java.lang.String function, java.lang.Object arg1, java.lang.Object arg2)Construct AuInvoke to call the peer widget's member function with two arguments.AuInvoke(Component comp, java.lang.String function, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3)Construct AuInvoke to call the peer widget's member function with three arguments.AuInvoke(Component comp, java.lang.String function, java.lang.String... args)Construct AuInvoke to call a client function with variable number of arguments.AuNotification(java.lang.String msg, java.lang.String type, Page page, Component ref, int x, int y, int duration, boolean closable)Shows notification at given coordinateAuNotification(java.lang.String msg, java.lang.String type, Page page, Component ref, java.lang.String position, int duration, boolean closable)Shows notification at predefined position.AuOuter(Component comp, java.lang.String content)AuResizeWidget(Component comp)Constructs a command to force ZK Client re-calculate the size of the given widget.AuScript(Component depends, java.lang.String script)AuScrollIntoView(Component comp)Constructor.AuSelect(Component comp)AuSelect(Component comp, int beg, int end)AuSetAttribute(Component comp, java.lang.String attr, java.lang.Object val)Construct an instance for miscellaneous values, such as Boolean, Integer and so on.AuSetAttributes(Component comp, AuSetAttribute... attrs)Construct an instance for miscellaneous values, such as Boolean, Integer and so on.AuShowBusy(Component comp, java.lang.String mesg)Constructs a busy message covering only the specified component.AuSyncErrorbox(Component comp)A constructor for asking the client to sync position of a widget and its the errorbox.AuUuid(Component comp, java.lang.String oldid)AuWrongValue(Component comp, java.lang.String message)Constructor parameters in org.zkoss.zk.au.out with type arguments of type Component Constructor Description AuClearWrongValue(java.util.List<? extends Component> comps) -
Uses of Component in org.zkoss.zk.ui
Classes in org.zkoss.zk.ui that implement Component Modifier and Type Class Description classAbstractComponentA skeletal implementation ofComponent.classHtmlBasedComponentA skeletal implementation for HTML based components.classHtmlMacroComponentThe implementation of a macro component for HTML-based clients.classHtmlNativeComponentA component used to represent XML elements that are associated with the native namespace (http://www.zkoss.org/2005/zk/native).classHtmlShadowElementA skeleton of shadow element that represents as a shadow tree.Methods in org.zkoss.zk.ui with type parameters of type Component Modifier and Type Method Description <T extends Component>
java.util.List<T>AbstractComponent. getChildren()Returns a live list of children.<T extends Component>
java.util.List<T>Component. getChildren()Returns a live list of children.<T extends Component>
java.util.List<T>HtmlShadowElement. getDistributedChildren()<T extends Component>
java.util.List<T>ShadowElement. getDistributedChildren()Returns a list of distributed components of the shadow tree, including its descendant.Methods in org.zkoss.zk.ui that return Component Modifier and Type Method Description Component[]Execution. createComponents(java.lang.String uri, java.util.Map<?,?> arg)Creates components that don't belong to any page from a page file specified by an URI.ComponentExecution. createComponents(java.lang.String uri, Component parent, java.util.Map<?,?> arg)Creates components from a page file specified by an URI.ComponentExecution. createComponents(java.lang.String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Creates components from a page file specified by an URI with a custom variable resolver and inserts before a particular component.Component[]Execution. createComponents(java.lang.String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)Creates components from a page file specified by an URI with a custom variable resolver and inserts before a particular component.Component[]Execution. createComponents(java.lang.String uri, Page page, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)Creates components that belong to the given page from a page file specified by an URI.Component[]Execution. createComponents(PageDefinition pagedef, java.util.Map<?,?> arg)Creates components that don't belong to any page from the specified page definition.ComponentExecution. createComponents(PageDefinition pagedef, Component parent, java.util.Map<?,?> arg)Creates components from the specified page definition.ComponentExecution. createComponents(PageDefinition pagedef, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Creates components from the specified page definition with a custom variable resolver and inserts before a particular component.static ComponentExecutions. createComponents(java.lang.String uri, Component parent, java.util.Map<?,?> arg)Creates components from a page file specified by an URI.static Component[]Executions. createComponents(java.lang.String uri, Page page, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)Creates components that belong to the given page from a page file specified by an URI.static ComponentExecutions. createComponents(PageDefinition pagedef, Component parent, java.util.Map<?,?> arg)Creates components based on the specified page definition.static Component[]Executions. createComponents(WebApp wapp, java.lang.String uri, java.util.Map<?,?> arg)Creates components that don't belong to any page from a page file specified by an URI.static Component[]Executions. createComponents(WebApp wapp, PageDefinition pagedef, java.util.Map<?,?> arg)Creates components that don't belong to any page from the specified page definition.Component[]Execution. createComponentsDirectly(java.io.Reader reader, java.lang.String extension, java.util.Map<?,?> arg)Creates components that don't belong to any page from the raw content read from the specified reader.ComponentExecution. createComponentsDirectly(java.io.Reader reader, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content read from the specified reader.ComponentExecution. createComponentsDirectly(java.io.Reader reader, java.lang.String extension, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Creates components from the raw content read from the specified reader with a custom variable resolver and inserts before a particular component.Component[]Execution. createComponentsDirectly(java.lang.String content, java.lang.String extension, java.util.Map<?,?> arg)Creates components that don't belong to any page from the raw content specified by a string.ComponentExecution. createComponentsDirectly(java.lang.String content, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content specified by a string.ComponentExecution. createComponentsDirectly(java.lang.String content, java.lang.String extension, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Creates components from the raw content specified by a string with a custom variable resolver and inserts before a particular component.Component[]Execution. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String extension, java.util.Map<?,?> arg)Creates components that don't belong to any page from the raw content specified by a DOM tree.ComponentExecution. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content specified by a DOM tree.ComponentExecution. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String extension, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Creates components from the raw content specified by a DOM tree with a custom variable resolver and inserts before a particular component.static ComponentExecutions. createComponentsDirectly(java.io.Reader reader, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content read from the specified reader.static ComponentExecutions. createComponentsDirectly(java.lang.String content, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content specified by a string.static ComponentExecutions. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content specified by a DOM tree.static Component[]Executions. createComponentsDirectly(WebApp wapp, java.io.Reader reader, java.lang.String extension, java.util.Map<?,?> arg)Creates components that don't belong to any page from the raw content read from the specified reader.static Component[]Executions. createComponentsDirectly(WebApp wapp, java.lang.String content, java.lang.String extension, java.util.Map<?,?> arg)Creates components that don't belong to any page from the raw content specified by a string.static Component[]Executions. createComponentsDirectly(WebApp wapp, org.zkoss.idom.Document content, java.lang.String extension, java.util.Map<?,?> arg)Creates components that don't belong to any page from the raw content specified by a DOM tree.ComponentPath. getComponent()Returns the component with this path, or null if no such component.static ComponentPath. getComponent(java.lang.String path)Returns the component of the specified path, or null if no such component.static ComponentPath. getComponent(IdSpace is, java.lang.String path)Returns the component of the specified path which is related to the specified ID space, or null if no such component.ComponentWrongValueException. getComponent()Returns the component that causes this exception, or null.ComponentDesktop. getComponentByUuid(java.lang.String uuid)Returns the component of the specified UUID (getUuid()).ComponentDesktop. getComponentByUuidIfAny(java.lang.String uuid)Returns the component of the specified UUID (getUuid()), or null if not found.ComponentAbstractComponent. getFellow(java.lang.String compId)ComponentAbstractComponent. getFellow(java.lang.String compId, boolean recurse)ComponentAbstractPage. getFellow(java.lang.String compId)ComponentAbstractPage. getFellow(java.lang.String compId, boolean recurse)The same asAbstractPage.getFellow(String).ComponentComponent. getFellow(java.lang.String id)Returns a component of the specified ID in the same ID space.ComponentComponent. getFellow(java.lang.String id, boolean recurse)Returns a component of the specified ID in the same ID space.ComponentIdSpace. getFellow(java.lang.String id)Returns a component of the specified ID in this ID space.ComponentIdSpace. getFellow(java.lang.String id, boolean recurse)Returns a component of the specified ID in this ID space.ComponentAbstractComponent. getFellowIfAny(java.lang.String compId)ComponentAbstractComponent. getFellowIfAny(java.lang.String compId, boolean recurse)ComponentAbstractPage. getFellowIfAny(java.lang.String compId)ComponentAbstractPage. getFellowIfAny(java.lang.String compId, boolean recurse)The same asAbstractPage.getFellowIfAny(String).ComponentComponent. getFellowIfAny(java.lang.String id)Returns a component of the specified ID in the same ID space, or null if not found.ComponentComponent. getFellowIfAny(java.lang.String id, boolean recurse)Returns a component of the specified ID in the same ID space, or null if not found.ComponentIdSpace. getFellowIfAny(java.lang.String id)Returns a component of the specified ID in this ID space, or null if not found.ComponentIdSpace. getFellowIfAny(java.lang.String id, boolean recurse)Returns a component of the specified ID in this ID space, or null if not found.ComponentAbstractComponent. getFirstChild()ComponentComponent. getFirstChild()Returns the first child component, or null if no child at all.ComponentHtmlShadowElement. getFirstInsertion()Returns the first component of its insertion range.ComponentShadowElement. getFirstInsertion()Returns the first component of its insertion range.ComponentShadowElementCtrl. getFirstInsertion()Returns the first component of its insertion range.ComponentAbstractPage. getFirstRoot()ComponentPage. getFirstRoot()Returns the first root component.ComponentAbstractComponent. getLastChild()ComponentComponent. getLastChild()Returns the last child component, or null if no child at all.ComponentHtmlShadowElement. getLastInsertion()Returns the last component of its insertion range.ComponentShadowElement. getLastInsertion()Returns the last component of its insertion range.ComponentShadowElementCtrl. getLastInsertion()Returns the last component of its insertion range.ComponentAbstractPage. getLastRoot()ComponentPage. getLastRoot()Returns the last root component.ComponentHtmlShadowElement. getNextInsertion()Returns the next insertion point, it may be a component, a shadow element, or null.ComponentShadowElement. getNextInsertion()Returns the next insertion point, it may be a component, a shadow element, or null.ComponentShadowElementCtrl. getNextInsertion()Returns the next insertion point, it may be a component, a shadow element, or null.ComponentHtmlShadowElement. getNextInsertionComponentIfAny()Returns the next component before this shadow, if any.ComponentAbstractComponent. getNextSibling()ComponentComponent. getNextSibling()Returns the next sibling, or null if it is the last child.ComponentAbstractComponent. getParent()ComponentComponent. getParent()Returns the parent component, or null if this is the root component.ComponentHtmlShadowElement. getPreviousInsertion()Returns the previous insertion point, it may be a component, a shadow element, or null.ComponentShadowElement. getPreviousInsertion()Returns the previous insertion point, it may be a component, a shadow element, or null.ComponentShadowElementCtrl. getPreviousInsertion()Returns the previous insertion point, it may be a component, a shadow element, or null.ComponentHtmlShadowElement. getPreviousInsertionComponentIfAny()Returns the first component before this shadow, if any.ComponentAbstractComponent. getPreviousSibling()ComponentComponent. getPreviousSibling()Returns the previous sibling, or null if it is the first child.ComponentAbstractComponent. getRoot()Returns the root of the specified component.ComponentComponent. getRoot()Returns the root of this component.static ComponentComponents. getRoot(Component comp)Returns the root component of the specified one.ComponentHtmlShadowElement. getShadowHost()ComponentShadowElement. getShadowHost()Returns the owner component that hosts this shadow element.ComponentHtmlShadowElement. getShadowHostIfAny()ComponentShadowElementCtrl. getShadowHostIfAny()Return the shadow host from it or its ancestor, if any.ComponentHtmlNativeComponent.HtmlHelper. newNative(java.lang.String text)static ComponentComponents. pathToComponent(java.lang.String path, Component ref)Converts a path, generated byComponents.componentToPath(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component), to a component.ComponentAbstractComponent. query(java.lang.String selector)ComponentComponent. query(java.lang.String selector)Find the first component that matches the given CSS3 selector.Methods in org.zkoss.zk.ui that return types with arguments of type Component Modifier and Type Method Description java.util.Collection<Component>Desktop. getComponents()Returns all components contained in this desktop.java.util.Collection<Component>AbstractComponent. getFellows()java.util.Collection<Component>AbstractPage. getFellows()java.util.Collection<Component>Component. getFellows()Returns all fellows in the same ID space of this component.java.util.Collection<Component>IdSpace. getFellows()Returns all fellows in this ID space.protected java.util.Map<Component,java.lang.Integer>AbstractComponent. getIndexCacheMap(Component host)java.util.Map<Component,java.lang.Integer>HtmlShadowElement. getIndexCacheMap(Component host)Internal usejava.util.Collection<Component>AbstractPage. getRoots()java.util.Collection<Component>Page. getRoots()Returns a readonly list of the root components.static java.util.Collection<Component>Components. getVisibleChildren(Component comp)Returns a collection of visible children.protected java.util.Map<Component,java.lang.Integer>AbstractComponent. initIndexCacheMap(Component host)java.util.Map<Component,java.lang.Integer>HtmlShadowElement. initIndexCacheMap(Component host)Internal usejava.util.ListIterator<Component>AbstractComponent.Children. listIterator(int index)java.lang.Iterable<Component>AbstractComponent. queryAll(java.lang.String selector)java.lang.Iterable<Component>Component. queryAll(java.lang.String selector)Returns an iterable object for components that match the given CSS3 selector.Methods in org.zkoss.zk.ui with parameters of type Component Modifier and Type Method Description booleanAbstractComponent. addForward(java.lang.String orgEvent, Component target, java.lang.String targetEvent)booleanAbstractComponent. addForward(java.lang.String orgEvent, Component target, java.lang.String targetEvent, java.lang.Object eventData)booleanComponent. addForward(java.lang.String originalEvent, Component target, java.lang.String targetEvent)Adds a forward condition to forward the event received by this component to another component.booleanComponent. addForward(java.lang.String originalEvent, Component target, java.lang.String targetEvent, java.lang.Object eventData)Adds a forward condition to forward the event received by this component to another component with extra event data.protected voidAbstractComponent. addMoved(Component oldparent, Page oldpg, Page newpg)Called when this component is moved from the specified parent and/or page to the new page.voidHtmlShadowElement. afterHostChildAdded(Component child, int indexOfChild)voidShadowElementCtrl. afterHostChildAdded(Component child, int indexOfChild)Called when a child is added to the host.voidHtmlShadowElement. afterHostChildRemoved(Component child)voidShadowElementCtrl. afterHostChildRemoved(Component child)Called when a child is removed to the host.booleanAbstractComponent. appendChild(Component child)Appends a child to the end of all children.booleanComponent. appendChild(Component child)Appends a child.voidAbstractComponent. beforeChildAdded(Component child, Component insertBefore)Default: does nothing.voidHtmlShadowElement. beforeChildAdded(Component child, Component refChild)voidAbstractComponent. beforeChildRemoved(Component child)Default: does nothing.voidHtmlShadowElement. beforeHostChildAdded(Component child, Component insertBefore, int indexOfInsertBefore)voidShadowElementCtrl. beforeHostChildAdded(Component child, Component insertBefore, int indexOfInsertBefore)Called before the host adding a child.voidHtmlShadowElement. beforeHostChildRemoved(Component child, int indexOfChild)voidShadowElementCtrl. beforeHostChildRemoved(Component child, int indexOfChild)Called before the host removing a child.voidHtmlShadowElement. beforeHostParentChanged(Component parent)voidShadowElementCtrl. beforeHostParentChanged(Component parent)Called before the host changing the parent.voidAbstractComponent. beforeParentChanged(Component parent)Default: If parent is null, execute the @Destroy method if any.voidHtmlShadowElement. beforeParentChanged(Component parent)static java.lang.StringComponents. componentToPath(Component comp, Component ref)Converts a component to a path (relevant to another component).protected abstract voidHtmlShadowElement. compose(Component host)Composes the shadow element.ComponentExecution. createComponents(java.lang.String uri, Component parent, java.util.Map<?,?> arg)Creates components from a page file specified by an URI.ComponentExecution. createComponents(java.lang.String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Creates components from a page file specified by an URI with a custom variable resolver and inserts before a particular component.Component[]Execution. createComponents(java.lang.String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)Creates components from a page file specified by an URI with a custom variable resolver and inserts before a particular component.ComponentExecution. createComponents(PageDefinition pagedef, Component parent, java.util.Map<?,?> arg)Creates components from the specified page definition.ComponentExecution. createComponents(PageDefinition pagedef, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Creates components from the specified page definition with a custom variable resolver and inserts before a particular component.static ComponentExecutions. createComponents(java.lang.String uri, Component parent, java.util.Map<?,?> arg)Creates components from a page file specified by an URI.static ComponentExecutions. createComponents(PageDefinition pagedef, Component parent, java.util.Map<?,?> arg)Creates components based on the specified page definition.ComponentExecution. createComponentsDirectly(java.io.Reader reader, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content read from the specified reader.ComponentExecution. createComponentsDirectly(java.io.Reader reader, java.lang.String extension, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Creates components from the raw content read from the specified reader with a custom variable resolver and inserts before a particular component.ComponentExecution. createComponentsDirectly(java.lang.String content, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content specified by a string.ComponentExecution. createComponentsDirectly(java.lang.String content, java.lang.String extension, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Creates components from the raw content specified by a string with a custom variable resolver and inserts before a particular component.ComponentExecution. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content specified by a DOM tree.ComponentExecution. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String extension, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Creates components from the raw content specified by a DOM tree with a custom variable resolver and inserts before a particular component.static ComponentExecutions. createComponentsDirectly(java.io.Reader reader, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content read from the specified reader.static ComponentExecutions. createComponentsDirectly(java.lang.String content, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content specified by a string.static ComponentExecutions. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String extension, Component parent, java.util.Map<?,?> arg)Creates components from the raw content specified by a DOM tree.protected voidAbstractComponent. destroyIndexCacheMap(Component host)voidHtmlShadowElement. destroyIndexCacheMap(Component host)Internal usejava.lang.ObjectExecution. evaluate(Component comp, java.lang.String expr, java.lang.Class<?> expectedType)Evaluates the specified expression with ${link #getVariableResolver} andPage.getFunctionMapper()of the page of the specified component.static java.lang.ObjectExecutions. evaluate(Component comp, java.lang.String expr, java.lang.Class expectedType)Evaluates the specified expression by use of the current context (Executions.getCurrent()).static ComposerComponents. getComposer(Component comp)Returns the composer object, or null if not found.static PageComponents. getCurrentPage(Component comp)Returns the page of the give component, or the current page if the component is null or it doesn't belong to any page.java.lang.StringDesktop. getDynamicMediaURI(Component comp, java.lang.String pathInfo)Returns URI for a dynamic generated media associated with a component.EvaluatorExecution. getEvaluator(Component comp, java.lang.Class<? extends org.zkoss.xel.ExpressionFactory> expfcls)Returns the evaluator of the current execution.static EvaluatorExecutions. getEvaluator(Component comp, java.lang.Class<? extends org.zkoss.xel.ExpressionFactory> expfcls)Returns the evaluator of the current execution.static java.lang.ObjectComponents. getImplicit(Component comp, java.lang.String name)Returns the implicit object of the specified name, or null if not found.static java.lang.ObjectComponents. getImplicit(Page page, Component comp, java.lang.String name)Returns the implicit object of the specified name, or null if not found.static intHtmlShadowElement. getIndex(ShadowElement owner, Component insertion, java.util.Map<Component,java.lang.Integer> cacheMap)protected java.util.Map<Component,java.lang.Integer>AbstractComponent. getIndexCacheMap(Component host)java.util.Map<Component,java.lang.Integer>HtmlShadowElement. getIndexCacheMap(Component host)Internal usestatic java.lang.StringPath. getPath(Component comp)Returns the path of the specified component.static ComponentComponents. getRoot(Component comp)Returns the root component of the specified one.java.lang.ObjectAbstractComponent. getShadowVariable(Component baseChild, java.lang.String name, boolean recurse)java.lang.ObjectComponent. getShadowVariable(Component baseChild, java.lang.String name, boolean recurse)Returns the shadow variable enclosed with the base component, which associated with this component or its parent component; or null if not found.protected java.lang.ObjectAbstractComponent. getShadowVariable0(Component baseChild, java.lang.String name, boolean recurse)protected java.lang.StringAbstractComponent. getSpecialRendererOutput(Component comp)static java.util.Collection<Component>Components. getVisibleChildren(Component comp)Returns a collection of visible children.org.zkoss.xel.FunctionPage. getZScriptFunction(Component comp, java.lang.String name, java.lang.Class[] argTypes)Returns the function of the specified name by searching the logical scope of the specified component in all the loaded interpreters.java.lang.ObjectPage. getZScriptVariable(Component comp, java.lang.String name)Returns the value of the variable of the specified name by searching the logical scope of the specified component in all the loaded interpreters, if any.protected java.util.Map<Component,java.lang.Integer>AbstractComponent. initIndexCacheMap(Component host)java.util.Map<Component,java.lang.Integer>HtmlShadowElement. initIndexCacheMap(Component host)Internal usestatic HtmlShadowElement.DirectionHtmlShadowElement. inRange(HtmlShadowElement se, Component target)Returns the direction of the target component according to the given shadow element.booleanAbstractComponent. insertBefore(Component newChild, Component refChild)booleanComponent. insertBefore(Component newChild, Component refChild)Inserts a child before the reference child.static booleanComponents. isAncestor(Component node1, Component node2)Tests whether node1 is an ancestor of node 2.static booleanComponents. isRealVisible(Component comp)Returns whether this component is real visible (all its parents are visible).static TemplateTemplates. lookup(Component comp, java.lang.String name)A shortcut of lookup(comp, comp, name, null, false)static TemplateTemplates. lookup(Component comp, Component base, java.lang.String name)A shortcut of lookup(comp, base, name, null, false)static TemplateTemplates. lookup(Component comp, Component base, java.lang.String name, Component compBase)A shortcut of lookup(comp, base, name, compBase, false)static TemplateTemplates. lookup(Component comp, Component base, java.lang.String name, Component compBase, boolean excludeBase)Lookup the template with some information.booleanHtmlShadowElement. mergeToHost(Component host)Merge the host into the current shadow, unlikeHtmlShadowElement.setShadowHost(Component, Component)voidAbstractComponent. onChildAdded(Component child)Default: handles special event listeners.voidHtmlShadowElement. onChildAdded(Component child)voidAbstractComponent. onChildRemoved(Component child)Default: handles special event listeners.protected voidHtmlShadowElement. onHostAttached(Component host)voidHtmlShadowElement. onHostChildAdded(Component child)Default: does nothing.voidShadowElementCtrl. onHostChildAdded(Component child)Called when a child of a host is added into this shadow element.voidHtmlShadowElement. onHostChildRemoved(Component child)Default: does nothing.voidShadowElementCtrl. onHostChildRemoved(Component child)Called when a child of a host is added into this shadow element.protected voidHtmlShadowElement. onHostDetached(Component host)voidAbstractComponent. onParentChanged(Component parent)static ComponentComponents. pathToComponent(java.lang.String path, Component ref)Converts a path, generated byComponents.componentToPath(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component), to a component.voidExecution. postEvent(int priority, Component realTarget, Event evt)Queues the give event for the specified target to this execution.static voidComponents. removeAllChildren(Component comp)Removes all children of the specified component.booleanAbstractComponent. removeChild(Component child)booleanComponent. removeChild(Component child)Removes a child.booleanAbstractComponent. removeForward(java.lang.String orgEvent, Component target, java.lang.String targetEvent)booleanComponent. removeForward(java.lang.String originalEvent, Component target, java.lang.String targetEvent)Removes a forward condition that was added byaddForward(String, Component, String).protected voidAbstractComponent. replace(Component comp, boolean bFellow, boolean bListener, boolean bChildren)Replace the specified component with this component in the component tree.static voidComponents. replace(Component oldc, Component newc)Replaces a component with another.static voidComponents. replaceChildren(Component parent, java.util.Collection<Component> newChildren)Replaces all children of the specified component.java.lang.ObjectHtmlShadowElement. resolveVariable(Component child, java.lang.String name, boolean recurse)java.lang.ObjectShadowElementCtrl. resolveVariable(Component child, java.lang.String name, boolean recurse)Returns the variable associated with this base component or null if not found.booleanHtmlMacroComponent. setInlineParent(Component parent, Component beforeSibling)voidAbstractComponent. setPageBefore(Page page, Component refRoot)voidComponent. setPageBefore(Page page, Component refRoot)Sets what page this component belongs to, and insert this component right before the reference component.voidAbstractComponent. setParent(Component parent)voidComponent. setParent(Component parent)Sets the parent component.voidHtmlMacroComponent. setParent(Component parent)Changes the parent.voidHtmlShadowElement. setParent(Component parent)protected static voidHtmlShadowElement. setPrevInsertion(Component target, Component prevInsertion)voidHtmlShadowElement. setShadowHost(Component host, Component insertBefore)voidShadowElementCtrl. setShadowHost(Component host, Component insertBefore)Sets the owner component that hosts this shadow element.protected voidHtmlShadowElement. shrinkRange(Component firstChild, Component lastChild)static voidComponents. smartUpdate(Component comp, java.lang.String key, java.lang.Object value, boolean append)Adds the smartUpdate command to the specific component.protected voidHtmlShadowElement. stretchRange(Component firstChild, Component lastChild)voidHtmlShadowElement. updateFirstInsertion(Component newFirstInsertion)Updates the given first insertion to this shadow element.voidHtmlShadowElement. updateLastInsertion(Component newLastInsertion)Updates the given last insertion to this shadow element.voidHtmlShadowElement. updateNextInsertion(Component newNextInsertion)Updates the given next insertion to this shadow element.voidHtmlShadowElement. updatePreviousInsertion(Component newPreviousInsertion)Updates the given previous insertion to this shadow element.Method parameters in org.zkoss.zk.ui with type arguments of type Component Modifier and Type Method Description protected static voidAbstractComponent. addClientEvent(java.lang.Class<? extends Component> cls, java.lang.String evtnm, int flags)Adds an event that the client might send to the server.ComponentDefinitionPage. getComponentDefinition(java.lang.Class<? extends Component> cls, boolean recurse)Returns the component definition of the specified class, or null if not found.protected java.lang.StringAbstractComponent. getDefaultMold(java.lang.Class<? extends Component> klass)Returns the default mold for the given class.static intHtmlShadowElement. getIndex(ShadowElement owner, Component insertion, java.util.Map<Component,java.lang.Integer> cacheMap)static voidComponents. replaceChildren(Component parent, java.util.Collection<Component> newChildren)Replaces all children of the specified component.static voidComponents. sort(java.util.List<? extends Component> list, int from, int to, java.util.Comparator<? super Component> cpr)Sorts the components in the list.static voidComponents. sort(java.util.List<? extends Component> list, int from, int to, java.util.Comparator<? super Component> cpr)Sorts the components in the list.static voidComponents. sort(java.util.List<? extends Component> list, java.util.Comparator<? super Component> cpr)Sorts the components in the list.static voidComponents. sort(java.util.List<? extends Component> list, java.util.Comparator<? super Component> cpr)Sorts the components in the list.Constructors in org.zkoss.zk.ui with parameters of type Component Constructor Description ArithmeticWrongValueException(Component comp, int code)ArithmeticWrongValueException(Component comp, int code, java.lang.Object fmtArg)ArithmeticWrongValueException(Component comp, int code, java.lang.Object[] fmtArgs)ArithmeticWrongValueException(Component comp, int code, java.lang.Object[] fmtArgs, java.lang.Object value)ArithmeticWrongValueException(Component comp, java.lang.String msg, java.lang.Object value)ArithmeticWrongValueException(Component comp, java.lang.String msg, java.lang.Throwable cause, java.lang.Object value)Path(Component comp)Returns the path of the specified component.WrongValueException(Component comp, int code)Constructs a wrong value exception to show an error box at the client.WrongValueException(Component comp, int code, java.lang.Object fmtArg)Constructs a wrong value exception to show an error box at the client.WrongValueException(Component comp, int code, java.lang.Object[] fmtArgs)Constructs a wrong value exception to show an error box at the client.WrongValueException(Component comp, java.lang.String msg)Constructs a wrong value exception to show an error box at the client.WrongValueException(Component comp, java.lang.String msg, java.lang.Throwable cause)Constructs a wrong value exception. -
Uses of Component in org.zkoss.zk.ui.event
Classes in org.zkoss.zk.ui.event with type parameters of type Component Modifier and Type Class Description classSelectEvent<T extends Component,E>Represents an event cause by user's the list selection is changed at the client.static interfaceSelectEvent.SelectedObjectHandler<T extends Component>A handle to retrieve selected objects from selected items (components) if possible.Methods in org.zkoss.zk.ui.event with type parameters of type Component Modifier and Type Method Description static <T extends Component,E>
SelectEvent<T,E>SelectEvent. getSelectEvent(AuRequest request)Converts an AU request to a select event.static <T extends Component,E>
SelectEvent<T,E>SelectEvent. getSelectEvent(AuRequest request, SelectEvent.SelectedObjectHandler<T> handler)Converts an AU request to a select event.Methods in org.zkoss.zk.ui.event that return Component Modifier and Type Method Description ComponentMouseEvent. getAreaComponent()Returns the component representing the area that the click occurs, or null if not associated with any component.ComponentDropEvent. getDragged()Returns the component being dragged and drop toEvent.getTarget().ComponentKeyEvent. getReference()Returns the reference item that is the component causing the key event to be fired.ComponentOpenEvent. getReference()Returns the reference that causesEvent.getTarget()to be opened.ComponentEvent. getTarget()Returns the target component that receives this event, or null if broadcast.Methods in org.zkoss.zk.ui.event with parameters of type Component Modifier and Type Method Description voidEventThreadResume. abortResume(Component comp, Event evt)Called when the suspended event thread is aborted.static voidEvents. addEventListeners(Component comp, java.lang.Object controller)Add onXxx event handler defined in controller object to the specified component.voidEventThreadResume. afterResume(Component comp, Event evt)Called after the suspended event thread is resumed.voidEventThreadSuspend. afterSuspend(Component comp, Event evt)Called in the servlet thread after the event processing thread has been suspended.voidEventThreadResume. beforeResume(Component comp, Event evt)Called just before the suspended event thread is resumed.voidEventThreadSuspend. beforeSuspend(Component comp, Event evt, java.lang.Object obj)Called before the event processing thread is suspended.voidGenericEventListener. bindComponent(Component comp)A convenient method that help you register this event listener to the specified target component.voidEventThreadCleanup. cleanup(Component comp, Event evt, java.util.List<java.lang.Throwable> errs)Cleans up the event processing thread.voidEventThreadCleanup. complete(Component comp, Event evt)Called in the serlvet thread to clean up.static voidEvents. echoEvent(java.lang.String name, Component target, java.lang.Object data)Echos an event.static voidEvents. echoEvent(java.lang.String name, Component target, java.lang.String data)Echos an event.static UploadEventUploadEvent. getUploadEvent(java.lang.String name, Component component, AuRequest request)Creates an instance ofUploadEventbased on the event name and component, theUploadEventcontains the upload media(s) from user.booleanEventThreadInit. init(Component comp, Event event)Initialize the event processing thread before processing the event.static booleanEvents. isListened(Component comp, java.lang.String evtnm, boolean asap)Returns whether an event handler or listener is available for the specified component and event.static voidEvents. postEvent(int priority, java.lang.String name, Component target, java.lang.Object data)Posts an instance ofEventto the current execution with the specified priority.static voidEvents. postEvent(int priority, Component realTarget, Event event)Queues the give event for the specified target to this execution.static voidEvents. postEvent(java.lang.String name, Component target, java.lang.Object data)Posts an instance ofEventto the current execution.static voidEvents. postEvent(Component realTarget, Event event)Queues the give event for the specified target to this execution.voidEventThreadInit. prepare(Component comp, Event event)Prepares the initialization at the servlet thread.static voidEvents. sendEvent(java.lang.String name, Component target, java.lang.Object data)Sends the event to the target, and processes it immediately.static voidEvents. sendEvent(Component comp, Event event)Sends the event to the specified component and process it immediately.voidGenericEventListener. unbindComponent(Component comp)A convenient method that help you remove this event listener from the specified target component.Constructors in org.zkoss.zk.ui.event with parameters of type Component Constructor Description AfterSizeEvent(java.lang.String name, Component target, int width, int height)Constructs an AfterSizeEvent.CheckEvent(java.lang.String name, Component target, boolean checked)Constructs a check-relevant event.CheckEvent(java.lang.String name, Component target, java.lang.Boolean checked)Constructs a check-relevant event.CreateEvent(java.lang.String name, Component target, java.util.Map<?,?> args)DOMExceptionEvent(java.lang.String name, Component target, java.lang.String errorName, java.lang.String errorMessage)DropEvent(java.lang.String name, Component target, Component dragged, int x, int y, int pageX, int pageY, int keys)Constructs a drop event.ErrorEvent(java.lang.String name, Component target, java.lang.String val, java.lang.Object oldValue, java.lang.String msg)Constructs an error-relevant event.Event(java.lang.String name, Component target)Constructs a simple event.Event(java.lang.String name, Component target, java.lang.Object data)Constructs a simple event.ForwardEvent(java.lang.String name, Component target, Event origin)Constructs a forward event.ForwardEvent(java.lang.String name, Component target, Event origin, java.lang.Object data)Constructs a forward event.FulfillEvent(java.lang.String name, Component target, Event origin)Constructs a fulfill event.FulfillEvent(java.lang.String name, Component target, Event origin, java.lang.Object data)Constructs a fulfill event.InputEvent(java.lang.String name, Component target, java.lang.String val, java.lang.Object oldValue)Constructs a input-relevant event.InputEvent(java.lang.String name, Component target, java.lang.String val, java.lang.Object oldValue, boolean selbk, int start)Constructs an input eventKeyEvent(java.lang.String name, Component target, int keyCode, boolean ctrlKey, boolean shiftKey, boolean altKey)KeyEvent(java.lang.String name, Component target, int keyCode, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, Component ref)Constructs an event with MetaKeyKeyEvent(java.lang.String name, Component target, int keyCode, boolean ctrlKey, boolean shiftKey, boolean altKey, Component ref)Constructs a mouse relevant event.MaximizeEvent(java.lang.String name, Component target, java.lang.String left, java.lang.String top, java.lang.String width, java.lang.String height, boolean maximized)MinimizeEvent(java.lang.String name, Component target, java.lang.String left, java.lang.String top, java.lang.String width, java.lang.String height, boolean minimized)MouseEvent(java.lang.String name, Component target)Construct a mouse relevant event with coordinate or area.MouseEvent(java.lang.String name, Component target, int x, int y, int pageX, int pageY)Constructs a mouse relevant event.MouseEvent(java.lang.String name, Component target, int x, int y, int pageX, int pageY, int keys)Constructs a mouse relevant event.MouseEvent(java.lang.String name, Component target, java.lang.String area, int keys)Constructs a mouse relevant event with a logic name called area.MoveEvent(java.lang.String name, Component target, java.lang.String left, java.lang.String top, int keys)Constructs a mouse relevant event.OpenEvent(java.lang.String name, Component target, boolean open)Constructs an onOpen event.OpenEvent(java.lang.String name, Component target, boolean open, Component ref)Constructs an onOpen event for a context menu, a tooltip or a popup.OpenEvent(java.lang.String name, Component target, boolean open, Component ref, java.lang.Object value)Constructs an onOpen event.ScriptErrorEvent(java.lang.String name, Component target, java.lang.String message, java.lang.String stack)ScrollEvent(java.lang.String name, Component target, double pos)Constructs an scroll-relevant event.ScrollEvent(java.lang.String name, Component target, double dPos, boolean outBound)Constructs an scroll-relevant event.ScrollEvent(java.lang.String name, Component target, int pos)Constructs an scroll-relevant event.ScrollEvent(java.lang.String name, Component target, int pos, boolean outBound)Constructs an scroll-relevant event.SelectEvent(java.lang.String name, Component target, java.util.Set<T> selectedItems)Constructs a selection event.SelectEvent(java.lang.String name, Component target, java.util.Set<T> selectedItems, java.util.Set<T> previousSelectedItems, java.util.Set<T> unselectedItems, java.util.Set<E> selectedObjects, java.util.Set<E> prevSelectedObjects, java.util.Set<E> unselectedObjects, T ref, java.lang.Object data, int keys)Constructs a selection event containing the data objects that model provided.SelectEvent(java.lang.String name, Component target, java.util.Set<T> selectedItems, T ref)Constructs a selection event.SelectEvent(java.lang.String name, Component target, java.util.Set<T> selectedItems, T ref, int keys)Constructs a selection event.SelectionEvent(java.lang.String name, Component target, int start, int end, java.lang.String txt)Constructs a selection event.SizeEvent(java.lang.String name, Component target, java.lang.String width, java.lang.String height, int keys)Constructs a mouse relevant event.SlideEvent(java.lang.String name, Component target, boolean slide)Constructs an onOpen event.SortEvent(java.lang.String name, Component target, boolean ascending)Constructs a sort event.StateChangeEvent(java.lang.String name, Component target, java.lang.Integer state)Constructs the state change event.StubEvent(java.lang.String name, Component target, java.lang.String cmd, java.lang.String uuid, java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> data)Constructs a check-relevant event.StubEvent(StubEvent evt, Component target)SwipeEvent(java.lang.String name, Component target, int swipeX, int swipeY, int swipeTime, java.lang.String swipeDir)UploadEvent(java.lang.String name, Component target, org.zkoss.util.media.Media[] meds)Constructs the upload event.URIEvent(java.lang.String name, Component target, java.lang.String uri)Constructs an URI update event.ZIndexEvent(java.lang.String name, Component target, int zIndex)Constructs a mouse relevant event. -
Uses of Component in org.zkoss.zk.ui.ext
Methods in org.zkoss.zk.ui.ext that return Component Modifier and Type Method Description ComponentNative.Helper. newNative(java.lang.String text)Creates a native component with the specified content.Methods in org.zkoss.zk.ui.ext with parameters of type Component Modifier and Type Method Description static java.lang.StringUploads. getRealUpload(Component comp, java.lang.String upload)Gets the real upload setting for client.static voidUploads. parseUpload(Component comp, java.lang.String upload)Parse the setting and update the upload-related attributes with the component.booleanMacro. setInlineParent(Component parent, Component beforeSibling)Sets the parent to the given one and insert the children of the inline macro right before the given sibling (beforeSibling). -
Uses of Component in org.zkoss.zk.ui.ext.render
Methods in org.zkoss.zk.ui.ext.render that return Component Modifier and Type Method Description ComponentCropper. getCropOwner()Returns the owner of the cropping scope.Methods in org.zkoss.zk.ui.ext.render that return types with arguments of type Component Modifier and Type Method Description java.util.Set<? extends Component>Cropper. getAvailableAtClient()Returns a set of child components that are available at the client, or null if ALL available. -
Uses of Component in org.zkoss.zk.ui.http
Methods in org.zkoss.zk.ui.http with parameters of type Component Modifier and Type Method Description java.lang.ObjectExecutionImpl. evaluate(Component comp, java.lang.String expr, java.lang.Class<?> expectedType)EvaluatorExecutionImpl. getEvaluator(Component comp, java.lang.Class<? extends org.zkoss.xel.ExpressionFactory> expfcls) -
Uses of Component in org.zkoss.zk.ui.impl
Classes in org.zkoss.zk.ui.impl with type parameters of type Component Modifier and Type Class Description classMultiComposer<T extends Component>To proxy a collection of composers.Methods in org.zkoss.zk.ui.impl that return Component Modifier and Type Method Description Component[]AbstractExecution. createComponents(java.lang.String uri, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponents(java.lang.String uri, Component parent, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponents(java.lang.String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Component[]AbstractExecution. createComponents(java.lang.String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)Component[]AbstractExecution. createComponents(java.lang.String uri, Page page, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)Component[]AbstractExecution. createComponents(PageDefinition pagedef, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponents(PageDefinition pagedef, Component parent, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponents(PageDefinition pagedef, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Component[]UiEngineImpl. createComponents(Execution exec, PageDefinition pagedef, Page page, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)Component[]AbstractExecution. createComponentsDirectly(java.io.Reader reader, java.lang.String ext, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponentsDirectly(java.io.Reader reader, java.lang.String ext, Component parent, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponentsDirectly(java.io.Reader reader, java.lang.String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Component[]AbstractExecution. createComponentsDirectly(java.lang.String content, java.lang.String ext, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponentsDirectly(java.lang.String content, java.lang.String ext, Component parent, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponentsDirectly(java.lang.String content, java.lang.String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Component[]AbstractExecution. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String ext, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String ext, Component parent, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)ComponentEventProcessingThreadImpl. getComponent()ComponentEventProcessor. getComponent()Returns the component.ComponentDesktopImpl. getComponentByUuid(java.lang.String uuid)ComponentDesktopImpl. getComponentByUuidIfAny(java.lang.String uuid)ComponentPageImpl. getOwner()ComponentProxyEvent. getRealTarget()Returns the real target.ComponentDesktopImpl. mapComponent(java.lang.String uuid, Component comp)ComponentAbstractUiFactory. newComponent(Page page, Component parent, ComponentDefinition compdef, java.lang.String clsnm)ComponentAbstractUiFactory. newComponent(Page page, Component parent, ComponentInfo compInfo, Component insertBefore)ComponentAbstractUiFactory. newComponent(Page page, Component parent, ShadowInfo compInfo, Component insertBefore)ComponentUiEngineImpl. setOwner(Component comp)Methods in org.zkoss.zk.ui.impl that return types with arguments of type Component Modifier and Type Method Description java.util.Collection<Component>DesktopImpl. getComponents()Methods in org.zkoss.zk.ui.impl with parameters of type Component Modifier and Type Method Description voidDesktopImpl. addComponent(Component comp)voidPageImpl. addDeferredZScript(Component parent, ZScript zscript)voidUiEngineImpl. addInvalidate(Component comp)voidUiEngineImpl. addMoved(Component comp, Component oldparent, Page oldpg, Page newpg)voidUiEngineImpl. addSmartUpdate(Component comp, java.lang.String attr, java.lang.Object value, boolean append)voidUiEngineImpl. addSmartUpdate(Component comp, java.lang.String attr, java.lang.Object value, int priority)voidUiEngineImpl. addUuidChanged(Component comp)voidDesktopImpl. afterComponentAttached(Component comp, Page page)voidDesktopImpl. afterComponentDetached(Component comp, Page prevpage)voidDesktopImpl. afterComponentMoved(Component parent, Component child, Component prevparent)voidUiEngineExtension. afterCreate(Component[] comps)voidUiEngineImpl.Extension. afterCreate(Component[] comps)Called after the whole component tree has been created by this engine.voidUiEngineImpl. clearSmartUpdate(Component comp)ComponentAbstractExecution. createComponents(java.lang.String uri, Component parent, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponents(java.lang.String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Component[]AbstractExecution. createComponents(java.lang.String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponents(PageDefinition pagedef, Component parent, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponents(PageDefinition pagedef, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)Component[]UiEngineImpl. createComponents(Execution exec, PageDefinition pagedef, Page page, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponentsDirectly(java.io.Reader reader, java.lang.String ext, Component parent, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponentsDirectly(java.io.Reader reader, java.lang.String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)ComponentAbstractExecution. createComponentsDirectly(java.lang.String content, java.lang.String ext, Component parent, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponentsDirectly(java.lang.String content, java.lang.String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)ComponentAbstractExecution. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String ext, Component parent, java.util.Map<?,?> arg)ComponentAbstractExecution. createComponentsDirectly(org.zkoss.idom.Document content, java.lang.String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)booleanUiEngineImpl. disableClientUpdate(Component comp, boolean disable)ComponentInfoMultiComposer. doBeforeCompose(Page page, Component parent, ComponentInfo compInfo)static ComponentInfoUtils. getComponentInfo(Component comp)Returns the component info associated with the given component, or null if not available.java.lang.StringDesktopImpl. getDynamicMediaURI(Component comp, java.lang.String pathInfo)java.lang.StringUiEngineImpl. getNativeContent(Component comp, java.util.List<NodeInfo> children, Native.Helper helper)java.lang.StringDesktopImpl. getNextUuid(Component comp)org.zkoss.xel.FunctionPageImpl. getZScriptFunction(Component comp, java.lang.String name, java.lang.Class[] argTypes)java.lang.ObjectPageImpl. getZScriptVariable(Component comp, java.lang.String name)booleanUiEngineImpl. isInvalidated(Component comp)ComponentDesktopImpl. mapComponent(java.lang.String uuid, Component comp)ComponentAbstractUiFactory. newComponent(Page page, Component parent, ComponentDefinition compdef, java.lang.String clsnm)ComponentAbstractUiFactory. newComponent(Page page, Component parent, ComponentInfo compInfo, Component insertBefore)ComponentAbstractUiFactory. newComponent(Page page, Component parent, ShadowInfo compInfo, Component insertBefore)java.lang.StringStaticIdGenerator. nextComponentUuid(Desktop desktop, Component comp, ComponentInfo compInfo)voidDesktopImpl. onPiggybackListened(Component comp, boolean listen)voidAbstractExecution. postEvent(int priority, Component realTarget, Event evt)booleanEventProcessingThreadImpl. processEvent(Desktop desktop, Component comp, Event event)Ask this event thread to process the specified event.booleanDesktopImpl. removeComponent(Component comp)voidEventProcessingThreadImpl. sendEvent(Component comp, Event event)static voidUtils. setComponentInfo(Component comp, ComponentInfo info)Sets the component info for the given component.voidPageImpl. setOwner(Component comp)ComponentUiEngineImpl. setOwner(Component comp)static voidUtils. setShadowInfo(Component comp, ShadowInfo info)Sets the component info for the given component.static booleanUtils. testAttribute(Component comp, java.lang.String name, boolean defValue, boolean recurse)Tests if the given attribute is defined in a component or in library property.Method parameters in org.zkoss.zk.ui.impl with type arguments of type Component Modifier and Type Method Description protected voidUiEngineImpl. afterRenderComponents(java.util.Collection<Component> comps)Called when this engine renders the given components.voidUiEngineImpl.Extension. afterRenderComponents(java.util.Collection<Component> comps)Called when this engine renders the given components.ComponentDefinitionPageImpl. getComponentDefinition(java.lang.Class<? extends Component> cls, boolean recurse)Constructors in org.zkoss.zk.ui.impl with parameters of type Component Constructor Description EventProcessor(Desktop desktop, Component comp, Event event)ProxyEvent(Component realTarget, Event event)Constructor. -
Uses of Component in org.zkoss.zk.ui.metainfo
Methods in org.zkoss.zk.ui.metainfo that return Component Modifier and Type Method Description ComponentComponentDefinition. newInstance(java.lang.Class<? extends Component> cls)Creates an component of this definition.ComponentComponentDefinition. newInstance(Page page, java.lang.String clsnm)Creates an component of this definition.ComponentComponentInfo. newInstance(Page page)Creates an component based on this info (never null).ComponentComponentInfo. newInstance(Page page, Component parent)Creates an component based on this info (never null).ComponentNativeInfo. newInstance(Page page, Component parent)ComponentShadowInfo. newInstance(Page page)Creates a shadow element based on this info (never null).ComponentShadowInfo. newInstance(Page page, Component parent)Creates an component based on this info (never null).Methods in org.zkoss.zk.ui.metainfo with parameters of type Component Modifier and Type Method Description voidAttributesInfo. apply(Component comp)Applies the custom attributes.voidShadowInfo. apply(Component comp)Applies the custom attributes.voidVariablesInfo. apply(Component comp)Applies the variable element against the parent component.voidComponentDefinition. applyAttributes(Component comp)Applies the custom attributes defined in this definition to the specified component.voidComponentDefinition. applyProperties(Component comp)Applies the properties defined in this definition to the specified component.voidComponentInfo. applyProperties(Component comp)Applies the event handlers and properties to the specified component.voidShadowInfo. applyProperties(Component comp)Applies the event handlers and properties to the specified component.voidProperty. assign(Component comp)Assigns the value of this member to the specified component.static voidProperty. assign(Component comp, java.lang.String name, java.lang.String value)Assigns a property.voidWidgetAttribute. assign(Component comp)voidWidgetListener. assign(Component comp)voidWidgetOverride. assign(Component comp)java.util.Map<java.lang.String,java.lang.Object>ComponentDefinition. evalProperties(java.util.Map<java.lang.String,java.lang.Object> propmap, Page owner, Component parent)Evaluates and retrieves properties to the specified map.java.util.Map<java.lang.String,java.lang.Object>ComponentInfo. evalProperties(java.util.Map<java.lang.String,java.lang.Object> propmap, Page owner, Component parent, boolean defIncluded)Evaluates and retrieves properties to the specified map fromComponentDefinition(andComponentInfo).EventHandlerEventHandlerMap. get(Component comp, java.lang.String evtnm)Returns the first effective event handler of the specified event name, or null if not available.java.lang.StringZScript. getContent(Page page, Component comp)Returns the content of zscript.java.lang.StringZScriptInfo. getContent(Page page, Component comp)Returns the content of zscript.java.lang.StringComponentDefinition. getDefaultWidgetClass(Component comp)Returns the default widget class, or null if not available.java.lang.StringWidgetListener. getScript(Component comp)Returns the script associated with this event handler.java.lang.StringTemplateInfo. getSrc(Component comp)Returns the URI to create the template from, or null if not specified.java.lang.ObjectProperty. getValue(Component comp)Evaluates the value to an Object.java.lang.StringTextInfo. getValue(Component comp)Returns the value after evaluation.java.lang.StringWidgetAttribute. getValue(Component comp)Returns the value associated with this event handler.java.lang.StringComponentDefinition. getWidgetClass(Component comp, java.lang.String moldName)Returns the widget class associated with specified mold, or the default widget class (ComponentDefinition.getWidgetClass(org.zkoss.zk.ui.Component, java.lang.String)) if not available.booleanComponentDefinition. isInstance(Component comp)Returns whether a component belongs to this definition.ComponentComponentInfo. newInstance(Page page, Component parent)Creates an component based on this info (never null).ComponentNativeInfo. newInstance(Page page, Component parent)ComponentShadowInfo. newInstance(Page page, Component parent)Creates an component based on this info (never null).java.lang.Object[]ZkInfo. resolveCase(Page page, Component comp)Returns the case condition's value, or null if no case is specified (i.e.,ZkInfo.withCase()is false.ComposerComponentInfo. resolveComposer(Page page, Component comp)Returns the composer for this info, or null if not available.java.lang.ClassComponentInfo. resolveImplementationClass(Page page, Component parent)Resolves and returns the class for the component represented by this info (never null).java.util.Map<java.lang.String,java.lang.Object>TemplateInfo. resolveParameters(Component comp)Evaluates and returns a readonly map of parameters assigned to this template (never null).java.lang.ObjectZkInfo. resolveSwitch(Page page, Component comp)Returns the switch condition's value; evaluate EL expression if any.java.lang.StringComponentInfo. resolveWidgetClass(Component comp)Resolves the widget class, or null if the default is expected.Method parameters in org.zkoss.zk.ui.metainfo with type arguments of type Component Modifier and Type Method Description ComponentComponentDefinition. newInstance(java.lang.Class<? extends Component> cls)Creates an component of this definition.voidComponentDefinition. setImplementationClass(java.lang.Class<? extends Component> cls)Sets the class to implements the component.voidLanguageDefinition. setMacroTemplate(java.lang.Class<? extends Component> klass)Sets the macro template.voidLanguageDefinition. setNativeTemplate(java.lang.Class<? extends Component> klass)Sets the native template.voidLanguageDefinition. setShadowTemplate(java.lang.Class<? extends Component> klass)Sets the shadow template. -
Uses of Component in org.zkoss.zk.ui.metainfo.impl
Methods in org.zkoss.zk.ui.metainfo.impl that return Component Modifier and Type Method Description ComponentComponentDefinitionImpl. newInstance(java.lang.Class<? extends Component> cls)ComponentComponentDefinitionImpl. newInstance(Page page, java.lang.String clsnm)Methods in org.zkoss.zk.ui.metainfo.impl with parameters of type Component Modifier and Type Method Description voidAnnotationHelper. applyAnnotations(Component comp, java.lang.String propName, boolean clear)Applies the annotations defined in this helper to the specified component.voidComponentDefinitionImpl. applyAttributes(Component comp)voidComponentDefinitionImpl. applyProperties(Component comp)java.util.Map<java.lang.String,java.lang.Object>ComponentDefinitionImpl. evalProperties(java.util.Map<java.lang.String,java.lang.Object> propmap, Page owner, Component parent)java.lang.StringComponentDefinitionImpl. getDefaultWidgetClass(Component comp)java.lang.StringComponentDefinitionImpl. getWidgetClass(Component comp, java.lang.String moldName)booleanComponentDefinitionImpl. isInstance(Component comp)Method parameters in org.zkoss.zk.ui.metainfo.impl with type arguments of type Component Modifier and Type Method Description ComponentComponentDefinitionImpl. newInstance(java.lang.Class<? extends Component> cls)static ComponentDefinitionComponentDefinitionImpl. newMacroDefinition(LanguageDefinition langdef, PageDefinition pgdef, java.lang.String name, java.lang.Class<? extends Component> cls, java.lang.String macroURI, boolean inline)Constructs a macro component definition.static ComponentDefinitionComponentDefinitionImpl. newNativeDefinition(LanguageDefinition langdef, java.lang.String name, java.lang.Class<? extends Component> cls)Constructs a native component definition.static ComponentDefinitionComponentDefinitionImpl. newShadowDefinition(LanguageDefinition langdef, PageDefinition pgdef, java.lang.String name, java.lang.Class<? extends Component> cls, java.lang.String templateURI)Constructs a shadow component definition.voidComponentDefinitionImpl. setImplementationClass(java.lang.Class<? extends Component> cls)Constructor parameters in org.zkoss.zk.ui.metainfo.impl with type arguments of type Component Constructor Description ComponentDefinitionImpl(LanguageDefinition langdef, PageDefinition pgdef, java.lang.String name, java.lang.Class<? extends Component> cls)Constructs a native component, i.e., a component implemented by a Java class.ShadowDefinitionImpl(LanguageDefinition langdef, PageDefinition pgdef, java.lang.String name, java.lang.Class<? extends Component> cls) -
Uses of Component in org.zkoss.zk.ui.select
Classes in org.zkoss.zk.ui.select with type parameters of type Component Modifier and Type Class Description classSelectorComposer<T extends Component>A composer analogous to GenericForwardComposer.Methods in org.zkoss.zk.ui.select that return types with arguments of type Component Modifier and Type Method Description static java.util.List<Component>Selectors. find(java.lang.String selector)Returns a list of Components that match the selector (from the first page of current Desktop).static java.util.List<Component>Selectors. find(Component root, java.lang.String selector)Returns a list of Components that match the selector.static java.util.List<Component>Selectors. find(Page page, java.lang.String selector)Returns a list of Components that match the selector.static java.lang.Iterable<Component>Selectors. iterable(Component root, java.lang.String selector)Returns an Iterable that iterates through all Components matched by the selector.static java.lang.Iterable<Component>Selectors. iterable(Page page, java.lang.String selector)Returns an Iterable that iterates through all Components matched by the selector.Methods in org.zkoss.zk.ui.select with parameters of type Component Modifier and Type Method Description voidSelectorComposer. didActivate(Component comp)ComponentInfoSelectorComposer. doBeforeCompose(Page page, Component parent, ComponentInfo compInfo)static java.util.List<Component>Selectors. find(Component root, java.lang.String selector)Returns a list of Components that match the selector.static java.lang.Iterable<Component>Selectors. iterable(Component root, java.lang.String selector)Returns an Iterable that iterates through all Components matched by the selector.static voidSelectors. rewireComponentsOnActivate(Component component, java.lang.Object controller)Rewire the components on session activationstatic voidSelectors. rewireVariablesOnActivate(Component component, java.lang.Object controller, java.util.List<org.zkoss.xel.VariableResolver> extraResolvers)Rewire the variables on session activationjava.lang.ObjectSelectorComposer. willClone(Component comp)Internal use only.voidSelectorComposer. willPassivate(Component comp)static voidSelectors. wireComponents(Component component, java.lang.Object controller, boolean ignoreNonNull)Wire components to controller.static voidSelectors. wireEventListeners(Component component, java.lang.Object controller)Add event listeners to components based on the controller.static voidSelectors. wireVariables(Component component, java.lang.Object controller, java.util.List<org.zkoss.xel.VariableResolver> extraResolvers)Wire variables to controller, including XEL variables, implicit variables. -
Uses of Component in org.zkoss.zk.ui.select.impl
Methods in org.zkoss.zk.ui.select.impl that return Component Modifier and Type Method Description ComponentComponentMatchCtx. getComponent()Return the component.ComponentComponentIterator. next()Return the next matched component.ComponentComponentIterator. peek()Return the next matched component, but the iteration is not proceeded.Methods in org.zkoss.zk.ui.select.impl with parameters of type Component Modifier and Type Method Description static booleanComponentLocalProperties. match(Component component, java.lang.String selector)Returns true if the selector matches the given component.static booleanComponentLocalProperties. match(Component component, java.lang.String selector, java.util.Map<java.lang.String,PseudoClassDef> defs)Returns true if the selector matches the given component.Constructors in org.zkoss.zk.ui.select.impl with parameters of type Component Constructor Description ComponentIterator(Component root, java.lang.String selector)Create an iterator which selects from all the descendants of a given component, including itself. -
Uses of Component in org.zkoss.zk.ui.sys
Classes in org.zkoss.zk.ui.sys that implement Component Modifier and Type Class Description classStubComponentA stub component is a 'degenerated' component that does not maintain the states at the server.classStubsComponentRepresents a tree ofStubComponentthat are merged into a single component.Methods in org.zkoss.zk.ui.sys that return Component Modifier and Type Method Description Component[]UiEngine. createComponents(Execution exec, PageDefinition pagedef, Page page, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)Creates components from the specified page and definition.static Component[]ShadowElementsCtrl. filterOutShadows(Component[] shadows)Returns the component array filter out shadows if any.ComponentEventProcessingThread. getComponent()Returns the component being processed by this thread, or null if idle.ComponentPageCtrl. getOwner()Returns the owner of this page, or null if it is not owned by any component.ComponentVisualizer. getOwner()Returns the owner component for this execution, or null if this execution is not owned by any component.static ComponentComponentsCtrl. getRootParent()Returns the root parent when being called inComponentCtrl.onPageAttached(org.zkoss.zk.ui.Page, org.zkoss.zk.ui.Page)andComponentCtrl.onPageDetached(org.zkoss.zk.ui.Page)ComponentDesktopCtrl. mapComponent(java.lang.String uuid, Component comp)Maps a component associated with the given UUID to this page.ComponentUiFactory. newComponent(Page page, Component parent, ComponentDefinition compdef, java.lang.String clsnm)Creates and initializes a component based on the specifiedComponentDefinition.ComponentUiFactory. newComponent(Page page, Component parent, ComponentInfo compInfo, Component insertBefore)Creates and initializes a component based on the specifiedComponentInfo.ComponentUiFactory. newComponent(Page page, Component parent, ShadowInfo compInfo, Component insertBefore)Creates and initializes a shadow based on the specifiedShadowInfo.ComponentUiEngine. setOwner(Component comp)Called before a component redraws itself if the component might include another page.Methods in org.zkoss.zk.ui.sys with parameters of type Component Modifier and Type Method Description voidDesktopCtrl. addComponent(Component comp)Adds a component to this page.voidPageCtrl. addDeferredZScript(Component parent, ZScript zscript)Adds a deferred zscript.voidUiEngine. addInvalidate(Component comp)Invalidates a component to cause redrawing.voidUiEngine. addMoved(Component comp, Component oldparent, Page oldpg, Page newpg)Called to update (redraw) a component, when a component is moved.voidUiEngine. addSmartUpdate(Component comp, java.lang.String attr, java.lang.Object value, boolean append)Smart-updates a property of the peer widget.voidUiEngine. addSmartUpdate(Component comp, java.lang.String attr, java.lang.Object value, int priority)Adds a smart update that will be executed at the given priority.voidUiEngine. addUuidChanged(Component comp)Called before changing the component's UUID.voidDesktopCtrl. afterComponentAttached(Component comp, Page page)voidDesktopCtrl. afterComponentDetached(Component comp, Page prevpage)voidDesktopCtrl. afterComponentMoved(Component parent, Component child, Component prevparent)static voidComponentsCtrl. applyForward(Component comp, java.lang.String forward)Applies the forward condition to the specified component.voidComponentCtrl. beforeChildAdded(Component child, Component insertBefore)Called before adding a child.voidComponentCtrl. beforeChildRemoved(Component child)Called before removing a child.voidComponentCtrl. beforeParentChanged(Component parent)Called before changing the parent.voidUiEngine. clearSmartUpdate(Component comp)Clears all existing smart updates that belong to the given component.Component[]UiEngine. createComponents(Execution exec, PageDefinition pagedef, Page page, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, java.util.Map<?,?> arg)Creates components from the specified page and definition.booleanUiEngine. disableClientUpdate(Component comp, boolean disable)Sets whether to disable the update of the client widget.booleanVisualizer. disableClientUpdate(Component comp, boolean disable)Sets whether to disable the update of the client widget.static Component[]ShadowElementsCtrl. filterOutShadows(Component[] shadows)Returns the component array filter out shadows if any.static java.lang.ObjectShadowElementsCtrl. getDistributedIndexInfo(Component host)Returns the current distributed index info, which is used only byHtmlShadowElement.java.lang.StringUiEngine. getNativeContent(Component comp, java.util.List<NodeInfo> children, Native.Helper helper)Retrieve the native content for a property of the specified component.java.lang.StringDesktopCtrl. getNextUuid(Component comp)Returns the next available UUID for a component.TPropertyAccess. getValue(Component cmp)booleanUiEngine. isInvalidated(Component comp)Returns if this component needs to be redrawn.protected voidStubsComponent. mapChildren(DesktopCtrl desktopCtrl, java.util.List<java.lang.String> uuids, java.util.List<java.lang.String[]> idmap, java.util.List<java.lang.Object[]> evtmap, Component comp)ComponentDesktopCtrl. mapComponent(java.lang.String uuid, Component comp)Maps a component associated with the given UUID to this page.ComponentUiFactory. newComponent(Page page, Component parent, ComponentDefinition compdef, java.lang.String clsnm)Creates and initializes a component based on the specifiedComponentDefinition.ComponentUiFactory. newComponent(Page page, Component parent, ComponentInfo compInfo, Component insertBefore)Creates and initializes a component based on the specifiedComponentInfo.ComponentUiFactory. newComponent(Page page, Component parent, ShadowInfo compInfo, Component insertBefore)Creates and initializes a shadow based on the specifiedShadowInfo.default java.lang.StringIdGenerator. nextAnonymousComponentUuid(Component comp, ComponentInfo compInfo)Returns the next anonymous component UUID for the specified component, or null to generate the default UUID.default java.lang.StringIdGenerator. nextComponentUuid(Desktop desktop, Component comp, ComponentInfo compInfo)Returns the next component UUID for the specified component, or null to generate the default UUID.voidComponentCtrl. onChildAdded(Component child)Called when a child is added.voidComponentCtrl. onChildRemoved(Component child)Called when a child is removed.voidStubsComponent. onChildrenMerged(Component replaced, boolean bListener)Called when this component replaced the given component, and the children of the given component shall be 'merged' to this component.voidComponentCtrl. onParentChanged(Component parent)Called after the parent changed.voidDesktopCtrl. onPiggybackListened(Component comp, boolean listen)Called when a component added or removed a listener forEvents.ON_PIGGYBACK.static voidHtmlPageRenders. outStandalone(Execution exec, Component comp, java.io.Writer out)Generates the content of a standalone component that the peer widget is not a child of the page widget at the client.static java.lang.Object[]ComponentsCtrl. parseEventExpression(Component comp, java.lang.String evtexpr, Component defaultComp, boolean deferred)Pares the event expression.booleanDesktopCtrl. removeComponent(Component comp)Removes a component to this page.voidPropertiesRenderer. renderProperties(Component comp, ContentRenderer render)Renders additional properties of the given component with the givenContentRenderer.voidStubComponent. replace(Component comp, boolean bFellow, boolean bListener, boolean bChildren)Replace the specified component with this component in the component tree.voidEventProcessingThread. sendEvent(Component comp, Event event)Sends the specified component and event and processes the event synchronously.voidEventListenerMap. service(Event event, Scope scope, Component comp, java.lang.String cmd)Services the event under the given page and scope.static voidShadowElementsCtrl. setDistributedIndexInfo(Component host, java.lang.Object indexMapInfo)Sets the current distributed index info, which is used only byHtmlShadowElement.voidPageCtrl. setOwner(Component comp)Sets the owner of this page.ComponentUiEngine. setOwner(Component comp)Called before a component redraws itself if the component might include another page.static voidComponentsCtrl. setRootParent(Component comp)Sets root parentvoidPropertyAccess. setValue(Component cmp, T value)Method parameters in org.zkoss.zk.ui.sys with type arguments of type Component Modifier and Type Method Description static java.util.Collection<org.zkoss.json.JavaScriptValue>ComponentsCtrl. redraw(java.util.Collection<? extends Component> comps)An utilities to create an array of JavaScript objects (JavaScriptValue) that can be used to mount the specified widget at the clients. -
Uses of Component in org.zkoss.zk.ui.util
Classes in org.zkoss.zk.ui.util with type parameters of type Component Modifier and Type Interface Description interfaceComposer<T extends Component>Represents a composer to initialize a component (or a component of tree) when ZK loader is composing a component.interfaceComposerExt<T extends Component>An addition interface implemented withComposerto provide more control.classGenericAutowireComposer<T extends Component>A skeletal composer that you can extend and write intuitive onXxx event handler methods with "auto-wired" accessible variable objects such as implicit objects, components, and external resolvable variables in a ZK zuml page.classGenericComposer<T extends Component>A skeletal composer that you can extend and write intuitive onXxx event handler methods; this class will registers onXxx events to the supervised component automatically.classGenericForwardComposer<T extends Component>A skeletal composer that you can extend and write intuitive onXxx$myid event handler methods with auto event forwarding and "auto-wired" accessible variable objects such as embedded objects, components, and external resolvable variables in a ZK zuml page; this class will add forward condition to the myid source component and forward source onXxx event received by the source myid component to the target onXxx$myid event (as defined in this composer) of the supervised target component; of course it will also registers onXxx$myid events to the supervised component and wire all accessible variable objects to this composer by calling setXxx() method or set xxx field value directly per the variable name.Fields in org.zkoss.zk.ui.util declared as Component Modifier and Type Field Description protected TGenericAutowireComposer. selfImplicit Object; the applied component itself.Methods in org.zkoss.zk.ui.util that return Component Modifier and Type Method Description Component[]Template. create(Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, Composer composer)Creates the components defined in this template.Methods in org.zkoss.zk.ui.util with parameters of type Component Modifier and Type Method Description static voidConventionWires. addForwards(Component comp, java.lang.Object controller)Adds forward conditions to myid source component so onXxx source event received by myid component can be forwarded to the specified target component with the target event name onXxx$myid.static voidConventionWires. addForwards(Component comp, java.lang.Object controller, char separator)Adds forward conditions to the specified component with a custom separator.voidConfiguration. afterComponentAttached(Component comp, Page page)InvokesUiLifeCycle.afterComponentAttached(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Page)when a component is attached to a page.voidUiLifeCycle. afterComponentAttached(Component comp, Page page)Called after a component is attached to a page.voidConfiguration. afterComponentDetached(Component comp, Page prevpage)InvokesUiLifeCycle.afterComponentDetached(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Page)when a component is detached from a page.voidUiLifeCycle. afterComponentDetached(Component comp, Page prevpage)Called after a component is detached from a page.voidConfiguration. afterComponentMoved(Component parent, Component child, Component prevparent)InvokesUiLifeCycle.afterComponentMoved(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component)when a component is moved (a.k.a., page changed).voidUiLifeCycle. afterComponentMoved(Component parent, Component child, Component prevparent)Called after the parent/children relation is changed.voidConfiguration. afterShadowAttached(ShadowElement shadow, Component host)InvokesUiLifeCycle.afterShadowAttached(ShadowElement, Component)when a shadow is attached to a host.voidUiLifeCycle. afterShadowAttached(ShadowElement shadow, Component host)Called after a shadow is attached to a host.voidConfiguration. afterShadowDetached(ShadowElement shadow, Component prevhost)InvokesUiLifeCycle.afterShadowDetached(ShadowElement, Component)when a shadow is detached from a host.voidUiLifeCycle. afterShadowDetached(ShadowElement shadow, Component prevhost)Called after a shadow is detached from a host.static voidClients. clearBusy(Component comp)Clears the busy message at the browser that covers only the specified component.static voidClients. clearWrongValue(Component comp)Closes the error message of the specified component, if any, at the browser.static voidClients. clearWrongValue(Component[] comps)Closes the error message of the specified components, if any, at the browser.Component[]Template. create(Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, Composer composer)Creates the components defined in this template.voidComponentActivationListener. didActivate(Component comp)Called when a session has just been activated (and its value has been deserialized).voidGenericAutowireComposer. didActivate(Component comp)voidComponentSerializationListener. didDeserialize(Component comp)Called when a component has de-serialized this object back.voidComposition. doAfterCompose(Page page, Component[] comps)voidGenericInitiator. doAfterCompose(Page page, Component[] comps)voidInitiatorExt. doAfterCompose(Page page, Component[] comps)Called after all components are created (a.k.a., composed), and before any event is processed.ComponentInfoComposerExt. doBeforeCompose(Page page, Component parent, ComponentInfo compInfo)Invokes before composing a component.ComponentInfoGenericComposer. doBeforeCompose(Page page, Component parent, ComponentInfo compInfo)static voidClients. focus(Component component)Focus the component (HtmlBasedComponent)static ForEachForEachImpl. getInstance(EvaluatorRef evalr, Component comp, java.lang.String expr, java.lang.String begin, java.lang.String end)Returns an instance that represents the iterator for the specified collection, or null if expr is null or empty.static ForEachForEachImpl. getInstance(EvaluatorRef evalr, Component comp, ExValue[] expr, ExValue begin, ExValue end)Returns an instance that represents the iterator for the specified collection.static ForEachForEachImpl. getInstance(EvaluatorRef evalr, Component comp, ExValue[] expr, ExValue begin, ExValue end, ExValue step)Returns an instance that represents the iterator for the specified collection.voidConfiguration. invokeEventThreadCompletes(java.util.List<EventThreadCleanup> cleanups, Component comp, Event evt, java.util.List<java.lang.Throwable> errs, boolean silent)booleanConfiguration. invokeEventThreadInits(java.util.List<EventThreadInit> inits, Component comp, Event evt)voidConfiguration. invokeEventThreadResumeAborts(Component comp, Event evt)InvokesEventThreadResume.abortResume(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.event.Event)for each relevant listener registered byConfiguration.addListener(java.lang.Class<?>).voidConfiguration. invokeEventThreadResumes(java.util.List<EventThreadResume> resumes, Component comp, Event evt)voidConfiguration. invokeEventThreadSuspends(java.util.List<EventThreadSuspend> suspends, Component comp, Event evt)InvokesEventThreadSuspend.afterSuspend(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.event.Event)for each relevant listener registered byConfiguration.addListener(java.lang.Class<?>).booleanCondition. isEffective(Component comp)Used to evaluate whether it is effective.booleanConditionImpl. isEffective(Evaluator eval, Component comp)Used to evaluate whether it is effective.java.util.List<EventThreadCleanup>Configuration. newEventThreadCleanups(Component comp, Event evt, java.util.List<java.lang.Throwable> errs, boolean silent)InvokesEventThreadCleanup.cleanup(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.event.Event, java.util.List<java.lang.Throwable>)for each relevant listener registered byConfiguration.addListener(java.lang.Class<?>).java.util.List<EventThreadInit>Configuration. newEventThreadInits(Component comp, Event evt)Constructs a list ofEventThreadInitinstances and invokesEventThreadInit.prepare(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.event.Event)for each relevant listener registered byConfiguration.addListener(java.lang.Class<?>).java.util.List<EventThreadResume>Configuration. newEventThreadResumes(Component comp, Event evt)Constructs a list ofEventThreadResumeinstances and invokesEventThreadResume.beforeResume(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.event.Event)for each relevant listener registered byConfiguration.addListener(java.lang.Class<?>).java.util.List<EventThreadSuspend>Configuration. newEventThreadSuspends(Component comp, Event evt, java.lang.Object obj)Constructs a list ofEventThreadSuspendinstances and invokesEventThreadSuspend.beforeSuspend(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.event.Event, java.lang.Object)for each relevant listener registered byConfiguration.addListener(java.lang.Class<?>).static voidClients. resize(Component comp)Forces the client to re-calculate the size of the given component.static voidClients. scrollIntoView(Component cmp)Scrolls the ancestor elements to make the specified element visible.static voidClients. sendClientCommand(Component component, java.lang.String commandName, java.lang.Object data)Send a command to client (afterCommand)static voidNotification. show(java.lang.String msg, java.lang.String type, Component ref, int x, int y, int duration)Displays a message.static voidNotification. show(java.lang.String msg, java.lang.String type, Component ref, int x, int y, int duration, boolean closable)Displays a message.static voidNotification. show(java.lang.String msg, java.lang.String type, Component ref, java.lang.String position, int duration)Displays a message.static voidNotification. show(java.lang.String msg, java.lang.String type, Component ref, java.lang.String position, int duration, boolean closable)Displays a message.static voidNotification. show(java.lang.String msg, Component ref)Shows a message at the right side of the given component.static voidNotification. show(java.lang.String msg, Component ref, boolean closable)Shows a message at the right side of the given component.static voidClients. showBusy(Component comp, java.lang.String msg)Shows the busy message at the browser that covers only the specified component.static voidClients. showNotification(java.lang.String msg, java.lang.String type, Component ref, int x, int y, int duration)Displays a message.static voidClients. showNotification(java.lang.String msg, java.lang.String type, Component ref, int x, int y, int duration, boolean closable)Displays a message.static voidClients. showNotification(java.lang.String msg, java.lang.String type, Component ref, java.lang.String position, int duration)Displays a message.static voidClients. showNotification(java.lang.String msg, java.lang.String type, Component ref, java.lang.String position, int duration, boolean closable)Displays a message.static voidClients. showNotification(java.lang.String msg, Component ref)Shows a message at the right side of the given component.static voidClients. showNotification(java.lang.String msg, Component ref, boolean closable)Shows a message at the right side of the given component.static voidClients. submitForm(Component form)Submits the form with the specified form.static voidClients. syncErrorbox(Component component)Send a command to sync a target component and its errorbox position.java.lang.ObjectComponentCloneListener. willClone(Component comp)Called when a component is going to be cloned.java.lang.ObjectGenericAutowireComposer. willClone(Component comp)Internal use only.voidComponentActivationListener. willPassivate(Component comp)Called when a session is about to be passivated (and then serialize its value).voidGenericAutowireComposer. willPassivate(Component comp)voidComponentSerializationListener. willSerialize(Component comp)Called when a component is going to serialize this object.static voidConventionWires. wireController(Component comp, java.lang.Object controller)Wire controller as an attribute of the specified component.static voidConventionWires. wireController(Component comp, java.lang.Object controller, char separator)Wire controller as an attribute of the specified component with a custom separator.static voidConventionWires. wireImplicit(Component comp, java.lang.Object controller)Wire implicit variables of the specified component into a controller Java object.static voidConventionWires. wireServiceCommand(Component comp, java.lang.Object controller)Wire controller's command method to be an AuService command that the command can be triggered from client side JavaScript.static voidConventionWires. wireVariables(Component comp, java.lang.Object controller)Wire accessible variable objects of the specified component into a controller Java object.static voidConventionWires. wireVariables(Component comp, java.lang.Object controller, char separator)Wire accessible variable objects of the specified component with a custom separator.static voidConventionWires. wireVariables(Component comp, java.lang.Object controller, char separator, boolean ignoreZScript, boolean ignoreXel)Wire controller as a variable objects of the specified component with full control.static voidClients. wrongValue(Component comp, java.lang.String msg)Shows an error message for the specified component, if any, at the browser.Method parameters in org.zkoss.zk.ui.util with type arguments of type Component Modifier and Type Method Description static voidClients. clearWrongValue(java.util.List<Component> comps)Closes the error message of the specified components, if any, at the browser.Constructors in org.zkoss.zk.ui.util with parameters of type Component Constructor Description ForEachImpl(EvaluatorRef evalr, Component comp, java.lang.String expr, java.lang.String begin, java.lang.String end)Constructor.ForEachImpl(EvaluatorRef evalr, Component comp, ExValue[] expr, ExValue begin, ExValue end)Constructor.ForEachImpl(EvaluatorRef evalr, Component comp, ExValue[] expr, ExValue begin, ExValue end, ExValue step)Constructor. -
Uses of Component in org.zkoss.zk.xel
Methods in org.zkoss.zk.xel with parameters of type Component Modifier and Type Method Description java.lang.ObjectEvaluator. evaluate(Component comp, org.zkoss.xel.Expression expression)Evaluates the expression.static java.lang.ObjectEvaluators. evaluate(Evaluator eval, Component comp, java.lang.String expr, java.lang.Class<?> expectedClass)Evaluates the specified expression (which might or might not contain ${ or #{).java.lang.ObjectExValue. getValue(Evaluator eval, Component comp)Returns the value after evaluation. -
Uses of Component in org.zkoss.zk.xel.impl
Methods in org.zkoss.zk.xel.impl with parameters of type Component Modifier and Type Method Description java.lang.ObjectSimpleEvaluator. evaluate(Component comp, org.zkoss.xel.Expression expression)static java.lang.ObjectUtils. evaluateComposite(Evaluator eval, Component comp, java.lang.Object expr)Evaluates the composite expression parsed byUtils.parseComposite(java.lang.String, java.lang.Class, int)against a component.
-