org.zkoss.zul
Class Listitem

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zk.ui.HtmlBasedComponent
          extended by org.zkoss.zul.impl.XulElement
              extended by org.zkoss.zul.Listitem
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, HtmlBasedComponent, Component, Scope, ComponentCtrl, Listitem, XulElement
Direct Known Subclasses:
Listgroup, Listgroupfoot

public class Listitem
extends XulElement
implements Listitem

A list item.

Default getZclass(): z-listitem (since 5.0.0)

Author:
tomyeh
See Also:
Serialized Form

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 org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setVariable, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
 
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.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Constructor Detail

Listitem

public Listitem()

Listitem

public Listitem(java.lang.String label)

Listitem

public Listitem(java.lang.String label,
                java.lang.Object value)
Method Detail

getListbox

public Listbox getListbox()
Returns the list box that it belongs to.

It is the same as AbstractComponent.getParent().


getListboxApi

public Listbox getListboxApi()
Returns the list box that it belongs to.

It is the same as AbstractComponent.getParent().

Specified by:
getListboxApi in interface Listitem
Since:
3.5.2

getListgroup

public Listgroup getListgroup()
Returns the listgroup that this item belongs to, or null.

Since:
3.5.0

getListgroupApi

public Listgroup getListgroupApi()
Returns the listgroup that this item belongs to, or null.

Specified by:
getListgroupApi in interface Listitem
Since:
3.5.2

getZclass

public java.lang.String getZclass()
Description copied from class: HtmlBasedComponent
Returns the ZK Cascading Style class(es) for this component. It usually depends on the implementation of the mold (@{link #getMold}).

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.

Specified by:
getZclass in interface HtmlBasedComponent
Overrides:
getZclass in class HtmlBasedComponent
See Also:
HtmlBasedComponent.getSclass()

isCheckable

public boolean isCheckable()
Returns whether it is checkable.

Default: true.

Specified by:
isCheckable in interface Listitem
Since:
3.0.4

setCheckable

public void setCheckable(boolean checkable)
Sets whether it is checkable.

Default: true.

Specified by:
setCheckable in interface Listitem
Since:
3.0.4

getMaxlength

public int getMaxlength()
Returns the maximal length of each item's label. It is a shortcut of getParent().getMaxlength(); Thus, it works only if the listbox's mold is "select".

Specified by:
getMaxlength in interface Listitem

getValue

public java.lang.Object getValue()
Returns the value.

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.

Specified by:
getValue in interface Listitem

setValue

public void setValue(java.lang.Object value)
Sets the value.

Specified by:
setValue in interface Listitem
Parameters:
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.


isDisabled

public boolean isDisabled()
Returns whether it is disabled.

Default: false.


setDisabled

public void setDisabled(boolean disabled)
Sets whether it is disabled.

Specified by:
setDisabled in interface Listitem

isSelected

public boolean isSelected()
Returns whether it is selected.

Default: false.

Specified by:
isSelected in interface Listitem

setSelected

public void setSelected(boolean selected)
Sets whether it is selected.

Specified by:
setSelected in interface Listitem

getLabel

public java.lang.String getLabel()
Returns the label of the Listcell it contains, or null if no such cell.

Specified by:
getLabel in interface Listitem

setLabel

public void setLabel(java.lang.String label)
Sets the label of the Listcell it contains.

If it is not created, we automatically create it.

Specified by:
setLabel in interface Listitem

getSrc

public java.lang.String getSrc()
Deprecated. As of release 3.5.0, it is redundant since it is the same getImage().


setSrc

public void setSrc(java.lang.String src)
Deprecated. As of release 3.5.0, it is redundant since it is the same getSrc().


getImage

public java.lang.String getImage()
Returns the image of the Listcell it contains.

Specified by:
getImage in interface Listitem

setImage

public void setImage(java.lang.String image)
Sets the image of the Listcell it contains.

If it is not created, we automatically create it.

Specified by:
setImage in interface Listitem

getIndex

public int getIndex()
Returns the index of this item (aka., the order in the listbox).


isLoaded

public boolean isLoaded()
Returns whether the content of this item is loaded. It is meaningful only if getListbox() is live data, i.e., Listbox.getModel() is not null.

Specified by:
isLoaded in interface Listitem
Since:
2.4.0

setIndex

protected void setIndex(int index)

setVisible

public boolean setVisible(boolean visible)
Description copied from interface: Component
Sets whether this component is visible.

Specified by:
setVisible in interface Component
Overrides:
setVisible in class AbstractComponent
Returns:
the previous visibility

smartUpdate

protected void smartUpdate(java.lang.String name,
                           java.lang.Object value)
Description copied from class: AbstractComponent
Smart-updates a property of the peer widget associated with the component, running at the client, with the specified value.

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.

Overrides:
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).

See Also:
AbstractComponent.updateByClient(java.lang.String, java.lang.Object)

smartUpdate

protected void smartUpdate(java.lang.String name,
                           boolean value)
Description copied from class: AbstractComponent
A special smart update to update a value in boolean.

It will invoke AbstractComponent.smartUpdate(String,Object) to update the attribute eventually.

Overrides:
smartUpdate in class AbstractComponent

smartUpdate

protected void smartUpdate(java.lang.String name,
                           int value)
Description copied from class: AbstractComponent
A special smart update to update a value in int.

It will invoke AbstractComponent.smartUpdate(String,Object) to update the attribute eventually.

Overrides:
smartUpdate in class AbstractComponent

getMold

public java.lang.String getMold()
Description copied from interface: Component
Returns the mold used to render this 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.

Specified by:
getMold in interface Component
Overrides:
getMold in class AbstractComponent
See Also:
ComponentDefinition

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException
Description copied from class: HtmlBasedComponent
Renders the content of this component, excluding the enclosing tags and children.

See also Render Special Properties

Overrides:
renderProperties in class XulElement
Throws:
java.io.IOException

addMoved

protected void addMoved(Component oldparent,
                        Page oldpg,
                        Page newpg)
Description copied from class: AbstractComponent
Called when this component is moved from the specified parent and/or page to the new page.

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.

Overrides:
addMoved in class AbstractComponent
Parameters:
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.

beforeParentChanged

public void beforeParentChanged(Component parent)
Description copied from class: AbstractComponent
Default: does nothing.

Specified by:
beforeParentChanged in interface ComponentCtrl
Overrides:
beforeParentChanged in class AbstractComponent
Parameters:
parent - the new parent. If null, it means detachment.
See Also:
ComponentCtrl.beforeParentChanged(org.zkoss.zk.ui.Component)

beforeChildAdded

public void beforeChildAdded(Component child,
                             Component refChild)
Description copied from class: AbstractComponent
Default: does nothing.

Specified by:
beforeChildAdded in interface ComponentCtrl
Overrides:
beforeChildAdded in class AbstractComponent
Parameters:
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.
See Also:
ComponentCtrl.beforeChildAdded(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component)

clone

public java.lang.Object clone()
Description copied from interface: Component
Clones the component. All of its children is cloned. Notice that the cloned component doesn't belong to any page, nor desktop. It doesn't have parent, either.

Specified by:
clone in interface Component
Overrides:
clone in class AbstractComponent

newExtraCtrl

protected java.lang.Object newExtraCtrl()
Description copied from class: HtmlBasedComponent
Used by AbstractComponent.getExtraCtrl() to create a client control. It is used only by component developers.

Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl.

Overrides:
newExtraCtrl in class HtmlBasedComponent


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo