Class CustomPaging

  • 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 CustomPaging
    extends org.zkoss.zul.Div
    Custom paging component that supports given molds:

    normal - standard paging component;
    simple - simple paging component - doesn't display total page number
    managed - manageable by end user

    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
      protected static java.lang.String MANAGED_MOLD  
      protected static java.lang.String NORMAL_MOLD  
      protected static java.lang.String ON_PAGING  
      static java.lang.String ON_PAGING_MODE_CHANGE  
      protected static java.lang.String SIMPLE_MOLD  
      • 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
      CustomPaging​(boolean simpleMode, java.lang.String mold)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean addEventListener​(java.lang.String eventName, org.zkoss.zk.ui.event.EventListener eventListener)  
      protected void applyCorrectMold()
      Applies mold that is passed to instance of CustomPaging
      int getActivePage()  
      protected int getActivePageNormalized()  
      int getPageSize()  
      int getTotalSize()  
      void init()
      Initialize paging component, should be called after component setup.
      boolean isSimpleMode()  
      void setActivePage​(int activePage)  
      void setAutohide​(boolean autohide)  
      void setDetailed​(boolean detailed)  
      void setNextButtonDisabled​(boolean disabled)  
      void setPageSize​(int pageSize)  
      void setPreviousButtonDisalbled​(boolean disabled)  
      void setSimpleMode​(boolean simpleMode)  
      void setTotalSize​(int totalSize)  
      void update()  
      • 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, 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, 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, isChildable, 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 class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • CustomPaging

        public CustomPaging​(boolean simpleMode,
                            java.lang.String mold)
    • Method Detail

      • setSimpleMode

        public void setSimpleMode​(boolean simpleMode)
      • setPreviousButtonDisalbled

        public void setPreviousButtonDisalbled​(boolean disabled)
      • setNextButtonDisabled

        public void setNextButtonDisabled​(boolean disabled)
      • getActivePageNormalized

        protected int getActivePageNormalized()
      • update

        public void update()
      • init

        public void init()
        Initialize paging component, should be called after component setup.

      • addEventListener

        public boolean addEventListener​(java.lang.String eventName,
                                        org.zkoss.zk.ui.event.EventListener eventListener)
        Specified by:
        addEventListener in interface org.zkoss.zk.ui.Component
        Overrides:
        addEventListener in class org.zkoss.zk.ui.AbstractComponent
      • applyCorrectMold

        protected void applyCorrectMold()
        Applies mold that is passed to instance of CustomPaging

        Note:
        Supported molds: normal, simple, managed Default mold is configured as a parameter default.pagingMold

      • isSimpleMode

        public boolean isSimpleMode()
      • getTotalSize

        public int getTotalSize()
      • getPageSize

        public int getPageSize()
      • getActivePage

        public int getActivePage()
      • setTotalSize

        public void setTotalSize​(int totalSize)
      • setPageSize

        public void setPageSize​(int pageSize)
      • setActivePage

        public void setActivePage​(int activePage)
      • setDetailed

        public void setDetailed​(boolean detailed)
      • setAutohide

        public void setAutohide​(boolean autohide)