Package org.zkoss.zul

Class Chip

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
    public class Chip
extends LabelImageElement
implements org.zkoss.zk.ui.ext.Disable
    A display-only chip used to show categories, statuses, or keywords, with an optional close button and a severity theme.

    There is no color attribute on this component. To customize appearance, either set the style attribute (e.g. style="--zk-chip-bg: #6366f1;") or override the CSS custom properties --zk-chip-bg / --zk-chip-color / --zk-chip-border declared in chip.less.

    Default getZclass(): "z-chip".

    Since:
    10.4.0
    Author:
    yuehfeng
    See Also:
    Serialized Form

    • Nested Class Summary

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

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

    • Field Summary

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

        _zclass

      • Fields inherited from interface org.zkoss.zk.ui.Component

        APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

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

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

    • Constructor Summary

      Constructors 
      Constructor Description
      Chip()  
      Chip​(java.lang.String label)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getSeverity()
      Returns the severity (color theme).
      java.lang.String getSize()
      Returns the size of this chip.
      java.lang.String getZclass()  
      boolean isChildable()  
      boolean isClosable()
      Whether this chip displays a close button.
      boolean isDisabled()
      Whether this chip is non-interactive.
      boolean isRounded()
      Whether this chip is rounded (pill-shaped).
      void onClose()
      Handles the onClose event sent when the close button is clicked.
      protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)  
      void setClosable​(boolean closable)
      Sets whether this chip displays a close button.
      void setDisabled​(boolean disabled)
      Sets whether this chip is non-interactive.
      void setRounded​(boolean rounded)
      Sets whether this chip is rounded (pill-shaped).
      void setSeverity​(java.lang.String severity)
      Sets the severity.
      void setSize​(java.lang.String size)
      Sets the chip size.

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

        addSclass, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, service, setAction, setClass, setClientAction, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

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

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Chip

        public Chip()

      • Chip

        public Chip​(java.lang.String label)

    • Method Detail

      • getSeverity

        public java.lang.String getSeverity()
        Returns the severity (color theme).

        Default: "info".

      • setSeverity

        public void setSeverity​(java.lang.String severity)
                 throws org.zkoss.zk.ui.WrongValueException
        Sets the severity.
        Parameters:
        severity - one of "info", "success", "warning", "danger", "secondary". Pass null to reset to the default ("info").
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • getSize

        public java.lang.String getSize()
        Returns the size of this chip.

        Default: "medium". One of "small" or "medium"; medium maps to the default 22px row, small reduces the row height for dense layouts.

      • setSize

        public void setSize​(java.lang.String size)
             throws org.zkoss.zk.ui.WrongValueException
        Sets the chip size.
        Parameters:
        size - "small" or "medium". Pass null to reset to the default ("medium").
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • isDisabled

        public boolean isDisabled()
        Whether this chip is non-interactive. Disabled chips ignore close clicks and render at reduced opacity.
        Specified by:
        isDisabled in interface org.zkoss.zk.ui.ext.Disable

      • setDisabled

        public void setDisabled​(boolean disabled)
        Sets whether this chip is non-interactive. Disabled chips ignore close clicks and render at reduced opacity.
        Specified by:
        setDisabled in interface org.zkoss.zk.ui.ext.Disable
        Parameters:
        disabled - whether the chip is disabled. Calls smartUpdate when changed.

      • isRounded

        public boolean isRounded()
        Whether this chip is rounded (pill-shaped).

      • setRounded

        public void setRounded​(boolean rounded)
        Sets whether this chip is rounded (pill-shaped).
        Parameters:
        rounded - whether the chip is rounded. Calls smartUpdate when changed.

      • isClosable

        public boolean isClosable()
        Whether this chip displays a close button.

      • setClosable

        public void setClosable​(boolean closable)
        Sets whether this chip displays a close button.
        Parameters:
        closable - whether the chip displays a close button. Calls smartUpdate when changed.

      • getZclass

        public java.lang.String getZclass()
        Overrides:
        getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

      • renderProperties

        protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws java.io.IOException
        Overrides:
        renderProperties in class LabelImageElement
        Throws:
        java.io.IOException

      • onClose

        public void onClose()
        Handles the onClose event sent when the close button is clicked.

        Default: detach this chip. Override or use event.stopPropagation() to keep the chip visible. Follows the same pattern as Window.onClose() — the framework's event-dispatch machinery skips the default handler when a prior listener stops propagation.

        Since:
        10.4.0

      • isChildable

        public boolean isChildable()
        Overrides:
        isChildable in class org.zkoss.zk.ui.AbstractComponent