zul.wgt

Class Label

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zul.wgt.Label

public class Label
extends Widget

A label.

Default Widget.getZclass(): z-label.

Field Summary

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
String	getEncodedText() Returns the encoded text.
int	getMaxlength() Returns the maximal length of the label.
String	getValue() Returns the value.
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.
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(String value) Sets the value.

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTabindex, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTabindex, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setValue

public void setValue(String value)

Sets the value.

Parameters:

value -

getValue

public String getValue()

Returns the value.

Default: "".

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

Returns:

String

setMultiline

public void setMultiline(boolean multiline)

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

Parameters:

multiline -

isMultiline

public boolean isMultiline()

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

Returns:

boolean

setPre

public void setPre(boolean pre)

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

Parameters:

pre -

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

Returns:

boolean

setMaxlength

public void setMaxlength(int maxlength)

Sets the maximal length of the label.

Parameters:

maxlength -

getMaxlength

public int getMaxlength()

Returns the maximal length of the label.

Default: 0 (means no limitation)

Returns:

int

getEncodedText

public String getEncodedText()

Returns the encoded text.

Returns:

String

See Also:

zUtl.encodeXML(_global_.String, _global_.Map)