org.zkoss.zul
Class Image

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zk.ui.HtmlBasedComponent
          extended by org.zkoss.zul.impl.XulElement
              extended by org.zkoss.zul.Image
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, HtmlBasedComponent, Component, Scope, ComponentCtrl, Image, XulElement
Direct Known Subclasses:
Captcha, Imagemap

public class Image
extends XulElement
implements Image

An image.

See also how to fix the alpha transparency problem of PNG files found in IE6?

Author:
tomyeh
See Also:
Serialized Form

Nested Class Summary
protected  class Image.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
Image()
           
Image(java.lang.String src)
           
 
Method Summary
 java.lang.String getAlign()
          Returns the alignment.
 java.lang.String getBorder()
          Returns the width of the border.
 Image getContent()
          Returns the content set by setContent(org.zkoss.image.Image).
 java.lang.String getHover()
          Returns the URI of the hover image.
 java.lang.String getHspace()
          Returns number of pixels of extra space to the left and right side of the image.
 java.lang.String getSrc()
          Returns the source URI of the image.
 java.lang.String getVspace()
          Returns number of pixels of extra space to the top and bottom side of the image.
protected  boolean isChildable()
          Default: not childable.
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 setAlign(java.lang.String align)
          Sets the alignment: one of top, texttop, middle, absmiddle, bottom, absbottom, baseline, left, right and center.
 void setBorder(java.lang.String border)
          Sets the width of the border.
 void setContent(Image image)
          Sets the content directly.
 void setContent(java.awt.image.RenderedImage image)
          Sets the content directly with the rendered image.
 void setHover(java.lang.String src)
          Sets the image URI.
 void setHoverContent(Image image)
          Sets the content of the hover image directly.
 void setHoverContent(java.awt.image.RenderedImage image)
          Sets the content of the hover image directly with the rendered image.
 void setHspace(java.lang.String hspace)
          Sets number of pixels of extra space to the left and right side of the image.
 void setSrc(java.lang.String src)
          Sets the source URI of the image.
 void setVspace(java.lang.String vspace)
          Sets number of pixels of extra space to the top and bottom side of the image.
 
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 org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, clone, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
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.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Constructor Detail

Image

public Image()

Image

public Image(java.lang.String src)
Method Detail

getAlign

public java.lang.String getAlign()
Returns the alignment.

Default: null (use browser default).

Specified by:
getAlign in interface Image

setAlign

public void setAlign(java.lang.String align)
Sets the alignment: one of top, texttop, middle, absmiddle, bottom, absbottom, baseline, left, right and center.

Specified by:
setAlign in interface Image

getBorder

public java.lang.String getBorder()
Returns the width of the border.

Default: null (use browser default).

Specified by:
getBorder in interface Image

setBorder

public void setBorder(java.lang.String border)
Sets the width of the border.

Specified by:
setBorder in interface Image

getHspace

public java.lang.String getHspace()
Returns number of pixels of extra space to the left and right side of the image.

Default: null (use browser default).

Specified by:
getHspace in interface Image

setHspace

public void setHspace(java.lang.String hspace)
Sets number of pixels of extra space to the left and right side of the image.

Specified by:
setHspace in interface Image

getVspace

public java.lang.String getVspace()
Returns number of pixels of extra space to the top and bottom side of the image.

Default: null (use browser default).

Specified by:
getVspace in interface Image

setVspace

public void setVspace(java.lang.String vspace)
Sets number of pixels of extra space to the top and bottom side of the image.

Specified by:
setVspace in interface Image

getSrc

public java.lang.String getSrc()
Returns the source URI of the image.

Default: null.

Specified by:
getSrc in interface Image

setSrc

public void setSrc(java.lang.String src)
Sets the source URI of the image.

Calling this method implies setContent(null). In other words, the last invocation of setSrc(java.lang.String) overrides the previous setContent(org.zkoss.image.Image), if any.

Specified by:
setSrc in interface Image
Parameters:
src - the URI of the image source
See Also:
setContent(org.zkoss.image.Image), setContent(RenderedImage)

setContent

public void setContent(Image image)
Sets the content directly.

Default: null.

Calling this method implies setSrc(null). In other words, the last invocation of setContent(org.zkoss.image.Image) overrides the previous setSrc(java.lang.String), if any.

Specified by:
setContent in interface Image
Parameters:
image - the image to display.
See Also:
setSrc(java.lang.String)

setContent

public void setContent(java.awt.image.RenderedImage image)
Sets the content directly with the rendered 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 setContent(org.zkoss.image.Image).

If you want more control such as different format, quality, and naming, you can use Images directly.

Specified by:
setContent in interface Image
Since:
3.0.7

getContent

public Image getContent()
Returns the content set by setContent(org.zkoss.image.Image).

Note: it won't fetch what is set thru by setSrc(java.lang.String). It simply returns what is passed to setContent(org.zkoss.image.Image).

Specified by:
getContent in interface Image

getHover

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

Default: null.

Specified by:
getHover in interface Image
Since:
3.5.0

setHover

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

Calling this method implies setHoverContent(null). In other words, the last invocation of setHover(java.lang.String) overrides the previous setHoverContent(org.zkoss.image.Image), if any.

Specified by:
setHover in interface Image
Since:
3.5.0
See Also:
setHoverContent(org.zkoss.image.Image), setHoverContent(RenderedImage)

setHoverContent

public void setHoverContent(Image image)
Sets the content of the hover image directly. The hover image is used when the mouse is moving over this component.

Default: null.

Calling this method implies setHover(null). In other words, the last invocation of setHoverContent(org.zkoss.image.Image) overrides the previous setHover(java.lang.String), if any.

Specified by:
setHoverContent in interface Image
Parameters:
image - the image to display.
Since:
3.5.0
See Also:
setHover(java.lang.String)

setHoverContent

public void setHoverContent(java.awt.image.RenderedImage image)
Sets the content of the hover image directly with the rendered image. The hover image is used when the mouse is moving over this component.

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 setHoverContent(org.zkoss.image.Image).

If you want more control such as different format, quality, and naming, you can use Images directly.

Specified by:
setHoverContent in interface Image
Since:
3.5.0

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 Render Special Properties

Overrides:
renderProperties in class XulElement
Throws:
java.io.IOException

isChildable

protected boolean isChildable()
Default: not childable.

Overrides:
isChildable in class AbstractComponent

newExtraCtrl

protected java.lang.Object newExtraCtrl()
Description copied from class: HtmlBasedComponent
Used by AbstractComponent.getExtraCtrl() to create a client control. It is used only by component developers.

Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl.

Overrides:
newExtraCtrl in class HtmlBasedComponent


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