|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.impl.LabelElement
org.zkoss.zul.impl.LabelImageElement
public abstract class LabelImageElement
A XUL element with a label (LabelElement.getLabel()
)
and an image (getImage()
).
Nested Class Summary | |
---|---|
protected class |
LabelImageElement.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 | |
---|---|
protected |
LabelImageElement()
|
protected |
LabelImageElement(java.lang.String label)
|
protected |
LabelImageElement(java.lang.String label,
java.lang.String image)
|
Method Summary | |
---|---|
java.lang.String |
getHoverImage()
Returns the URI of the hover image. |
java.lang.String |
getImage()
Returns the image URI. |
Image |
getImageContent()
Returns the image content set by setImageContent(Image)
or setImageContent(RenderedImage) . |
java.lang.String |
getSrc()
Deprecated. As of release 3.5.0, it is redudant since it is the same as getImage() |
boolean |
isImageAssigned()
Returns whether the image is available. |
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 |
setHoverImage(java.lang.String src)
Sets the image URI. |
void |
setHoverImageContent(Image image)
Sets the content of the hover image directly. |
void |
setHoverImageContent(java.awt.image.RenderedImage image)
Sets the content of the hover image directly with the rendered image. |
void |
setImage(java.lang.String src)
Sets the image URI. |
void |
setImageContent(Image image)
Sets the content directly. |
void |
setImageContent(java.awt.image.RenderedImage image)
Sets the content directly with the rendered image. |
void |
setSrc(java.lang.String src)
Deprecated. As of release 3.5.0, it is redudant since it is the same as setImage(java.lang.String) |
Methods inherited from class org.zkoss.zul.impl.LabelElement |
---|
getLabel, setLabel |
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, getZclass, getZindex, getZIndex, service, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.zkoss.zul.impl.api.LabelElement |
---|
getLabel, setLabel |
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, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from interface org.zkoss.zk.ui.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Constructor Detail |
---|
protected LabelImageElement()
protected LabelImageElement(java.lang.String label, java.lang.String image)
protected LabelImageElement(java.lang.String label)
Method Detail |
---|
public java.lang.String getImage()
Default: null.
getImage
in interface LabelImageElement
public void setImage(java.lang.String src)
Calling this method implies setImageContent(null).
In other words, the last invocation of setImage(java.lang.String)
overrides
the previous setImageContent(org.zkoss.image.Image)
, if any.
setImage
in interface LabelImageElement
setImageContent(Image)
,
setImageContent(RenderedImage)
public java.lang.String getSrc()
getImage()
public void setSrc(java.lang.String src)
setImage(java.lang.String)
public void setImageContent(Image image)
Default: null.
Calling this method implies setImage(null).
In other words, the last invocation of setImageContent(org.zkoss.image.Image)
overrides
the previous setImage(java.lang.String)
, if any.
setImageContent
in interface LabelImageElement
image
- the image to display.setImage(java.lang.String)
public void setImageContent(java.awt.image.RenderedImage image)
Image
) with Images.encode(java.lang.String, java.awt.image.RenderedImage, float, boolean)
,
and then invoke setImageContent(org.zkoss.image.Image)
.
If you want more control such as different format, quality,
and naming, you can use Images
directly.
setImageContent
in interface LabelImageElement
public Image getImageContent()
setImageContent(Image)
or setImageContent(RenderedImage)
.
Note: it won't load the content specified by setImage(java.lang.String)
.
Actually, it returns null if setImage(java.lang.String)
was called.
getImageContent
in interface LabelImageElement
public java.lang.String getHoverImage()
Default: null.
getHoverImage
in interface LabelImageElement
public void setHoverImage(java.lang.String src)
Calling this method implies setHoverImageContent(null).
In other words, the last invocation of setHoverImage(java.lang.String)
overrides
the previous setHoverImageContent(org.zkoss.image.Image)
, if any.
setHoverImage
in interface LabelImageElement
public void setHoverImageContent(Image image)
Default: null.
Calling this method implies setHoverImage(null).
In other words, the last invocation of setHoverImageContent(org.zkoss.image.Image)
overrides
the previous setHoverImage(java.lang.String)
, if any.
setHoverImageContent
in interface LabelImageElement
image
- the image to display.public void setHoverImageContent(java.awt.image.RenderedImage image)
It actually encodes the rendered image to an PNG image
(Image
) with Images.encode(java.lang.String, java.awt.image.RenderedImage, float, boolean)
,
and then invoke setHoverImageContent(org.zkoss.image.Image)
.
If you want more control such as different format, quality,
and naming, you can use Images
directly.
setHoverImageContent
in interface LabelImageElement
public boolean isImageAssigned()
setImage(java.lang.String)
or
setImageContent(org.zkoss.image.Image)
is called with non-null.
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponent
See also Render Special Properties
renderProperties
in class LabelElement
java.io.IOException
protected java.lang.Object newExtraCtrl()
HtmlBasedComponent
AbstractComponent.getExtraCtrl()
to create a client control.
It is used only by component developers.
Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl
.
newExtraCtrl
in class HtmlBasedComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |