zul
Class LabelImageWidget

java.lang.Object
  extended by zk.Object
      extended by zk.Widget
          extended by zul.Widget
              extended by zul.LabelImageWidget
Direct Known Subclasses:
A, Button, Caption, Checkbox, Comboitem, Fisheye, FooterWidget, HeaderWidget, Listcell, Menu, Menuitem, Tab, Toolbarbutton, Treecell

public class LabelImageWidget
extends Widget

A skeletal implementation for ZUL widgets that support both label and image.


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
protected  String domContent_()
          Returns the HTML content of the label and image.
protected  String domImage_()
          Returns the HTML image content.
protected  String domLabel_()
          Returns the encoded label.
 String getHoverImage()
          Returns the URI of the hover image.
 String getImage()
          Returns the image URI.
 DOMElement getImageNode()
          Returns the image node if any.
 String getLabel()
          Returns the label (never null).
 void setHoverImage(String src)
          Sets the image URI.
 void setImage(String image)
          Sets the image URI.
 void setLabel(String label)
          Sets the label.
protected  void updateDomContent_()
          Updates the DOM tree for the modified label and image.
 
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, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, 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, scrollIntoView, sendAU_, set, set, setAction, setChildren, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, 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

getLabel

public String getLabel()
Returns the label (never null).

Default: "".

Returns:
String

setLabel

public void setLabel(String label)
Sets the label.

If label is changed, the whole component is invalidate. Thus, you want to smart-update, you have to override updateDomContent_().

Parameters:
label -

getImage

public String getImage()
Returns the image URI.

Default: null.

Returns:
String

setImage

public void setImage(String image)
Sets the image URI.

Parameters:
image - the URI of the image

getHoverImage

public String getHoverImage()
Returns the URI of the hover image. The hover image is used when the mouse is moving over this component.

Default: null.

Returns:
String

setHoverImage

public void setHoverImage(String src)
Sets the image URI. The hover image is used when the mouse is moving over this component.

Parameters:
src -

updateDomContent_

protected void updateDomContent_()
Updates the DOM tree for the modified label and image. It is called by setLabel(_global_.String) and setImage(_global_.String) to update the new content of the label and/or image to the DOM tree. Default: invoke Widget.rerender(int) to redraw and re-bind.


domImage_

protected String domImage_()
Returns the HTML image content.

Returns:
String

domLabel_

protected String domLabel_()
Returns the encoded label.

Returns:
String
See Also:
zUtl.encodeXML(_global_.String, _global_.Map)

domContent_

protected String domContent_()
Returns the HTML content of the label and image. It is a fragment of HTML that you can use in the mold.

Returns:
String
See Also:
domImage_(), domLabel_()

getImageNode

public DOMElement getImageNode()
Returns the image node if any.

Returns:
DOMElement


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