public class GridDataLoader extends java.lang.Object implements DataLoader, Cropper
Grid
data loader.Constructor and Description |
---|
GridDataLoader() |
Modifier and Type | Method and 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.
|
java.util.Set<? extends Component> |
getAvailableAtClient()
Returns a set of child components that are available at the client,
or null if ALL available.
|
protected java.util.Set<? extends Component> |
getAvailableAtClient(int offset,
int limit) |
Component |
getCropOwner()
Returns the owner of the cropping scope.
|
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.
|
Component |
getOwner()
Returns the associated owner component of this DataLoader.
|
java.lang.Object |
getRealRenderer()
Return the renderer to do rendering.
|
int |
getTotalSize()
Returns the total size of the data.
|
void |
init(Component owner,
int offset,
int limit)
Callback from the owner component and give a chance to initialize things.
|
protected boolean |
inPagingMold() |
boolean |
isCropper()
Returns whether it is a cropper, i.e., cropping is applied.
|
protected Component |
newUnloadedItem(java.lang.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.
|
public void init(Component owner, int offset, int limit)
DataLoader
init
in interface DataLoader
owner
- the owner component of this DataLoader.public void reset()
DataLoader
reset
in interface DataLoader
public final Component getOwner()
DataLoader
getOwner
in interface DataLoader
public int getOffset()
DataLoader
getOffset
in interface DataLoader
public int getLimit()
DataLoader
getLimit
in interface DataLoader
public int getTotalSize()
DataLoader
getTotalSize
in interface DataLoader
public void doGroupsDataChange(GroupsDataEvent event)
DataLoader
doGroupsDataChange
in interface DataLoader
event
- the corresponding GroupsDataEventpublic void doListDataChange(ListDataEvent event)
DataLoader
doListDataChange
in interface DataLoader
protected Component newUnloadedItem(java.lang.Object renderer, int index)
public java.lang.Object getRealRenderer()
DataLoader
getRealRenderer
in interface DataLoader
public void syncModel(int offset, int limit)
DataLoader
syncModel
in interface DataLoader
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.protected boolean inPagingMold()
public void updateModelInfo()
DataLoader
updateModelInfo
in interface DataLoader
public void setLoadAll(boolean b)
DataLoader
setLoadAll
in interface DataLoader
public boolean isCropper()
Cropper
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
.
public java.util.Set<? extends Component> getAvailableAtClient()
Cropper
Component.getChildren()
.
In order words, you must use LinkedHashSet or similar to ensure the order
in the returned set.
Note: for better performance, it is better to return null if all children are available at the client.
Note: the components in the returned set can have different
parents. It is useful if you want to implement multi-level cropping,
such as tree. Refer to Cropper.getCropOwner()
.
getAvailableAtClient
in interface Cropper
protected java.util.Set<? extends Component> getAvailableAtClient(int offset, int limit)
public Component getCropOwner()
Cropper
Cropper.getAvailableAtClient()
returns only the
available direct children of this component,
and this method returns this component.
It is so-called a single-level cropping, such as listbox and tree.
If you want to implement multi-level cropping, such as tree,
you can consider the whole tree as a cropping scope.
And, Cropper.getAvailableAtClient()
returns all available items,
not just the child of this component. In additions,
this method returns the tree.
getCropOwner
in interface Cropper
Copyright © 2005-2018 Potix Corporation. All Rights Reserved.