|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl
org.zkoss.zul.Listbox.ExtraCtrl
protected class Listbox.ExtraCtrl
A utility class to implement AbstractComponent.getExtraCtrl()
. It is used only by
component developers.
Constructor Summary | |
---|---|
protected |
Listbox.ExtraCtrl()
|
Method Summary | |
---|---|
java.util.Set |
getAvailableAtClient()
Returns a set of child components that are available at the client, or null if ALL available. |
Component |
getCropOwner()
Returns the owner of the cropping scope. |
int |
getHeight()
Returns the padding height in px. |
boolean |
isCropper()
Returns whether it is a cropper, i.e., cropping is applied. |
void |
setHeight(int height)
Set the padding height in px. |
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl |
---|
setPrologContent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected Listbox.ExtraCtrl()
Method Detail |
---|
public int getHeight()
Padding
getHeight
in interface Padding
public void setHeight(int height)
Padding
setHeight
in interface Padding
height
- the padding height in px.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
.
isCropper
in interface Cropper
public Component getCropOwner()
Cropper
Cropper.getAvailableAtClient()
returns only the
available direct children of this compnent,
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
public java.util.Set 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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |