Package org.zkoss.zul

Class Confirmpopup

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
    public class Confirmpopup
extends Popup
    An inline confirmation popup — lighter than Messagebox, anchored to a trigger component. Fires Events.ON_OK when the user confirms, Events.ON_CANCEL when they cancel or dismiss.

    Default getZclass(): "z-confirmpopup".

    Since:
    10.4.0
    Author:
    yuehfeng
    See Also:
    Serialized Form

    • Nested Class Summary

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

        org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultFocus()  
      java.lang.String getHeader()
      Returns the optional header (title row) shown above the message body.
      java.lang.String getIconSclass()
      Returns the icon CSS class shown beside the message.
      java.lang.String getMessage()
      Returns the confirmation message shown in the popup body.
      java.lang.String getPlacement()  
      java.lang.String getSeverity()
      Returns the severity, which drives the icon/color styling of the popup.
      java.lang.String getZclass()  
      protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)  
      void setDefaultFocus​(java.lang.String defaultFocus)
      Sets which button gets keyboard focus when the popup opens.
      void setHeader​(java.lang.String header)
      Sets the optional header (title row) shown above the message body.
      void setIconSclass​(java.lang.String iconSclass)
      Sets the icon CSS class.
      void setMessage​(java.lang.String message)
      Sets the confirmation message shown in the popup body.
      void setPlacement​(java.lang.String placement)
      Sets the placement of this popup relative to the trigger element.
      void setSeverity​(java.lang.String severity)
      Sets the severity, which drives the icon/color styling of the popup.

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

        addSclass, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, 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, isChildable, 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, 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

      • Confirmpopup

        public Confirmpopup()

      • Confirmpopup

        public Confirmpopup​(java.lang.String message)

    • Method Detail

      • getHeader

        public java.lang.String getHeader()
        Returns the optional header (title row) shown above the message body. Mirrors PrimeNG Confirmpopup's header property.
        Since:
        10.4.0

      • setHeader

        public void setHeader​(java.lang.String header)
        Sets the optional header (title row) shown above the message body.
        Parameters:
        header - the header text; null or an empty string clears it (the popup renders with no title row). Pushes the change to the client via smartUpdate.
        Since:
        10.4.0

      • getMessage

        public java.lang.String getMessage()
        Returns the confirmation message shown in the popup body.

        Default: null (no message).

        Since:
        10.4.0

      • setMessage

        public void setMessage​(java.lang.String message)
        Sets the confirmation message shown in the popup body.
        Parameters:
        message - the message text; null or an empty string clears it. Pushes the change to the client via smartUpdate.
        Since:
        10.4.0

      • getIconSclass

        public java.lang.String getIconSclass()
        Returns the icon CSS class shown beside the message.

        Default: "z-icon-exclamation-triangle". An empty string means the icon is explicitly suppressed (no icon node is rendered).

        Since:
        10.4.0

      • setIconSclass

        public void setIconSclass​(java.lang.String iconSclass)
        Sets the icon CSS class.
        • null restores the default ("z-icon-exclamation-triangle").
        • An empty string explicitly suppresses the icon — the popup renders with no icon node.
        • Any other value is used as the icon's CSS class.

      • getSeverity

        public java.lang.String getSeverity()
        Returns the severity, which drives the icon/color styling of the popup.

        Default: "warning". One of "info", "success", "warning", "danger" or "secondary".

        Since:
        10.4.0

      • setSeverity

        public void setSeverity​(java.lang.String severity)
                 throws org.zkoss.zk.ui.WrongValueException
        Sets the severity, which drives the icon/color styling of the popup.
        Parameters:
        severity - one of "info", "success", "warning", "danger" or "secondary"; null restores the default ("warning"). Pushes the change to the client via smartUpdate.
        Throws:
        org.zkoss.zk.ui.WrongValueException - if severity is non-null and is not one of the accepted tokens.
        Since:
        10.4.0

      • getPlacement

        public java.lang.String getPlacement()
        Returns:
        the placement of this popup relative to the trigger element. One of "top" (default) / "bottom" / "left" / "right". The arrow points from this popup toward the trigger.
        Since:
        10.4.0

      • setPlacement

        public void setPlacement​(java.lang.String placement)
                  throws org.zkoss.zk.ui.WrongValueException
        Sets the placement of this popup relative to the trigger element.
        Parameters:
        placement - one of "top" (default), "bottom", "left" or "right"; null restores the default ("top"). Pushes the change to the client via smartUpdate.
        Throws:
        org.zkoss.zk.ui.WrongValueException - if placement is non-null and is not one of the accepted tokens.
        Since:
        10.4.0

      • getDefaultFocus

        public java.lang.String getDefaultFocus()
        Returns:
        which button gets keyboard focus when the popup opens — either "ok" (default) or "cancel". For destructive operations (severity="danger"), prefer "cancel" so an accidental Enter keypress does not commit the action.
        Since:
        10.4.0

      • setDefaultFocus

        public void setDefaultFocus​(java.lang.String defaultFocus)
                     throws org.zkoss.zk.ui.WrongValueException
        Sets which button gets keyboard focus when the popup opens.
        Parameters:
        defaultFocus - either "ok" (default) or "cancel"; null restores the default ("ok"). For destructive operations (severity="danger"), prefer "cancel" so an accidental Enter keypress does not commit the action. Pushes the change to the client via smartUpdate.
        Throws:
        org.zkoss.zk.ui.WrongValueException - if defaultFocus is non-null and is neither "ok" nor "cancel".
        Since:
        10.4.0

      • getZclass

        public java.lang.String getZclass()
        Overrides:
        getZclass in class Popup

      • renderProperties

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