|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Listitem
public class Listitem
A list item.
Default getZclass()
: z-listitem (since 5.0.0)
Nested Class Summary | |
---|---|
protected class |
Listitem.ExtraCtrl
A utility class to implement AbstractComponent.getExtraCtrl() . |
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
AbstractComponent.Children |
Field Summary |
---|
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
_height, _left, _top, _width, _zclass |
Fields inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
_visible |
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 |
---|
CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE |
Constructor Summary | |
---|---|
Listitem()
|
|
Listitem(java.lang.String label)
|
|
Listitem(java.lang.String label,
java.lang.Object value)
|
Method Summary | |
---|---|
protected void |
addMoved(Component oldparent,
Page oldpg,
Page newpg)
Called when this component is moved from the specified parent and/or page to the new page. |
void |
beforeChildAdded(Component child,
Component refChild)
Default: does nothing. |
void |
beforeParentChanged(Component parent)
Default: does nothing. |
java.lang.Object |
clone()
Clones the component. |
java.lang.String |
getImage()
Returns the image of the Listcell it contains. |
int |
getIndex()
Returns the index of this item (aka., the order in the listbox). |
java.lang.String |
getLabel()
Returns the label of the Listcell it contains, or null
if no such cell. |
Listbox |
getListbox()
Returns the list box that it belongs to. |
Listbox |
getListboxApi()
Returns the list box that it belongs to. |
Listgroup |
getListgroup()
Returns the listgroup that this item belongs to, or null. |
Listgroup |
getListgroupApi()
Returns the listgroup that this item belongs to, or null. |
int |
getMaxlength()
Returns the maximal length of each item's label. |
java.lang.String |
getMold()
Returns the mold used to render this component. |
java.lang.String |
getSrc()
Deprecated. As of release 3.5.0, it is redundant since it is the same getImage() . |
java.lang.Object |
getValue()
Returns the value. |
java.lang.String |
getZclass()
Returns the ZK Cascading Style class(es) for this component. |
boolean |
isCheckable()
Returns whether it is checkable. |
boolean |
isDisabled()
Returns whether it is disabled. |
boolean |
isLoaded()
Returns whether the content of this item is loaded. |
boolean |
isSelected()
Returns whether it is selected. |
protected java.lang.Object |
newExtraCtrl()
Used by AbstractComponent.getExtraCtrl() to create a client control. |
protected void |
renderProperties(ContentRenderer renderer)
Renders the content of this component, excluding the enclosing tags and children. |
void |
setCheckable(boolean checkable)
Sets whether it is checkable. |
void |
setDisabled(boolean disabled)
Sets whether it is disabled. |
void |
setImage(java.lang.String image)
Sets the image of the Listcell it contains. |
protected void |
setIndex(int index)
|
void |
setLabel(java.lang.String label)
Sets the label of the Listcell it contains. |
void |
setSelected(boolean selected)
Sets whether it is selected. |
void |
setSrc(java.lang.String src)
Deprecated. As of release 3.5.0, it is redundant since it is the same getSrc() . |
void |
setValue(java.lang.Object value)
Sets the value. |
boolean |
setVisible(boolean visible)
Sets whether this component is visible. |
protected void |
smartUpdate(java.lang.String name,
boolean value)
A special smart update to update a value in boolean. |
protected void |
smartUpdate(java.lang.String name,
int value)
A special smart update to update a value in int. |
protected void |
smartUpdate(java.lang.String name,
java.lang.Object value)
Smart-updates a property of the peer widget associated with the component, running at the client, with the specified value. |
Methods inherited from class org.zkoss.zul.impl.XulElement |
---|
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip |
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
focus, getDraggable, getDroppable, getHeight, getHflex, getLeft, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, service, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.zkoss.zul.impl.api.XulElement |
---|
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip |
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent |
---|
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from interface org.zkoss.zk.ui.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Constructor Detail |
---|
public Listitem()
public Listitem(java.lang.String label)
public Listitem(java.lang.String label, java.lang.Object value)
Method Detail |
---|
public Listbox getListbox()
It is the same as AbstractComponent.getParent()
.
public Listbox getListboxApi()
It is the same as AbstractComponent.getParent()
.
getListboxApi
in interface Listitem
public Listgroup getListgroup()
public Listgroup getListgroupApi()
getListgroupApi
in interface Listitem
public java.lang.String getZclass()
HtmlBasedComponent
Default: null (the default value depends on element).
HtmlBasedComponent.setZclass(java.lang.String)
) will completely replace the default style
of a component. In other words, the default style of a component
is associated with the default value of HtmlBasedComponent.getZclass()
.
Once it is changed, the default style won't be applied at all.
If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String)
instead.
getZclass
in interface HtmlBasedComponent
getZclass
in class HtmlBasedComponent
HtmlBasedComponent.getSclass()
public boolean isCheckable()
Default: true.
isCheckable
in interface Listitem
public void setCheckable(boolean checkable)
Default: true.
setCheckable
in interface Listitem
public int getMaxlength()
getMaxlength
in interface Listitem
public java.lang.Object getValue()
Default: null.
Note: the value is application dependent, you can place whatever value you want.
If you are using listitem with HTML Form (and with the name attribute), it is better to specify a String-typed value.
getValue
in interface Listitem
public void setValue(java.lang.Object value)
setValue
in interface Listitem
value
- the value.
Note: the value is application dependent, you can place whatever value you want.
If you are using listitem with HTML Form (and with the name attribute), it is better to specify a String-typed value.
public boolean isDisabled()
Default: false.
public void setDisabled(boolean disabled)
setDisabled
in interface Listitem
public boolean isSelected()
Default: false.
isSelected
in interface Listitem
public void setSelected(boolean selected)
setSelected
in interface Listitem
public java.lang.String getLabel()
Listcell
it contains, or null
if no such cell.
getLabel
in interface Listitem
public void setLabel(java.lang.String label)
Listcell
it contains.
If it is not created, we automatically create it.
setLabel
in interface Listitem
public java.lang.String getSrc()
getImage()
.
public void setSrc(java.lang.String src)
getSrc()
.
public java.lang.String getImage()
Listcell
it contains.
getImage
in interface Listitem
public void setImage(java.lang.String image)
Listcell
it contains.
If it is not created, we automatically create it.
setImage
in interface Listitem
public int getIndex()
public boolean isLoaded()
getListbox()
is live data,
i.e., Listbox.getModel()
is not null.
isLoaded
in interface Listitem
protected void setIndex(int index)
public boolean setVisible(boolean visible)
Component
setVisible
in interface Component
setVisible
in class AbstractComponent
protected void smartUpdate(java.lang.String name, java.lang.Object value)
AbstractComponent
The second invocation with the same property will replace the previous call. In other words, the same property will be set only once in each execution.
This method has no effect if AbstractComponent.invalidate()
is ever invoked
(in the same execution), since AbstractComponent.invalidate()
assumes
the whole content shall be redrawn and all smart updates to
this components can be ignored,
Once AbstractComponent.invalidate()
is called, all invocations to AbstractComponent.smartUpdate(java.lang.String, java.lang.Object)
will then be ignored, and AbstractComponent.redraw(java.io.Writer)
will be invoked later.
It can be called only in the request-processing and event-processing phases; excluding the redrawing phase.
There are two ways to draw a component, one is to invoke
Component.invalidate()
, and the other is AbstractComponent.smartUpdate(java.lang.String, java.lang.Object)
.
While Component.invalidate()
causes the whole content to redraw,
AbstractComponent.smartUpdate(java.lang.String, java.lang.Object)
let component developer control which part
to redraw.
smartUpdate
in class AbstractComponent
value
- the new value.
If it is DeferredValue
, the value
will be retrieved (by calling DeferredValue.getValue()
)
in the rendering phase. It is useful if the value can not be determined now.
For some old application servers (example, Webshpere 5.1),
Execution.encodeURL(java.lang.String)
cannot be called in the event processing
thread. So, the developers have to use DeferredValue
or disable the use of the event processing thread
(by use of disable-event-thread
in zk.xml).
In addition, the value can be any kind of objects that the client accepts (marshaled by JSON).
AbstractComponent.updateByClient(java.lang.String, java.lang.Object)
protected void smartUpdate(java.lang.String name, boolean value)
AbstractComponent
It will invoke AbstractComponent.smartUpdate(String,Object)
to update
the attribute eventually.
smartUpdate
in class AbstractComponent
protected void smartUpdate(java.lang.String name, int value)
AbstractComponent
It will invoke AbstractComponent.smartUpdate(String,Object)
to update
the attribute eventually.
smartUpdate
in class AbstractComponent
public java.lang.String getMold()
Component
Default: "default"
Since 5.0, the default can be overriden by specify a library property. For example, if the component's class name is org.zkoss.zul.Button, then you can override the default mold by specifying the property called "org.zkoss.zul.Button.mold" with the mold you want in zk.xml. For example,
<library-property>
<name>org.zkoss.zul.Button.mold</name>
<value>trendy</value>
</library-property>
Notice that it doesn't affect the deriving classes. If you want to change the deriving class's default mold, you have to specify them explicity, too.
getMold
in interface Component
getMold
in class AbstractComponent
ComponentDefinition
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponent
See also Render Special Properties
renderProperties
in class XulElement
java.io.IOException
protected void addMoved(Component oldparent, Page oldpg, Page newpg)
AbstractComponent
Default: it notifies UiEngine
to update the component
at the client (usually remove-and-add).
It is designed to let derived classes overriding this method to disable this update. However, you rarely need to override it. One possible but rare case: the component's visual part at the client updates the visual representation at the client and then notify the component at the server to update its children accordingly. In this case, it is redudant if we ask UI Engine to send the updates to client.
addMoved
in class AbstractComponent
oldparent
- the parent before moved.
The new parent can be found by calling AbstractComponent.getParent()
.oldpg
- the parent before moved.newpg
- the new page. AbstractComponent.getPage()
might return
the old page.public void beforeParentChanged(Component parent)
AbstractComponent
beforeParentChanged
in interface ComponentCtrl
beforeParentChanged
in class AbstractComponent
parent
- the new parent. If null, it means detachment.ComponentCtrl.beforeParentChanged(org.zkoss.zk.ui.Component)
public void beforeChildAdded(Component child, Component refChild)
AbstractComponent
beforeChildAdded
in interface ComponentCtrl
beforeChildAdded
in class AbstractComponent
child
- the child to be added (never null).refChild
- another child component that the new child
will be inserted before it. If null, the new child will be the
last child.ComponentCtrl.beforeChildAdded(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component)
public java.lang.Object clone()
Component
clone
in interface Component
clone
in class AbstractComponent
protected java.lang.Object newExtraCtrl()
HtmlBasedComponent
AbstractComponent.getExtraCtrl()
to create a client control.
It is used only by component developers.
Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl
.
newExtraCtrl
in class HtmlBasedComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |