Package org.adempiere.webui.component

Class ConfirmPanel

  • All Implemented Interfaces:
    Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
    public final class ConfirmPanel
extends org.zkoss.zul.Div
    Application Confirm Panel Web UI port of the rich client's ConfirmPanel by Jorg Janke
    Author:
    Sendy Yagambrum
    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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String A_CANCEL
      Action String Cancel.
      static String A_CUSTOMIZE
      Action String Customize.
      static String A_DELETE
      Action String Delete.
      static String A_EXPORT
      Action String Export.
      static String A_HELP
      Action String Help.
      static String A_HISTORY
      Action String History.
      static String A_NEW
      Action String New.
      static String A_OK
      Action String OK.
      static String A_PATTRIBUTE
      Action String PAttribute.
      static String A_PRINT
      Action String Print.
      static String A_PROCESS
      Action String Process.
      static String A_REFRESH
      Action String Refresh.
      static String A_RESET
      Action String Reset.
      static String A_ZOOM
      Action String Zoom.

      • 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_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

    • Constructor Summary

      Constructors 
      Constructor Description
      ConfirmPanel()
      Create confirm panel with Ok button only
      ConfirmPanel​(boolean withCancel)
      Create confirm panel with Ok and Cancel button
      ConfirmPanel​(boolean withCancelButton, boolean withRefreshButton, boolean withResetButton, boolean withCustomizeButton, boolean withHistoryButton, boolean withZoomButton)
      create confirm panel with multiple options
      ConfirmPanel​(boolean withCancelButton, boolean withRefreshButton, boolean withResetButton, boolean withCustomizeButton, boolean withHistoryButton, boolean withZoomButton, boolean withText)
      create confirm panel with multiple options
      ConfirmPanel​(boolean withCancelButton, boolean withRefreshButton, boolean withResetButton, boolean withCustomizeButton, boolean withHistoryButton, boolean withZoomButton, boolean withText, boolean withImage)
      create confirm panel with multiple options

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addActionListener​(String event, org.zkoss.zk.ui.event.EventListener<?> listener)
      add action listener on the existing buttons
      void addActionListener​(org.zkoss.zk.ui.event.EventListener<?> listener)
      added to ease porting of swing form
      Button addButton​(String btName, String imgName)
      IDEMPIERE-1334 add a process button into center panel
      void addButton​(Button button)
      alias for addComponentsLeft for ease of porting swing form
      void addButtonSclass​(String cls)  
      void addComponentsCenter​(Button button)
      IDEMPIERE-1334 add button to the center side of the confirm panel
      void addComponentsCenter​(Checkbox cb)
      Add checkbox to center panel
      void addComponentsCenter​(Combobox cbb)
      Add combobox to center panel
      void addComponentsLeft​(Button button)
      add button to the left side of the confirm panel
      void addComponentsRight​(Button button)
      add button to the right side of the confirm panel
      Button addProcessButton​(String btName, String imgName)  
      Button createButton​(String name)
      Creates a button of the specified id
      Button createButton​(String name, String image, String tooltip)  
      Button getButton​(String id)
      return button of the specified id
      Button getOKButton()
      alias for getButton("Ok"), to ease porting of swing form
      boolean isVisible​(String btnName)
      returns whether the specified button is visible or not
      void removeButtonSclass​(String cls)  
      void setEnabled​(String id, boolean enabled)
      enable specific button
      void setEnabledAll​(boolean enabled)
      enable all components
      void setVisible​(String id, boolean visible)
      sets the visibility of the specified button
      void useSmallButtonClassForSmallScreen()  

      • Methods inherited from class org.zkoss.zul.Div

        getAlign, renderProperties, setAlign

      • Methods inherited from class org.zkoss.zul.impl.XulElement

        clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

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

        addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, service, setAction, setClass, 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, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, 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, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, invalidatePartial, isChildable, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, 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, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

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

        invalidatePartial

    • Constructor Detail

      • ConfirmPanel

        public ConfirmPanel​(boolean withCancelButton,
                    boolean withRefreshButton,
                    boolean withResetButton,
                    boolean withCustomizeButton,
                    boolean withHistoryButton,
                    boolean withZoomButton)
        create confirm panel with multiple options
        Parameters:
        withCancelButton - with cancel
        withRefreshButton - with refresh
        withResetButton - with reset
        withCustomizeButton - with customize
        withHistoryButton - with history
        withZoomButton - with zoom

      • ConfirmPanel

        public ConfirmPanel​(boolean withCancelButton,
                    boolean withRefreshButton,
                    boolean withResetButton,
                    boolean withCustomizeButton,
                    boolean withHistoryButton,
                    boolean withZoomButton,
                    boolean withText)
        create confirm panel with multiple options
        Parameters:
        withCancelButton - with cancel
        withRefreshButton - with refresh
        withResetButton - with reset
        withCustomizeButton - with customize
        withHistoryButton - with history
        withZoomButton - with zoom
        withText -

      • ConfirmPanel

        public ConfirmPanel​(boolean withCancelButton,
                    boolean withRefreshButton,
                    boolean withResetButton,
                    boolean withCustomizeButton,
                    boolean withHistoryButton,
                    boolean withZoomButton,
                    boolean withText,
                    boolean withImage)
        create confirm panel with multiple options
        Parameters:
        withCancelButton - with cancel
        withRefreshButton - with refresh
        withResetButton - with reset
        withCustomizeButton - with customize
        withHistoryButton - with history
        withZoomButton - with zoom
        withText -
        withImage - Incude image for button. Note that image always included if withText is false

      • ConfirmPanel

        public ConfirmPanel()
        Create confirm panel with Ok button only

      • ConfirmPanel

        public ConfirmPanel​(boolean withCancel)
        Create confirm panel with Ok and Cancel button
        Parameters:
        withCancel - with cancel

    • Method Detail

      • createButton

        public Button createButton​(String name)
        Creates a button of the specified id
        Parameters:
        name - button id
        Returns:
        button

        The string can be any of the following and the corresponding button will be created:

        Ok
        Ok button
        Cancel
        Cancel button
        Refresh
        Refresh button
        Reset
        Reset button
        History
        History button
        Process
        Process button
        New
        New button
        Customize
        Customize button
        Delete
        Delete button
        Save
        Save button
        Zoom
        Zoom button
        Help
        Help button

      • addButton

        public Button addButton​(String btName,
                        String imgName)
        IDEMPIERE-1334 add a process button into center panel
        Parameters:
        btName -
        imgName -
        Returns:

      • addComponentsLeft

        public void addComponentsLeft​(Button button)
        add button to the left side of the confirm panel
        Parameters:
        button - button

      • addComponentsRight

        public void addComponentsRight​(Button button)
        add button to the right side of the confirm panel
        Parameters:
        button - button

      • addComponentsCenter

        public void addComponentsCenter​(Button button)
        IDEMPIERE-1334 add button to the center side of the confirm panel
        Parameters:
        button - button

      • addComponentsCenter

        public void addComponentsCenter​(Combobox cbb)
        Add combobox to center panel
        Parameters:
        cbb -

      • addComponentsCenter

        public void addComponentsCenter​(Checkbox cb)
        Add checkbox to center panel
        Parameters:
        cb -

      • getButton

        public Button getButton​(String id)
        return button of the specified id
        Parameters:
        id - button id
        Returns:
        button or null if no button is found

        The button id can be any of the following

        Ok
        Ok button
        Cancel
        Cancel button
        Refresh
        Refresh button
        Reset
        Reset button
        History
        History button
        Process
        Process button
        New
        New button
        Customize
        Customize button
        Delete
        Delete button
        Save
        Save button
        Zoom
        Zoom button
        Help
        Help button

      • setVisible

        public void setVisible​(String id,
                       boolean visible)
        sets the visibility of the specified button
        Parameters:
        id - button name
        visible - visibility

        The button name can be any of the following

        Ok
        Ok button
        Cancel
        Cancel button
        Refresh
        Refresh button
        Reset
        Reset button
        History
        History button
        Process
        Process button
        New
        New button
        Customize
        Customize button
        Delete
        Delete button
        Save
        Save button
        Zoom
        Zoom button
        Help
        Help button

      • isVisible

        public boolean isVisible​(String btnName)
        returns whether the specified button is visible or not
        Parameters:
        btnName -
        Returns:
        visibility of the button

        The button name can be any of the following

        Ok
        Ok button
        Cancel
        Cancel button
        Refresh
        Refresh button
        Reset
        Reset button
        History
        History button
        Process
        Process button
        New
        New button
        Customize
        Customize button
        Delete
        Delete button
        Save
        Save button
        Zoom
        Zoom button
        Help
        Help button

      • setEnabled

        public void setEnabled​(String id,
                       boolean enabled)
        enable specific button
        Parameters:
        id - button id
        enabled - enabled

        The button id can be any of the following

        Ok
        Ok button
        Cancel
        Cancel button
        Refresh
        Refresh button
        Reset
        Reset button
        History
        History button
        Process
        Process button
        New
        New button
        Customize
        Customize button
        Delete
        Delete button
        Save
        Save button
        Zoom
        Zoom button
        Help
        Help button

      • setEnabledAll

        public void setEnabledAll​(boolean enabled)
        enable all components
        Parameters:
        enabled - enabled

      • addActionListener

        public void addActionListener​(String event,
                              org.zkoss.zk.ui.event.EventListener<?> listener)
        add action listener on the existing buttons
        Parameters:
        event - event
        listener - listener

      • addActionListener

        public void addActionListener​(org.zkoss.zk.ui.event.EventListener<?> listener)
        added to ease porting of swing form
        Parameters:
        listener -

      • addButton

        public void addButton​(Button button)
        alias for addComponentsLeft for ease of porting swing form
        Parameters:
        button -

      • getOKButton

        public Button getOKButton()
        alias for getButton("Ok"), to ease porting of swing form
        Returns:
        Button

      • addButtonSclass

        public void addButtonSclass​(String cls)

      • removeButtonSclass

        public void removeButtonSclass​(String cls)

      • useSmallButtonClassForSmallScreen

        public void useSmallButtonClassForSmallScreen()