Uses of Interface
org.zkoss.zk.ui.Component
Packages that use Component
Package
Description
-
Uses of Component in org.zkoss.zk.au
Methods in org.zkoss.zk.au with type parameters of type ComponentModifier and TypeMethodDescriptionAuRequests.convertToItems(Desktop desktop, List<String> uuids) Converts the data of the specified request to a set of Component.Methods in org.zkoss.zk.au that return ComponentModifier and TypeMethodDescriptionAuRequest.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 ComponentModifierConstructorDescriptionAuResponse(String cmd, Component depends, Object data) Constructs a response with one or zero data.AuResponse(String cmd, Component depends, 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 ComponentModifier and TypeMethodDescriptionstatic ObjectRetrieves the data associated with an echo event.Constructors in org.zkoss.zk.au.out with parameters of type ComponentModifierConstructorDescriptionAuAppendChild(Component comp, Collection<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) Constructs an echo response that will cause an event to fire when the client echoes back.Constructs an echo response that will cause an event to fire when the client echoes back.AuInsertAfter(Component anchor, Collection<String> contents) AuInsertBefore(Component anchor, Collection<String> contents) Construct AuInvoke to call the peer widget's member function with no argument.Construct AuInvoke to call the peer widget's member function with one boolean argument.Construct AuInvoke to call the peer widget's member function with one double argument.Construct AuInvoke to call the peer widget's member function with one int argument.Construct AuInvoke to call the peer widget's member function with one argument.Construct AuInvoke to call the peer widget's member function with an array of the given arguments.Construct AuInvoke to call the peer widget's member function with two arguments.Construct AuInvoke to call the peer widget's member function with three arguments.Construct AuInvoke to call a client function with variable number of arguments.AuNotification(String msg, String type, Page page, Component ref, int x, int y, int duration, boolean closable) Shows notification at given coordinateAuNotification(String msg, String type, Page page, Component ref, String position, int duration, boolean closable) Shows notification at predefined position.AuResizeWidget(Component comp) Constructs a command to force ZK Client re-calculate the size of the given widget.AuScrollIntoView(Component comp) Constructor.AuSetAttribute(Component comp, String attr, 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, 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.AuWrongValue(Component comp, String message) Constructor parameters in org.zkoss.zk.au.out with type arguments of type Component -
Uses of Component in org.zkoss.zk.ui
Classes in org.zkoss.zk.ui that implement ComponentModifier and TypeClassDescriptionclassA skeletal implementation ofComponent.classA skeletal implementation for HTML based components.classThe implementation of a macro component for HTML-based clients.classA component used to represent XML elements that are associated with the native namespace (http://www.zkoss.org/2005/zk/native).classA skeleton of shadow element that represents as a shadow tree.Methods in org.zkoss.zk.ui with type parameters of type ComponentModifier and TypeMethodDescriptionAbstractComponent.getChildren()Returns a live list of children.Component.getChildren()Returns a live list of children.HtmlShadowElement.getDistributedChildren()ShadowElement.getDistributedChildren()Returns a list of distributed components of the shadow tree, including its descendant.Methods in org.zkoss.zk.ui that return ComponentModifier and TypeMethodDescriptionExecution.createComponents(String uri, Map<?, ?> arg) Creates components that don't belong to any page from a page file specified by an URI.Execution.createComponents(String uri, Component parent, Map<?, ?> arg) Creates components from a page file specified by an URI.Execution.createComponents(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.Execution.createComponents(String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, Map<?, ?> arg) Creates components from a page file specified by an URI with a custom variable resolver and inserts before a particular component.Execution.createComponents(String uri, Page page, org.zkoss.xel.VariableResolver resolver, Map<?, ?> arg) Creates components that belong to the given page from a page file specified by an URI.Execution.createComponents(PageDefinition pagedef, Map<?, ?> arg) Creates components that don't belong to any page from the specified page definition.Execution.createComponents(PageDefinition pagedef, Component parent, Map<?, ?> arg) Creates components from the specified page definition.Execution.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 final ComponentExecutions.createComponents(String uri, Component parent, Map<?, ?> arg) Creates components from a page file specified by an URI.static Component[]Executions.createComponents(String uri, Page page, org.zkoss.xel.VariableResolver resolver, Map<?, ?> arg) Creates components that belong to the given page from a page file specified by an URI.static final ComponentExecutions.createComponents(PageDefinition pagedef, Component parent, Map<?, ?> arg) Creates components based on the specified page definition.static Component[]Executions.createComponents(WebApp wapp, String uri, 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, Map<?, ?> arg) Creates components that don't belong to any page from the specified page definition.Execution.createComponentsDirectly(Reader reader, String extension, Map<?, ?> arg) Creates components that don't belong to any page from the raw content read from the specified reader.Execution.createComponentsDirectly(Reader reader, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content read from the specified reader.Execution.createComponentsDirectly(Reader reader, 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.Execution.createComponentsDirectly(String content, String extension, Map<?, ?> arg) Creates components that don't belong to any page from the raw content specified by a string.Execution.createComponentsDirectly(String content, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content specified by a string.Execution.createComponentsDirectly(String content, 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.Execution.createComponentsDirectly(org.zkoss.idom.Document content, String extension, Map<?, ?> arg) Creates components that don't belong to any page from the raw content specified by a DOM tree.Execution.createComponentsDirectly(org.zkoss.idom.Document content, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content specified by a DOM tree.Execution.createComponentsDirectly(org.zkoss.idom.Document content, 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(Reader reader, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content read from the specified reader.static final ComponentExecutions.createComponentsDirectly(String content, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content specified by a string.static final ComponentExecutions.createComponentsDirectly(org.zkoss.idom.Document content, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content specified by a DOM tree.static Component[]Executions.createComponentsDirectly(WebApp wapp, Reader reader, String extension, 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, String content, String extension, 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, String extension, Map<?, ?> arg) Creates components that don't belong to any page from the raw content specified by a DOM tree.Path.getComponent()Returns the component with this path, or null if no such component.static final ComponentPath.getComponent(String path) Returns the component of the specified path, or null if no such component.static final ComponentPath.getComponent(IdSpace is, String path) Returns the component of the specified path which is related to the specified ID space, or null if no such component.WrongValueException.getComponent()Returns the component that causes this exception, or null.Desktop.getComponentByUuid(String uuid) Returns the component of the specified UUID (getUuid()).Desktop.getComponentByUuidIfAny(String uuid) Returns the component of the specified UUID (getUuid()), or null if not found.The same asAbstractPage.getFellow(String).Returns a component of the specified ID in the same ID space.Returns a component of the specified ID in the same ID space.Returns a component of the specified ID in this ID space.Returns a component of the specified ID in this ID space.AbstractComponent.getFellowIfAny(String compId) AbstractComponent.getFellowIfAny(String compId, boolean recurse) AbstractPage.getFellowIfAny(String compId) AbstractPage.getFellowIfAny(String compId, boolean recurse) The same asAbstractPage.getFellowIfAny(String).Component.getFellowIfAny(String id) Returns a component of the specified ID in the same ID space, or null if not found.Component.getFellowIfAny(String id, boolean recurse) Returns a component of the specified ID in the same ID space, or null if not found.IdSpace.getFellowIfAny(String id) Returns a component of the specified ID in this ID space, or null if not found.IdSpace.getFellowIfAny(String id, boolean recurse) Returns a component of the specified ID in this ID space, or null if not found.AbstractComponent.getFirstChild()Component.getFirstChild()Returns the first child component, or null if no child at all.HtmlShadowElement.getFirstInsertion()Returns the first component of its insertion range.ShadowElement.getFirstInsertion()Returns the first component of its insertion range.ShadowElementCtrl.getFirstInsertion()Returns the first component of its insertion range.AbstractPage.getFirstRoot()Page.getFirstRoot()Returns the first root component.AbstractComponent.getLastChild()Component.getLastChild()Returns the last child component, or null if no child at all.HtmlShadowElement.getLastInsertion()Returns the last component of its insertion range.ShadowElement.getLastInsertion()Returns the last component of its insertion range.ShadowElementCtrl.getLastInsertion()Returns the last component of its insertion range.AbstractPage.getLastRoot()Page.getLastRoot()Returns the last root component.HtmlShadowElement.getNextInsertion()Returns the next insertion point, it may be a component, a shadow element, or null.ShadowElement.getNextInsertion()Returns the next insertion point, it may be a component, a shadow element, or null.ShadowElementCtrl.getNextInsertion()Returns the next insertion point, it may be a component, a shadow element, or null.HtmlShadowElement.getNextInsertionComponentIfAny()Returns the next component before this shadow, if any.AbstractComponent.getNextSibling()Component.getNextSibling()Returns the next sibling, or null if it is the last child.AbstractComponent.getParent()Component.getParent()Returns the parent component, or null if this is the root component.HtmlShadowElement.getPreviousInsertion()Returns the previous insertion point, it may be a component, a shadow element, or null.ShadowElement.getPreviousInsertion()Returns the previous insertion point, it may be a component, a shadow element, or null.ShadowElementCtrl.getPreviousInsertion()Returns the previous insertion point, it may be a component, a shadow element, or null.HtmlShadowElement.getPreviousInsertionComponentIfAny()Returns the first component before this shadow, if any.AbstractComponent.getPreviousSibling()Component.getPreviousSibling()Returns the previous sibling, or null if it is the first child.AbstractComponent.getRoot()Returns the root of the specified component.Component.getRoot()Returns the root of this component.static ComponentReturns the root component of the specified one.HtmlShadowElement.getShadowHost()ShadowElement.getShadowHost()Returns the owner component that hosts this shadow element.HtmlShadowElement.getShadowHostIfAny()ShadowElementCtrl.getShadowHostIfAny()Return the shadow host from it or its ancestor, if any.static final ComponentComponents.pathToComponent(String path, Component ref) Converts a path, generated byComponents.componentToPath(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component), to a component.Find the first component that matches the given CSS3 selector.Methods in org.zkoss.zk.ui that return types with arguments of type ComponentModifier and TypeMethodDescriptionDesktop.getComponents()Returns all components contained in this desktop.AbstractComponent.getFellows()AbstractPage.getFellows()Component.getFellows()Returns all fellows in the same ID space of this component.IdSpace.getFellows()Returns all fellows in this ID space.AbstractComponent.getIndexCacheMap(Component host) HtmlShadowElement.getIndexCacheMap(Component host) Internal useAbstractPage.getRoots()Page.getRoots()Returns a readonly list of the root components.static Collection<Component>Components.getVisibleChildren(Component comp) Returns a collection of visible children.AbstractComponent.initIndexCacheMap(Component host) HtmlShadowElement.initIndexCacheMap(Component host) Internal useAbstractComponent.Children.listIterator(int index) Returns an iterable object for components that match the given CSS3 selector.Methods in org.zkoss.zk.ui with parameters of type ComponentModifier and TypeMethodDescriptionbooleanAbstractComponent.addForward(String orgEvent, Component target, String targetEvent) booleanAbstractComponent.addForward(String orgEvent, Component target, String targetEvent, Object eventData) booleanComponent.addForward(String originalEvent, Component target, String targetEvent) Adds a forward condition to forward the event received by this component to another component.booleanComponent.addForward(String originalEvent, Component target, String targetEvent, Object eventData) Adds a forward condition to forward the event received by this component to another component with extra event data.protected voidCalled 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 final StringComponents.componentToPath(Component comp, Component ref) Converts a component to a path (relevant to another component).protected abstract voidComposes the shadow element.Execution.createComponents(String uri, Component parent, Map<?, ?> arg) Creates components from a page file specified by an URI.Execution.createComponents(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.Execution.createComponents(String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, Map<?, ?> arg) Creates components from a page file specified by an URI with a custom variable resolver and inserts before a particular component.Execution.createComponents(PageDefinition pagedef, Component parent, Map<?, ?> arg) Creates components from the specified page definition.Execution.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 final ComponentExecutions.createComponents(String uri, Component parent, Map<?, ?> arg) Creates components from a page file specified by an URI.static final ComponentExecutions.createComponents(PageDefinition pagedef, Component parent, Map<?, ?> arg) Creates components based on the specified page definition.Execution.createComponentsDirectly(Reader reader, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content read from the specified reader.Execution.createComponentsDirectly(Reader reader, 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.Execution.createComponentsDirectly(String content, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content specified by a string.Execution.createComponentsDirectly(String content, 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.Execution.createComponentsDirectly(org.zkoss.idom.Document content, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content specified by a DOM tree.Execution.createComponentsDirectly(org.zkoss.idom.Document content, 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(Reader reader, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content read from the specified reader.static final ComponentExecutions.createComponentsDirectly(String content, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content specified by a string.static final ComponentExecutions.createComponentsDirectly(org.zkoss.idom.Document content, String extension, Component parent, Map<?, ?> arg) Creates components from the raw content specified by a DOM tree.protected voidAbstractComponent.destroyIndexCacheMap(Component host) voidHtmlShadowElement.destroyIndexCacheMap(Component host) Internal useEvaluates the specified expression with ${link #getVariableResolver} andPage.getFunctionMapper()of the page of the specified component.static final ObjectEvaluates 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.Desktop.getDynamicMediaURI(Component comp, String pathInfo) Returns URI for a dynamic generated media associated with a component.Execution.getEvaluator(Component comp, Class<? extends org.zkoss.xel.ExpressionFactory> expfcls) Returns the evaluator of the current execution.static final EvaluatorExecutions.getEvaluator(Component comp, Class<? extends org.zkoss.xel.ExpressionFactory> expfcls) Returns the evaluator of the current execution.static ObjectComponents.getImplicit(Component comp, String name) Returns the implicit object of the specified name, or null if not found.static ObjectComponents.getImplicit(Page page, Component comp, String name) Returns the implicit object of the specified name, or null if not found.static intHtmlShadowElement.getIndex(ShadowElement owner, Component insertion, Map<Component, Integer> cacheMap) AbstractComponent.getIndexCacheMap(Component host) HtmlShadowElement.getIndexCacheMap(Component host) Internal usestatic final StringReturns the path of the specified component.static ComponentReturns the root component of the specified one.AbstractComponent.getShadowVariable(Component baseChild, String name, boolean recurse) Component.getShadowVariable(Component baseChild, 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 ObjectAbstractComponent.getShadowVariable0(Component baseChild, String name, boolean recurse) protected StringAbstractComponent.getSpecialRendererOutput(Component comp) static Collection<Component>Components.getVisibleChildren(Component comp) Returns a collection of visible children.org.zkoss.xel.FunctionPage.getZScriptFunction(Component comp, String name, Class[] argTypes) Returns the function of the specified name by searching the logical scope of the specified component in all the loaded interpreters.Page.getZScriptVariable(Component comp, 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.AbstractComponent.initIndexCacheMap(Component host) 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 TemplateA shortcut of lookup(comp, comp, name, null, false)static TemplateA shortcut of lookup(comp, base, name, null, false)static TemplateA shortcut of lookup(comp, base, name, compBase, false)static TemplateTemplates.lookup(Component comp, Component base, 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 final ComponentComponents.pathToComponent(String path, Component ref) Converts a path, generated byComponents.componentToPath(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component), to a component.voidQueues 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(String orgEvent, Component target, String targetEvent) booleanComponent.removeForward(String originalEvent, Component target, String targetEvent) Removes a forward condition that was added byaddForward(String, Component, String).protected voidReplace the specified component with this component in the component tree.static voidReplaces a component with another.static voidComponents.replaceChildren(Component parent, Collection<Component> newChildren) Replaces all children of the specified component.HtmlShadowElement.resolveVariable(Component child, String name, boolean recurse) ShadowElementCtrl.resolveVariable(Component child, 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.voidvoidSets the parent component.voidChanges the parent.voidprotected 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, String key, 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 ComponentModifier and TypeMethodDescriptionprotected static voidAbstractComponent.addClientEvent(Class<? extends Component> cls, String evtnm, int flags) Adds an event that the client might send to the server.Page.getComponentDefinition(Class<? extends Component> cls, boolean recurse) Returns the component definition of the specified class, or null if not found.protected StringAbstractComponent.getDefaultMold(Class<? extends Component> klass) Returns the default mold for the given class.static intHtmlShadowElement.getIndex(ShadowElement owner, Component insertion, Map<Component, Integer> cacheMap) static voidComponents.replaceChildren(Component parent, Collection<Component> newChildren) Replaces all children of the specified component.static voidComponents.sort(List<? extends Component> list, int from, int to, Comparator<? super Component> cpr) Sorts the components in the list.static voidComponents.sort(List<? extends Component> list, int from, int to, Comparator<? super Component> cpr) Sorts the components in the list.static voidComponents.sort(List<? extends Component> list, Comparator<? super Component> cpr) Sorts the components in the list.static voidComponents.sort(List<? extends Component> list, Comparator<? super Component> cpr) Sorts the components in the list.Constructors in org.zkoss.zk.ui with parameters of type ComponentModifierConstructorDescriptionArithmeticWrongValueException(Component comp, int code) ArithmeticWrongValueException(Component comp, int code, Object fmtArg) ArithmeticWrongValueException(Component comp, int code, Object[] fmtArgs) ArithmeticWrongValueException(Component comp, int code, Object[] fmtArgs, Object value) ArithmeticWrongValueException(Component comp, String msg, Object value) ArithmeticWrongValueException(Component comp, String msg, Throwable cause, Object value) 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, Object fmtArg) Constructs a wrong value exception to show an error box at the client.WrongValueException(Component comp, int code, Object[] fmtArgs) Constructs a wrong value exception to show an error box at the client.WrongValueException(Component comp, String msg) Constructs a wrong value exception to show an error box at the client.WrongValueException(Component comp, String msg, 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 ComponentModifier and TypeClassDescriptionclassSelectEvent<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 ComponentModifier and TypeMethodDescriptionstatic final <T extends Component,E>
SelectEvent<T,E> SelectEvent.getSelectEvent(AuRequest request) Converts an AU request to a select event.static final <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 ComponentModifier and TypeMethodDescriptionMouseEvent.getAreaComponent()Returns the component representing the area that the click occurs, or null if not associated with any component.final ComponentDropEvent.getDragged()Returns the component being dragged and drop toEvent.getTarget().KeyEvent.getReference()Returns the reference item that is the component causing the key event to be fired.OpenEvent.getReference()Returns the reference that causesEvent.getTarget()to be opened.final 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 ComponentModifier and TypeMethodDescriptionvoidEventThreadResume.abortResume(Component comp, Event evt) Called when the suspended event thread is aborted.static final voidEvents.addEventListeners(Component comp, 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, 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.voidCleans up the event processing thread.voidCalled in the serlvet thread to clean up.static final voidEchos an event.static final voidEchos an event.static UploadEventUploadEvent.getUploadEvent(String name, Component component, AuRequest request) Creates an instance ofUploadEventbased on the event name and component, theUploadEventcontains the upload media(s) from user.booleanInitialize the event processing thread before processing the event.static booleanEvents.isListened(Component comp, String evtnm, boolean asap) Returns whether an event handler or listener is available for the specified component and event.static final voidPosts an instance ofEventto the current execution with the specified priority.static final voidQueues the give event for the specified target to this execution.static final voidPosts an instance ofEventto the current execution.static final voidQueues the give event for the specified target to this execution.voidPrepares the initialization at the servlet thread.static voidSends the event to the target, and processes it immediately.static voidSends 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 ComponentModifierConstructorDescriptionAfterSizeEvent(String name, Component target, int width, int height) Constructs an AfterSizeEvent.CheckEvent(String name, Component target, boolean checked) Constructs a check-relevant event.CheckEvent(String name, Component target, Boolean checked) Constructs a check-relevant event.CreateEvent(String name, Component target, Map<?, ?> args) DOMExceptionEvent(String name, Component target, String errorName, String errorMessage) DropEvent(String name, Component target, Component dragged, int x, int y, int pageX, int pageY, int keys) Constructs a drop event.Constructs an error-relevant event.Constructs a simple event.Constructs a simple event.ForwardEvent(String name, Component target, Event origin) Constructs a forward event.ForwardEvent(String name, Component target, Event origin, Object data) Constructs a forward event.FulfillEvent(String name, Component target, Event origin) Constructs a fulfill event.FulfillEvent(String name, Component target, Event origin, Object data) Constructs a fulfill event.InputEvent(String name, Component target, String val, Object oldValue) Constructs a input-relevant event.InputEvent(String name, Component target, String val, Object oldValue, boolean selbk, int start) Constructs an input eventKeyEvent(String name, Component target, int keyCode, boolean ctrlKey, boolean shiftKey, boolean altKey) KeyEvent(String name, Component target, int keyCode, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, Component ref) Constructs an event with MetaKeyKeyEvent(String name, Component target, int keyCode, boolean ctrlKey, boolean shiftKey, boolean altKey, Component ref) Constructs a mouse relevant event.MaximizeEvent(String name, Component target, String left, String top, String width, String height, boolean maximized) MinimizeEvent(String name, Component target, String left, String top, String width, String height, boolean minimized) MouseEvent(String name, Component target) Construct a mouse relevant event with coordinate or area.MouseEvent(String name, Component target, int x, int y, int pageX, int pageY) Constructs a mouse relevant event.MouseEvent(String name, Component target, int x, int y, int pageX, int pageY, int keys) Constructs a mouse relevant event.MouseEvent(String name, Component target, String area, int keys) Constructs a mouse relevant event with a logic name called area.Constructs a mouse relevant event.Constructs an onOpen event.Constructs an onOpen event for a context menu, a tooltip or a popup.Constructs an onOpen event.ScriptErrorEvent(String name, Component target, String message, String stack) ScrollEvent(String name, Component target, double pos) Constructs an scroll-relevant event.ScrollEvent(String name, Component target, double dPos, boolean outBound) Constructs an scroll-relevant event.ScrollEvent(String name, Component target, int pos) Constructs an scroll-relevant event.ScrollEvent(String name, Component target, int pos, boolean outBound) Constructs an scroll-relevant event.SelectEvent(String name, Component target, Set<T> selectedItems) Constructs a selection event.SelectEvent(String name, Component target, Set<T> selectedItems, Set<T> previousSelectedItems, Set<T> unselectedItems, Set<E> selectedObjects, Set<E> prevSelectedObjects, Set<E> unselectedObjects, T ref, Object data, int keys) Constructs a selection event containing the data objects that model provided.Constructs a selection event.Constructs a selection event.SelectionEvent(String name, Component target, int start, int end, String txt) Constructs a selection event.Constructs a mouse relevant event.SlideEvent(String name, Component target, boolean slide) Constructs an onOpen event.Constructs a sort event.StateChangeEvent(String name, Component target, Integer state) Constructs the state change event.StubEvent(String name, Component target, String cmd, String uuid, String id, Map<String, Object> data) Constructs a check-relevant event.SwipeEvent(String name, Component target, int swipeX, int swipeY, int swipeTime, String swipeDir) UploadEvent(String name, Component target, org.zkoss.util.media.Media[] meds) Constructs the upload event.Constructs an URI update event.ZIndexEvent(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 ComponentModifier and TypeMethodDescriptionCreates a native component with the specified content.Methods in org.zkoss.zk.ui.ext with parameters of type ComponentModifier and TypeMethodDescriptionstatic StringUploads.getRealUpload(Component comp, String upload) Gets the real upload setting for client.static voidUploads.parseUpload(Component comp, 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 ComponentModifier and TypeMethodDescriptionCropper.getCropOwner()Returns the owner of the cropping scope.Methods in org.zkoss.zk.ui.ext.render that return types with arguments of type ComponentModifier and TypeMethodDescriptionCropper.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 -
Uses of Component in org.zkoss.zk.ui.impl
Classes in org.zkoss.zk.ui.impl with type parameters of type ComponentModifier and TypeClassDescriptionclassMultiComposer<T extends Component>To proxy a collection of composers.Methods in org.zkoss.zk.ui.impl that return ComponentModifier and TypeMethodDescriptionAbstractExecution.createComponents(String uri, Map<?, ?> arg) AbstractExecution.createComponents(String uri, Component parent, Map<?, ?> arg) AbstractExecution.createComponents(String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver) AbstractExecution.createComponents(String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, Map<?, ?> arg) AbstractExecution.createComponents(String uri, Page page, org.zkoss.xel.VariableResolver resolver, Map<?, ?> arg) AbstractExecution.createComponents(PageDefinition pagedef, Map<?, ?> arg) AbstractExecution.createComponents(PageDefinition pagedef, Component parent, Map<?, ?> arg) AbstractExecution.createComponents(PageDefinition pagedef, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver) UiEngineImpl.createComponents(Execution exec, PageDefinition pagedef, Page page, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(Reader reader, String ext, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(Reader reader, String ext, Component parent, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(Reader reader, String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver) AbstractExecution.createComponentsDirectly(String content, String ext, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(String content, String ext, Component parent, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(String content, String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver) AbstractExecution.createComponentsDirectly(org.zkoss.idom.Document content, String ext, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(org.zkoss.idom.Document content, String ext, Component parent, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(org.zkoss.idom.Document content, String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver) final ComponentEventProcessingThreadImpl.getComponent()final ComponentEventProcessor.getComponent()Returns the component.DesktopImpl.getComponentByUuid(String uuid) DesktopImpl.getComponentByUuidIfAny(String uuid) final ComponentPageImpl.getOwner()ProxyEvent.getRealTarget()Returns the real target.DesktopImpl.mapComponent(String uuid, Component comp) AbstractUiFactory.newComponent(Page page, Component parent, ComponentDefinition compdef, String clsnm) AbstractUiFactory.newComponent(Page page, Component parent, ComponentInfo compInfo, Component insertBefore) AbstractUiFactory.newComponent(Page page, Component parent, ShadowInfo compInfo, Component insertBefore) Methods in org.zkoss.zk.ui.impl that return types with arguments of type ComponentMethods in org.zkoss.zk.ui.impl with parameters of type ComponentModifier and TypeMethodDescriptionvoidDesktopImpl.addComponent(Component comp) voidPageImpl.addDeferredZScript(Component parent, ZScript zscript) voidUiEngineImpl.addInvalidate(Component comp) voidvoidUiEngineImpl.addSmartUpdate(Component comp, String attr, Object value, boolean append) voidUiEngineImpl.addSmartUpdate(Component comp, String attr, 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) AbstractExecution.createComponents(String uri, Component parent, Map<?, ?> arg) AbstractExecution.createComponents(String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver) AbstractExecution.createComponents(String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, Map<?, ?> arg) AbstractExecution.createComponents(PageDefinition pagedef, Component parent, Map<?, ?> arg) AbstractExecution.createComponents(PageDefinition pagedef, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver) UiEngineImpl.createComponents(Execution exec, PageDefinition pagedef, Page page, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(Reader reader, String ext, Component parent, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(Reader reader, String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver) AbstractExecution.createComponentsDirectly(String content, String ext, Component parent, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(String content, String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver) AbstractExecution.createComponentsDirectly(org.zkoss.idom.Document content, String ext, Component parent, Map<?, ?> arg) AbstractExecution.createComponentsDirectly(org.zkoss.idom.Document content, String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver) booleanUiEngineImpl.disableClientUpdate(Component comp, boolean disable) MultiComposer.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.DesktopImpl.getDynamicMediaURI(Component comp, String pathInfo) UiEngineImpl.getNativeContent(Component comp, List<NodeInfo> children, Native.Helper helper) DesktopImpl.getNextUuid(Component comp) org.zkoss.xel.FunctionPageImpl.getZScriptFunction(Component comp, String name, Class[] argTypes) PageImpl.getZScriptVariable(Component comp, String name) booleanUiEngineImpl.isInvalidated(Component comp) DesktopImpl.mapComponent(String uuid, Component comp) AbstractUiFactory.newComponent(Page page, Component parent, ComponentDefinition compdef, String clsnm) AbstractUiFactory.newComponent(Page page, Component parent, ComponentInfo compInfo, Component insertBefore) AbstractUiFactory.newComponent(Page page, Component parent, ShadowInfo compInfo, Component insertBefore) StaticIdGenerator.nextComponentUuid(Desktop desktop, Component comp, ComponentInfo compInfo) voidDesktopImpl.onPiggybackListened(Component comp, boolean listen) voidbooleanEventProcessingThreadImpl.processEvent(Desktop desktop, Component comp, Event event) Ask this event thread to process the specified event.booleanDesktopImpl.removeComponent(Component comp) voidstatic voidUtils.setComponentInfo(Component comp, ComponentInfo info) Sets the component info for the given component.final voidstatic voidUtils.setShadowInfo(Component comp, ShadowInfo info) Sets the component info for the given component.static final booleanUtils.testAttribute(Component comp, 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 ComponentModifier and TypeMethodDescriptionprotected voidUiEngineImpl.afterRenderComponents(Collection<Component> comps) Called when this engine renders the given components.voidUiEngineImpl.Extension.afterRenderComponents(Collection<Component> comps) Called when this engine renders the given components.PageImpl.getComponentDefinition(Class<? extends Component> cls, boolean recurse) Constructors in org.zkoss.zk.ui.impl with parameters of type ComponentModifierConstructorDescriptionEventProcessor(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 ComponentModifier and TypeMethodDescriptionComponentDefinition.newInstance(Class<? extends Component> cls) Creates an component of this definition.ComponentDefinition.newInstance(Page page, String clsnm) Creates an component of this definition.ComponentInfo.newInstance(Page page) Creates an component based on this info (never null).ComponentInfo.newInstance(Page page, Component parent) Creates an component based on this info (never null).NativeInfo.newInstance(Page page, Component parent) ShadowInfo.newInstance(Page page) Creates a shadow element based on this info (never null).ShadowInfo.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 ComponentModifier and TypeMethodDescriptionvoidApplies the custom attributes.voidApplies the custom attributes.voidApplies 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.voidAssigns the value of this member to the specified component.static final voidAssigns a property.voidvoidvoidEvaluates and retrieves properties to the specified map.ComponentInfo.evalProperties(Map<String, Object> propmap, Page owner, Component parent, boolean defIncluded) Evaluates and retrieves properties to the specified map fromComponentDefinition(andComponentInfo).Returns the first effective event handler of the specified event name, or null if not available.ZScript.getContent(Page page, Component comp) Returns the content of zscript.ZScriptInfo.getContent(Page page, Component comp) Returns the content of zscript.ComponentDefinition.getDefaultWidgetClass(Component comp) Returns the default widget class, or null if not available.Returns the script associated with this event handler.Returns the URI to create the template from, or null if not specified.Evaluates the value to an Object.Returns the value after evaluation.Returns the value associated with this event handler.ComponentDefinition.getWidgetClass(Component comp, 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.ComponentInfo.newInstance(Page page, Component parent) Creates an component based on this info (never null).NativeInfo.newInstance(Page page, Component parent) ShadowInfo.newInstance(Page page, Component parent) Creates an component based on this info (never null).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.ComponentInfo.resolveComposer(Page page, Component comp) Returns the composer for this info, or null if not available.ComponentInfo.resolveImplementationClass(Page page, Component parent) Resolves and returns the class for the component represented by this info (never null).TemplateInfo.resolveParameters(Component comp) Evaluates and returns a readonly map of parameters assigned to this template (never null).ZkInfo.resolveSwitch(Page page, Component comp) Returns the switch condition's value; evaluate EL expression if any.ComponentInfo.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 ComponentModifier and TypeMethodDescriptionComponentDefinition.newInstance(Class<? extends Component> cls) Creates an component of this definition.voidComponentDefinition.setImplementationClass(Class<? extends Component> cls) Sets the class to implements the component.voidLanguageDefinition.setMacroTemplate(Class<? extends Component> klass) Sets the macro template.voidLanguageDefinition.setNativeTemplate(Class<? extends Component> klass) Sets the native template.voidLanguageDefinition.setShadowTemplate(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 ComponentModifier and TypeMethodDescriptionComponentDefinitionImpl.newInstance(Class<? extends Component> cls) ComponentDefinitionImpl.newInstance(Page page, String clsnm) Methods in org.zkoss.zk.ui.metainfo.impl with parameters of type ComponentModifier and TypeMethodDescriptionvoidAnnotationHelper.applyAnnotations(Component comp, String propName, boolean clear) Applies the annotations defined in this helper to the specified component.voidComponentDefinitionImpl.applyAttributes(Component comp) voidComponentDefinitionImpl.applyProperties(Component comp) ComponentDefinitionImpl.getDefaultWidgetClass(Component comp) ComponentDefinitionImpl.getWidgetClass(Component comp, String moldName) booleanComponentDefinitionImpl.isInstance(Component comp) Method parameters in org.zkoss.zk.ui.metainfo.impl with type arguments of type ComponentModifier and TypeMethodDescriptionComponentDefinitionImpl.newInstance(Class<? extends Component> cls) static final ComponentDefinitionComponentDefinitionImpl.newMacroDefinition(LanguageDefinition langdef, PageDefinition pgdef, String name, Class<? extends Component> cls, String macroURI, boolean inline) Constructs a macro component definition.static final ComponentDefinitionComponentDefinitionImpl.newNativeDefinition(LanguageDefinition langdef, String name, Class<? extends Component> cls) Constructs a native component definition.static final ComponentDefinitionComponentDefinitionImpl.newShadowDefinition(LanguageDefinition langdef, PageDefinition pgdef, String name, Class<? extends Component> cls, String templateURI) Constructs a shadow component definition.voidComponentDefinitionImpl.setImplementationClass(Class<? extends Component> cls) Constructor parameters in org.zkoss.zk.ui.metainfo.impl with type arguments of type ComponentModifierConstructorDescriptionComponentDefinitionImpl(LanguageDefinition langdef, PageDefinition pgdef, String name, Class<? extends Component> cls) Constructs a native component, i.e., a component implemented by a Java class.ShadowDefinitionImpl(LanguageDefinition langdef, PageDefinition pgdef, String name, 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 ComponentModifier and TypeClassDescriptionclassSelectorComposer<T extends Component>A composer analogous to GenericForwardComposer.Methods in org.zkoss.zk.ui.select that return types with arguments of type ComponentModifier and TypeMethodDescriptionReturns a list of Components that match the selector (from the first page of current Desktop).Returns a list of Components that match the selector.Returns a list of Components that match the selector.Returns an Iterable that iterates through all Components matched by the selector.Returns an Iterable that iterates through all Components matched by the selector.Methods in org.zkoss.zk.ui.select with parameters of type ComponentModifier and TypeMethodDescriptionvoidSelectorComposer.didActivate(Component comp) SelectorComposer.doBeforeCompose(Page page, Component parent, ComponentInfo compInfo) Returns a list of Components that match the selector.Returns an Iterable that iterates through all Components matched by the selector.static voidSelectors.rewireComponentsOnActivate(Component component, Object controller) Rewire the components on session activationstatic voidSelectors.rewireVariablesOnActivate(Component component, Object controller, List<org.zkoss.xel.VariableResolver> extraResolvers) Rewire the variables on session activationInternal use only.voidSelectorComposer.willPassivate(Component comp) static voidSelectors.wireComponents(Component component, Object controller, boolean ignoreNonNull) Wire components to controller.static voidSelectors.wireEventListeners(Component component, Object controller) Add event listeners to components based on the controller.static voidSelectors.wireVariables(Component component, Object controller, 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 ComponentModifier and TypeMethodDescriptionComponentMatchCtx.getComponent()Return the component.ComponentIterator.next()Return the next matched component.ComponentIterator.peek()Return the next matched component, but the iteration is not proceeded.Methods in org.zkoss.zk.ui.select.impl with parameters of type ComponentModifier and TypeMethodDescriptionstatic booleanReturns true if the selector matches the given component.static booleanComponentLocalProperties.match(Component component, String selector, Map<String, PseudoClassDef> defs) Returns true if the selector matches the given component.Constructors in org.zkoss.zk.ui.select.impl with parameters of type ComponentModifierConstructorDescriptionComponentIterator(Component root, 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 ComponentModifier and TypeClassDescriptionclassA stub component is a 'degenerated' component that does not maintain the states at the server.classRepresents a tree ofStubComponentthat are merged into a single component.Methods in org.zkoss.zk.ui.sys that return ComponentModifier and TypeMethodDescriptionUiEngine.createComponents(Execution exec, PageDefinition pagedef, Page page, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, Map<?, ?> arg) Creates components from the specified page and definition.static final Component[]ShadowElementsCtrl.filterOutShadows(Component[] shadows) Returns the component array filter out shadows if any.EventProcessingThread.getComponent()Returns the component being processed by this thread, or null if idle.PageCtrl.getOwner()Returns the owner of this page, or null if it is not owned by any component.Visualizer.getOwner()Returns the owner component for this execution, or null if this execution is not owned by any component.static final 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)DesktopCtrl.mapComponent(String uuid, Component comp) Maps a component associated with the given UUID to this page.UiFactory.newComponent(Page page, Component parent, ComponentDefinition compdef, String clsnm) Creates and initializes a component based on the specifiedComponentDefinition.UiFactory.newComponent(Page page, Component parent, ComponentInfo compInfo, Component insertBefore) Creates and initializes a component based on the specifiedComponentInfo.UiFactory.newComponent(Page page, Component parent, ShadowInfo compInfo, Component insertBefore) Creates and initializes a shadow based on the specifiedShadowInfo.Called before a component redraws itself if the component might include another page.Methods in org.zkoss.zk.ui.sys with parameters of type ComponentModifier and TypeMethodDescriptionvoidDesktopCtrl.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.voidCalled to update (redraw) a component, when a component is moved.voidUiEngine.addSmartUpdate(Component comp, String attr, Object value, boolean append) Smart-updates a property of the peer widget.voidUiEngine.addSmartUpdate(Component comp, String attr, 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 final voidComponentsCtrl.applyForward(Component comp, 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.UiEngine.createComponents(Execution exec, PageDefinition pagedef, Page page, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, 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 final Component[]ShadowElementsCtrl.filterOutShadows(Component[] shadows) Returns the component array filter out shadows if any.static final ObjectShadowElementsCtrl.getDistributedIndexInfo(Component host) Returns the current distributed index info, which is used only byHtmlShadowElement.UiEngine.getNativeContent(Component comp, List<NodeInfo> children, Native.Helper helper) Retrieve the native content for a property of the specified component.DesktopCtrl.getNextUuid(Component comp) Returns the next available UUID for a component.booleanUiEngine.isInvalidated(Component comp) Returns if this component needs to be redrawn.protected voidStubsComponent.mapChildren(DesktopCtrl desktopCtrl, List<String> uuids, List<String[]> idmap, List<Object[]> evtmap, Component comp) DesktopCtrl.mapComponent(String uuid, Component comp) Maps a component associated with the given UUID to this page.UiFactory.newComponent(Page page, Component parent, ComponentDefinition compdef, String clsnm) Creates and initializes a component based on the specifiedComponentDefinition.UiFactory.newComponent(Page page, Component parent, ComponentInfo compInfo, Component insertBefore) Creates and initializes a component based on the specifiedComponentInfo.UiFactory.newComponent(Page page, Component parent, ShadowInfo compInfo, Component insertBefore) Creates and initializes a shadow based on the specifiedShadowInfo.default StringIdGenerator.nextAnonymousComponentUuid(Component comp, ComponentInfo compInfo) Returns the next anonymous component UUID for the specified component, or null to generate the default UUID.default 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 final voidHtmlPageRenders.outStandalone(Execution exec, Component comp, 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 Object[]ComponentsCtrl.parseEventExpression(Component comp, 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.voidReplace the specified component with this component in the component tree.voidSends the specified component and event and processes the event synchronously.voidServices the event under the given page and scope.static final voidShadowElementsCtrl.setDistributedIndexInfo(Component host, Object indexMapInfo) Sets the current distributed index info, which is used only byHtmlShadowElement.voidSets the owner of this page.Called before a component redraws itself if the component might include another page.static final voidComponentsCtrl.setRootParent(Component comp) Sets root parentvoidMethod parameters in org.zkoss.zk.ui.sys with type arguments of type ComponentModifier and TypeMethodDescriptionstatic final Collection<org.zkoss.json.JavaScriptValue>ComponentsCtrl.redraw(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 ComponentModifier and TypeInterfaceDescriptioninterfaceRepresents 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 ComponentModifier and TypeFieldDescriptionprotected TGenericAutowireComposer.selfImplicit Object; the applied component itself.Methods in org.zkoss.zk.ui.util that return ComponentModifier and TypeMethodDescriptionTemplate.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 ComponentModifier and TypeMethodDescriptionstatic voidConventionWires.addForwards(Component comp, 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, 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 final voidClears the busy message at the browser that covers only the specified component.static final voidClients.clearWrongValue(Component comp) Closes the error message of the specified component, if any, at the browser.static final voidClients.clearWrongValue(Component[] comps) Closes the error message of the specified components, if any, at the browser.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.ComposerExt.doBeforeCompose(Page page, Component parent, ComponentInfo compInfo) Invokes before composing a component.GenericComposer.doBeforeCompose(Page page, Component parent, ComponentInfo compInfo) static final voidFocus the component (HtmlBasedComponent)static ForEachForEachImpl.getInstance(EvaluatorRef evalr, Component comp, String expr, String begin, 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(List<EventThreadCleanup> cleanups, Component comp, Event evt, List<Throwable> errs, boolean silent) booleanConfiguration.invokeEventThreadInits(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(List<EventThreadResume> resumes, Component comp, Event evt) voidConfiguration.invokeEventThreadSuspends(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.Configuration.newEventThreadCleanups(Component comp, Event evt, List<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<?>).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<?>).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<?>).Configuration.newEventThreadSuspends(Component comp, Event evt, 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 final voidForces the client to re-calculate the size of the given component.static final voidClients.scrollIntoView(Component cmp) Scrolls the ancestor elements to make the specified element visible.static final voidClients.sendClientCommand(Component component, String commandName, Object data) Send a command to client (afterCommand)static voidDisplays a message.static voidNotification.show(String msg, String type, Component ref, int x, int y, int duration, boolean closable) Displays a message.static voidDisplays a message.static voidNotification.show(String msg, String type, Component ref, String position, int duration, boolean closable) Displays a message.static voidShows a message at the right side of the given component.static voidShows a message at the right side of the given component.static final voidShows the busy message at the browser that covers only the specified component.static final voidClients.showNotification(String msg, String type, Component ref, int x, int y, int duration) Displays a message.static final voidClients.showNotification(String msg, String type, Component ref, int x, int y, int duration, boolean closable) Displays a message.static final voidClients.showNotification(String msg, String type, Component ref, String position, int duration) Displays a message.static final voidClients.showNotification(String msg, String type, Component ref, String position, int duration, boolean closable) Displays a message.static final voidClients.showNotification(String msg, Component ref) Shows a message at the right side of the given component.static final voidClients.showNotification(String msg, Component ref, boolean closable) Shows a message at the right side of the given component.static final voidClients.submitForm(Component form) Submits the form with the specified form.static final voidClients.syncErrorbox(Component component) Send a command to sync a target component and its errorbox position.Called when a component is going to be cloned.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 final voidConventionWires.wireController(Component comp, Object controller) Wire controller as an attribute of the specified component.static final voidConventionWires.wireController(Component comp, Object controller, char separator) Wire controller as an attribute of the specified component with a custom separator.static final voidConventionWires.wireImplicit(Component comp, Object controller) Wire implicit variables of the specified component into a controller Java object.static final voidConventionWires.wireServiceCommand(Component comp, Object controller) Wire controller's command method to be an AuService command that the command can be triggered from client side JavaScript.static final voidConventionWires.wireVariables(Component comp, Object controller) Wire accessible variable objects of the specified component into a controller Java object.static final voidConventionWires.wireVariables(Component comp, Object controller, char separator) Wire accessible variable objects of the specified component with a custom separator.static final voidConventionWires.wireVariables(Component comp, Object controller, char separator, boolean ignoreZScript, boolean ignoreXel) Wire controller as a variable objects of the specified component with full control.static final voidClients.wrongValue(Component comp, 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 ComponentModifier and TypeMethodDescriptionstatic final voidClients.clearWrongValue(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 ComponentModifierConstructorDescriptionForEachImpl(EvaluatorRef evalr, Component comp, String expr, String begin, 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 ComponentModifier and TypeMethodDescriptionEvaluates the expression.static ObjectEvaluates the specified expression (which might or might not contain ${ or #{).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 ComponentModifier and TypeMethodDescriptionstatic ObjectUtils.evaluateComposite(Evaluator eval, Component comp, Object expr) Evaluates the composite expression parsed byUtils.parseComposite(java.lang.String, java.lang.Class, int)against a component.