org.zkoss.zul
Class Label

java.lang.Object
  org.zkoss.zk.ui.AbstractComponent
      org.zkoss.zk.ui.HtmlBasedComponent
          org.zkoss.zul.impl.XulElement
              org.zkoss.zul.Label

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Label
extends XulElement

A label.

Default getZclass(): z-label.

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

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

Label()

Label(java.lang.String value)

Method Summary

java.lang.Object	clone()
int	getMaxlength() Returns the maximal length of the label.
java.lang.String	getValue() Returns the value.
java.lang.String	getZclass()
protected boolean	isChildable() No child is allowed.
boolean	isHyphen() Deprecated. As of release 5.0.0, use CSS instead.
boolean	isMultiline() Returns whether to preserve the new line and the white spaces at the begining of each line.
boolean	isPre() Returns whether to preserve the white spaces, such as space, tab and new line.
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	setHyphen(boolean hyphen) Deprecated. As of release 5.0.0, use CSS instead. Use the CSS style called "word-wrap: word-break" to have similar effect. Unfortunately, word-wrap is not applicable to FF and Opera(it works fine with IE and Safari).
void	setMaxlength(int maxlength) Sets the maximal length of the label.
void	setMultiline(boolean multiline) Sets whether to preserve the new line and the white spaces at the begining of each line.
void	setPre(boolean pre) Sets whether to preserve the white spaces, such as space, tab and new line.
void	setValue(java.lang.String value) Sets the value.

Methods inherited from class org.zkoss.zul.impl.XulElement

getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Label

public Label()

Label

public Label(java.lang.String value)

Method Detail

getValue

public java.lang.String getValue()

Returns the value.

Default: "".

Deriving class can override it to return whatever it wants other than null.

setValue

public void setValue(java.lang.String value)

Sets the value.

getMaxlength

public int getMaxlength()

Returns the maximal length of the label.

Default: 0 (means no limitation)

setMaxlength

public void setMaxlength(int maxlength)

Sets the maximal length of the label.

isMultiline

public boolean isMultiline()

Returns whether to preserve the new line and the white spaces at the begining of each line.

setMultiline

public void setMultiline(boolean multiline)

Sets whether to preserve the new line and the white spaces at the begining of each line.

isPre

public boolean isPre()

Returns whether to preserve the white spaces, such as space, tab and new line.

It is the same as style="white-space:pre". However, IE has a bug when handling such style if the content is updated dynamically. Refer to Bug 1455584.

Note: the new line is preserved either isPre() or isMultiline() returns true. In other words, pre implies multiline

setPre

public void setPre(boolean pre)

Sets whether to preserve the white spaces, such as space, tab and new line.

isHyphen

public boolean isHyphen()

Deprecated. As of release 5.0.0, use CSS instead.

setHyphen

public void setHyphen(boolean hyphen)

Deprecated. As of release 5.0.0, use CSS instead.

Use the CSS style called "word-wrap: word-break" to have similar effect. Unfortunately, word-wrap is not applicable to FF and Opera(it works fine with IE and Safari).

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws java.io.IOException

Overrides:

renderProperties in class XulElement

Throws:

java.io.IOException

getZclass

public java.lang.String getZclass()

Overrides:

getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

clone

public java.lang.Object clone()

Specified by:

clone in interface org.zkoss.zk.ui.Component

Overrides:

clone in class XulElement

isChildable

protected boolean isChildable()

No child is allowed.

Overrides:

isChildable in class org.zkoss.zk.ui.AbstractComponent