Package org.zkoss.zul.impl

Class GridDataLoader

java.lang.Object
org.zkoss.zul.impl.GridDataLoader
All Implemented Interfaces:
org.zkoss.zk.ui.ext.render.Cropper, DataLoader
public class GridDataLoader extends Object implements DataLoader, org.zkoss.zk.ui.ext.render.Cropper
Generic Grid data loader.
Since:
5.0.0
Author:
henrichen

  • Constructor Summary

    Constructors
    Constructor
    Description
    GridDataLoader()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doGroupsDataChange(GroupsDataEvent event)
    Handle event when GroupsDataEvent is fired from owner component.
    void
    doListDataChange(ListDataEvent event)
    Handle event when ListDataEvent is fired from owner component.
    Set<? extends org.zkoss.zk.ui.Component>
    getAvailableAtClient()
     
    protected Set<? extends org.zkoss.zk.ui.Component>
    getAvailableAtClient(int offset, int limit)
     
    org.zkoss.zk.ui.Component
    getCropOwner()
     
    int
    getLimit()
    Returns the required visible limit size of the current loaded data chunk to be shown on the screen.
    int
    getOffset()
    Returns the requested visible offset of the current loaded data chunk.
    final org.zkoss.zk.ui.Component
    getOwner()
    Returns the associated owner component of this DataLoader.
    Object
    getRealRenderer()
    Return the renderer to do rendering.
    int
    getTotalSize()
    Returns the total size of the data.
    void
    init(org.zkoss.zk.ui.Component owner, int offset, int limit)
    Callback from the owner component and give a chance to initialize things.
    protected boolean
    inPagingMold()
     
    boolean
    isCropper()
     
    protected org.zkoss.zk.ui.Component
    newUnloadedItem(Object renderer, int index)
    Creates a new and unloaded row.
    void
    reset()
    Callback from the owner component and give a chance to reset things.
    void
    setLoadAll(boolean b)
    Sets whether to always load all items from ListModel.
    void
    syncModel(int offset, int limit)
    Synchronizes the owner component to be consistent with the specified model.
    void
    updateModelInfo()
    Used to update some extra control information to the client.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • GridDataLoader

      public GridDataLoader()

  • Method Details

    • init

      public void init(org.zkoss.zk.ui.Component owner, int offset, int limit)
      Description copied from interface: DataLoader
      Callback from the owner component and give a chance to initialize things.
      Specified by:
      init in interface DataLoader
      Parameters:
      owner - the owner component of this DataLoader.

    • reset

      public void reset()
      Description copied from interface: DataLoader
      Callback from the owner component and give a chance to reset things.
      Specified by:
      reset in interface DataLoader

    • getOwner

      public final org.zkoss.zk.ui.Component getOwner()
      Description copied from interface: DataLoader
      Returns the associated owner component of this DataLoader.
      Specified by:
      getOwner in interface DataLoader

    • getOffset

      public int getOffset()
      Description copied from interface: DataLoader
      Returns the requested visible offset of the current loaded data chunk.
      Specified by:
      getOffset in interface DataLoader
      Returns:
      the requested visible offset of the current loaded data chunk.

    • getLimit

      public int getLimit()
      Description copied from interface: DataLoader
      Returns the required visible limit size of the current loaded data chunk to be shown on the screen.
      Specified by:
      getLimit in interface DataLoader
      Returns:
      the required visible limit size of the current loaded data chunk to be shown on the screen.

    • getTotalSize

      public int getTotalSize()
      Description copied from interface: DataLoader
      Returns the total size of the data.
      Specified by:
      getTotalSize in interface DataLoader
      Returns:
      the total size of the data.

    • doGroupsDataChange

      public void doGroupsDataChange(GroupsDataEvent event)
      Description copied from interface: DataLoader
      Handle event when GroupsDataEvent is fired from owner component.
      Specified by:
      doGroupsDataChange in interface DataLoader
      Parameters:
      event - the corresponding GroupsDataEvent

    • doListDataChange

      public void doListDataChange(ListDataEvent event)
      Description copied from interface: DataLoader
      Handle event when ListDataEvent is fired from owner component.
      Specified by:
      doListDataChange in interface DataLoader

    • newUnloadedItem

      protected org.zkoss.zk.ui.Component newUnloadedItem(Object renderer, int index)
      Creates a new and unloaded row.

    • getRealRenderer

      public Object getRealRenderer()
      Description copied from interface: DataLoader
      Return the renderer to do rendering.
      Specified by:
      getRealRenderer in interface DataLoader

    • syncModel

      public void syncModel(int offset, int limit)
      Description copied from interface: DataLoader
      Synchronizes the owner component to be consistent with the specified model.
      Specified by:
      syncModel in interface DataLoader
      Parameters:
      offset - the starting index of the range to do data synchronize.
      limit - the size of the range to do data synchronize. -1 means the current range.

    • inPagingMold

      protected boolean inPagingMold()

    • updateModelInfo

      public void updateModelInfo()
      Description copied from interface: DataLoader
      Used to update some extra control information to the client.
      Specified by:
      updateModelInfo in interface DataLoader

    • setLoadAll

      public void setLoadAll(boolean b)
      Description copied from interface: DataLoader
      Sets whether to always load all items from ListModel.
      Specified by:
      setLoadAll in interface DataLoader

    • isCropper

      public boolean isCropper()
      Specified by:
      isCropper in interface org.zkoss.zk.ui.ext.render.Cropper

    • getAvailableAtClient

      public Set<? extends org.zkoss.zk.ui.Component> getAvailableAtClient()
      Specified by:
      getAvailableAtClient in interface org.zkoss.zk.ui.ext.render.Cropper

    • getAvailableAtClient

      protected Set<? extends org.zkoss.zk.ui.Component> getAvailableAtClient(int offset, int limit)

    • getCropOwner

      public org.zkoss.zk.ui.Component getCropOwner()
      Specified by:
      getCropOwner in interface org.zkoss.zk.ui.ext.render.Cropper