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, Component, Scope, 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

HtmlBasedComponent.ExtraCtrl

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

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() Clones the component.
int	getMaxlength() Returns the maximal length of the label.
java.lang.String	getValue() Returns the value.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
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 beginning of each line.
boolean	isPre() Returns whether to preserve the white spaces, such as space, tab and new line.
protected void	renderProperties(ContentRenderer renderer) Renders the content of this component, excluding the enclosing tags and children.
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 beginning 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, 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, 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 beginning of each line.

setMultiline

public void setMultiline(boolean multiline)

Sets whether to preserve the new line and the white spaces at the beginning 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(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 ZK Client-side Reference: Property Rendering

Overrides:

renderProperties in class XulElement

Throws:

java.io.IOException

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 (AbstractComponent.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.

Overrides:

getZclass in class HtmlBasedComponent

See Also:

HtmlBasedComponent.getSclass()

clone

public java.lang.Object clone()

Description copied from interface: Component

Clones the component. All of its children and descendants are cloned. Also, ID are preserved.

Specified by:

clone in interface Component

Overrides:

clone in class XulElement

Returns:

the new component. Notice that it doesn't belong to any page, nor desktop. It doesn't have a parent, either.

isChildable

protected boolean isChildable()

No child is allowed.

Overrides:

isChildable in class AbstractComponent