Interface CommentIcon

  • All Superinterfaces:
    java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.api.HtmlBasedComponent, org.zkoss.zk.ui.ext.Scope, java.io.Serializable, org.zkoss.zul.impl.api.XulElement
    All Known Implementing Classes:
    DivCommentIcon

    public interface CommentIcon
    extends org.zkoss.zul.impl.api.XulElement
    Interface defines capabilities of a html-based element that represents the comment on the comment layer.
    • Field Summary

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

        APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.zkoss.zul.Image getIcon()
      Returns the icon
      java.lang.String getId()
      Return the ID of the component
      java.lang.String getImageURI()
      Returns the image URI of the comment icon.
      CommentIconModel getModel()
      Returns the model representing the current icon's state
      void refresh()
      Refresh icon component
      void scale​(double xRatio, double yRatio)
      Handler for scaling the comment icon
      • Methods inherited from interface org.zkoss.zk.ui.Component

        addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getDefinition, getDesktop, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getShadowVariable, getShadowVariable, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, query, queryAll, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride
      • Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

        focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
      • Methods inherited from interface org.zkoss.zk.ui.ext.Scope

        addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
      • Methods inherited from interface org.zkoss.zul.impl.api.XulElement

        getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
    • Method Detail

      • getImageURI

        java.lang.String getImageURI()
        Returns the image URI of the comment icon.
      • refresh

        void refresh()
        Refresh icon component
      • getIcon

        org.zkoss.zul.Image getIcon()
        Returns the icon
      • getModel

        CommentIconModel getModel()
        Returns the model representing the current icon's state
      • scale

        void scale​(double xRatio,
                   double yRatio)
        Handler for scaling the comment icon
        Parameters:
        xRatio - - x scale ratio
        yRatio - - y scale ratio
      • getId

        java.lang.String getId()
        Return the ID of the component
        Specified by:
        getId in interface org.zkoss.zk.ui.Component