Package org.zkoss.zkmax.zul.impl
Class LiveListboxDataLoader
- java.lang.Object
-
- org.zkoss.zul.impl.ListboxDataLoader
-
- org.zkoss.zkmax.zul.impl.LiveListboxDataLoader
-
- All Implemented Interfaces:
Cropper
,DataLoader
public class LiveListboxDataLoader extends ListboxDataLoader
Data Loader that handle the live data loading into Listbox.Available in ZK EE
- Since:
- 6.0.1
- Author:
- henrichen
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.zkoss.zul.impl.ListboxDataLoader
ListboxDataLoader.DeferredRedraw
-
-
Constructor Summary
Constructors Constructor Description LiveListboxDataLoader()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
doListDataChange(ListDataEvent event)
Handle event when ListDataEvent is fired from owner component.protected java.util.Set<? extends Component>
getAvailableAtClient(boolean itemOnly)
Retrieves the children available at client with more control.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.void
init(Component owner, int offset, int limit)
Callback from the owner component and give a chance to initialize things.boolean
isCropper()
Returns whether it is a cropper, i.e., cropping is applied.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 org.zkoss.zul.impl.ListboxDataLoader
doGroupsDataChange, getAvailableAtClient, getAvailableAtClient, getCropOwner, getOwner, getRealRenderer, getTotalSize, inPagingMold, inSelectMold, newUnloadedItem
-
-
-
-
Method Detail
-
init
public void init(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 interfaceDataLoader
- Overrides:
init
in classListboxDataLoader
- 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 interfaceDataLoader
- Overrides:
reset
in classListboxDataLoader
-
getOffset
public int getOffset()
Description copied from interface:DataLoader
Returns the requested visible offset of the current loaded data chunk.- Specified by:
getOffset
in interfaceDataLoader
- Overrides:
getOffset
in classListboxDataLoader
- 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 interfaceDataLoader
- Overrides:
getLimit
in classListboxDataLoader
- Returns:
- the required visible limit size of the current loaded data chunk to be shown on the screen.
-
doListDataChange
public void doListDataChange(ListDataEvent event)
Description copied from interface:DataLoader
Handle event when ListDataEvent is fired from owner component.- Specified by:
doListDataChange
in interfaceDataLoader
- Overrides:
doListDataChange
in classListboxDataLoader
-
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 interfaceDataLoader
- Overrides:
syncModel
in classListboxDataLoader
- 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.
-
updateModelInfo
public void updateModelInfo()
Description copied from interface:DataLoader
Used to update some extra control information to the client.- Specified by:
updateModelInfo
in interfaceDataLoader
- Overrides:
updateModelInfo
in classListboxDataLoader
-
setLoadAll
public void setLoadAll(boolean b)
Description copied from interface:DataLoader
Sets whether to always load all items from ListModel.- Specified by:
setLoadAll
in interfaceDataLoader
- Overrides:
setLoadAll
in classListboxDataLoader
-
isCropper
public boolean isCropper()
Description copied from interface:Cropper
Returns whether it is a cropper, i.e., cropping is applied.Note: this method is called when an child is detached, so you have to count one more for the total number of children. Example <= must be used, not <:
getChildCount() <= getPageSize()
The result of returning false is the same as not declaring with
Cropper
.- Specified by:
isCropper
in interfaceCropper
- Overrides:
isCropper
in classListboxDataLoader
-
getAvailableAtClient
protected java.util.Set<? extends Component> getAvailableAtClient(boolean itemOnly)
Description copied from class:ListboxDataLoader
Retrieves the children available at client with more control.Derived class shall override this method rather than
ListboxDataLoader.getAvailableAtClient()
.- Overrides:
getAvailableAtClient
in classListboxDataLoader
- Parameters:
itemOnly
- whether to return onlyListitem
and derives.
-
-