Package org.adempiere.webui.component

Class ConfirmPanel

java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Div
org.adempiere.webui.component.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
Common command buttons panel for window, form and dialog
Author:
Sendy Yagambrum
See Also:

  • 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
    Modifier and Type
    Field
    Description
    static final String
    A_CANCEL
    Action String Cancel.
    static final String
    A_CUSTOMIZE
    Action String Customize.
    static final String
    A_DELETE
    Action String Delete.
    static final String
    A_EXPORT
    Action String Export.
    static final String
    A_HELP
    Action String Help.
    static final String
    A_HISTORY
    Action String History.
    static final String
    A_NEW
    Action String New.
    static final String
    A_OK
    Action String OK.
    static final String
    A_PATTRIBUTE
    Action String PAttribute.
    static final String
    A_PRINT
    Action String Print.
    static final String
    A_PROCESS
    Action String Process.
    static final String
    A_REFRESH
    Action String Refresh.
    static final String
    A_RESET
    Action String Reset.
    static final 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, AFTER_PARENT_CHANGED, 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 only
    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

    Modifier and Type
    Method
    Description
    void
    addActionListener(String event, org.zkoss.zk.ui.event.EventListener<?> listener)
    Add event listener on existing buttons
    void
    addActionListener(org.zkoss.zk.ui.event.EventListener<?> listener)
    Add ON_CLICK listener for all buttons
    Button
    addButton(String btName, String imgName)
    Add button to center area of panel
    void
    addButton(Button button)
    Alias for addComponentsLeft, to ease of porting swing form
    void
    addButtonSclass(String cls)
    Add cls to sclass property of all buttons.
    Keep as extraButtonSClass for new button created.
    void
    addComponentsBeforeRight(Button button)
    Add button to the front of right area of the confirm panel
    void
    addComponentsCenter(Button button)
    Add button to the center area of the confirm panel
    void
    addComponentsCenter(Checkbox cb)
    Add checkbox to center area of panel
    void
    addComponentsCenter(Combobox cbb)
    Add combobox to center area of 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)
    Add process button to center area of panel
    Button
    createButton(String name)
    Creates a button of the specified id
    Button
    createButton(String name, String image, String tooltip)
    Creates a button of the specified id
    Button
    getButton(String id)
    Get button of the specified id
    Map<String,Button>
    getMap()
     
    Button
    getOKButton()
    Alias for getButton("Ok"), to ease porting of swing form
    boolean
    isVisible(String btnName)
    Is the specified button visible
    void
    removeButtonSclass(String cls)
    Remove cls from sclass property of all buttons
    void
    setEnabled(String id, boolean enabled)
    Enable/disable specific button
    void
    setEnabledAll(boolean enabled)
    Enable/disable all buttons
    void
    setVisible(String id, boolean visible)
    Sets the visibility of the specified button
    void
    useSmallButtonClassForSmallScreen()
    Enable the use of SMALL_SCREEN_BUTTON_CLASS for all buttons.

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

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

    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, getZclass, 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, 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, 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

  • Field Details

  • Constructor Details

    • 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 - Include 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 only
      Parameters:
      withCancel - true to include cancel button, false otherwise

  • Method Details

    • 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

    • createButton

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

    • addButton

      public Button addButton(String btName, String imgName)
      Add button to center area of panel
      Parameters:
      btName -
      imgName -
      Returns:
      added button

    • addProcessButton

      public Button addProcessButton(String btName, String imgName)
      Add process button to center area of panel
      Parameters:
      btName -
      imgName -
      Returns:
      Button

    • 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

    • addComponentsBeforeRight

      public void addComponentsBeforeRight(Button button)
      Add button to the front of right area of the confirm panel
      Parameters:
      button - button

    • addComponentsCenter

      public void addComponentsCenter(Button button)
      Add button to the center area of the confirm panel
      Parameters:
      button - button

    • addComponentsCenter

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

    • addComponentsCenter

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

    • getButton

      public Button getButton(String id)
      Get 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)
      Is the specified button visible
      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/disable 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/disable all buttons
      Parameters:
      enabled - true to enable, false otherwise

    • addActionListener

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

    • addActionListener

      public void addActionListener(org.zkoss.zk.ui.event.EventListener<?> listener)
      Add ON_CLICK listener for all buttons
      Parameters:
      listener - EventListener

    • addButton

      public void addButton(Button button)
      Alias for addComponentsLeft, to 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)
      Add cls to sclass property of all buttons.
      Keep as extraButtonSClass for new button created.
      Parameters:
      cls -

    • removeButtonSclass

      public void removeButtonSclass(String cls)
      Remove cls from sclass property of all buttons
      Parameters:
      cls -

    • useSmallButtonClassForSmallScreen

      public void useSmallButtonClassForSmallScreen()
      Enable the use of SMALL_SCREEN_BUTTON_CLASS for all buttons.

    • getMap

      public Map<String,Button> getMap()
      Returns:
      map containing all buttons attached to ConfirmPanel