eu.webtoolkit.jwt
Class WImage

java.lang.Object
  eu.webtoolkit.jwt.WObject
      eu.webtoolkit.jwt.WWidget
          eu.webtoolkit.jwt.WWebWidget
              eu.webtoolkit.jwt.WInteractWidget
                  eu.webtoolkit.jwt.WImage

public class WImage
extends WInteractWidget

A widget that displays an image.

The image may be specified either as a URL, or may be dynamically generated by a WResource.

You may listen to events by attaching event listeners to signals such as WInteractWidget#clicked(). Since mouse events pass the coordinates through a WMouseEvent object, it is possible to react to clicks in specific parts of the image. An alternative is to define interactive areas on the image using addArea(), which in addition allows to have customized tool tips for certain image areas (using WAbstractArea#setToolTip()).

WImage is an inline widget.

CSS

The widget corresponds to the HTML <img> tag and does not provide styling. It can be styled using inline or external CSS as appropriate.

See Also:

WResource, WPaintedWidget

Constructor Summary

WImage()
Creates an empty image widget.

WImage(java.lang.String imageRef)
Creates an image widget with given image URL (deprecated).

WImage(java.lang.String imageRef, java.lang.CharSequence altText)
Creates an image widget with given image URL and alternate text (deprecated).

WImage(java.lang.String imageRef, java.lang.CharSequence altText, WContainerWidget parent)
Deprecated. Use WImage() instead.

WImage(java.lang.String imageRef, WContainerWidget parent)
Deprecated. Use WImage() instead.

WImage(WContainerWidget parent)
Creates an empty image widget.

WImage(WLink link)
Creates an image widget with a given image link.

WImage(WLink link, java.lang.CharSequence altText)
Creates an image widget with a given image link and alternate text.

WImage(WLink link, java.lang.CharSequence altText, WContainerWidget parent)
Creates an image widget with a given image link and alternate text.

WImage(WLink link, WContainerWidget parent)
Creates an image widget with a given image link.

WImage(WResource resource, java.lang.CharSequence altText)
Creates an image widget with given image resource and alternate text (deprecated).

WImage(WResource resource, java.lang.CharSequence altText, WContainerWidget parent)
Deprecated. Use WImage() instead.

Method Summary

void	addArea(WAbstractArea area) Adds an interactive area.
WString	getAlternateText() Returns the alternate text.
WAbstractArea	getArea(int index) Returns the interactive area at the given index.
java.util.List<WAbstractArea>	getAreas() Returns the interactive areas set for this widget.
WLink	getImageLink() Returns the image link.
java.lang.String	getImageRef() Deprecated. Use getImageLink() instead.
WResource	getResource() Deprecated. Use setImageLink() instead.
EventSignal	imageLoaded() Event emitted when the image was loaded.
void	insertArea(int index, WAbstractArea area) Inserts an interactive area.
void	remove() Destructor.
void	removeArea(WAbstractArea area) Removes an interactive area.
void	setAlternateText(java.lang.CharSequence text) Sets an alternate text.
void	setImageLink(WLink link) Sets the image link.
void	setImageRef(java.lang.String ref) Deprecated. Use setImageLink() instead.
void	setResource(WResource resource) Deprecated. Use setImageLink() instead.

Methods inherited from class eu.webtoolkit.jwt.WInteractWidget

clicked, doubleClicked, enterPressed, escapePressed, gestureChanged, gestureEnded, gestureStarted, isEnabled, keyPressed, keyWentDown, keyWentUp, load, mouseDragged, mouseMoved, mouseWentDown, mouseWentOut, mouseWentOver, mouseWentUp, mouseWheel, propagateSetEnabled, setDraggable, setDraggable, setDraggable, setDraggable, touchEnded, touchMoved, touchStarted

Methods inherited from class eu.webtoolkit.jwt.WWebWidget

addStyleClass, callJavaScriptMember, childrenChanged, doJavaScript, domCanBeSaved, enableAjax, escapeText, escapeText, escapeText, escapeText, find, getAttributeValue, getChildren, getClearSides, getDecorationStyle, getFloatSide, getHeight, getId, getJavaScriptMember, getLineHeight, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getOffset, getPositionScheme, getStyleClass, getTabIndex, getToolTip, getVerticalAlignment, getVerticalAlignmentLength, getWidth, isDisabled, isHidden, isHiddenKeepsGeometry, isInline, isLoaded, isPopup, isRendered, isVisible, jsStringLiteral, jsStringLiteral, refresh, removeScript, removeStyleClass, render, resize, setAttributeValue, setClearSides, setDecorationStyle, setDisabled, setFloatSide, setHidden, setHiddenKeepsGeometry, setId, setInline, setJavaScriptMember, setLineHeight, setLoadLaterWhenInvisible, setMargin, setMaximumSize, setMinimumSize, setOffsets, setPopup, setPositionScheme, setSelectable, setStyleClass, setTabIndex, setToolTip, setVerticalAlignment, updateSignalConnection

Methods inherited from class eu.webtoolkit.jwt.WWidget

acceptDrops, acceptDrops, addCssRule, addCssRule, addStyleClass, animateHide, animateShow, boxBorder, boxPadding, containsExposed, disable, dropEvent, enable, getDrop, getJsRef, getParent, hide, htmlText, isLayoutSizeAware, layoutSizeChanged, positionAt, positionAt, removeStyleClass, resize, setClearSides, setHeight, setHidden, setLayoutSizeAware, setMargin, setMargin, setMargin, setMargin, setMargin, setOffsets, setOffsets, setOffsets, setOffsets, setOffsets, setToolTip, setVerticalAlignment, setWidth, show, stopAcceptDrops, toggleStyleClass, toggleStyleClass, tr

Methods inherited from class eu.webtoolkit.jwt.WObject

addChild, getObjectName, setObjectName

Methods inherited from class java.lang.Object

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

Constructor Detail

WImage

public WImage(WContainerWidget parent)

Creates an empty image widget.

WImage

public WImage()

Creates an empty image widget.

Calls this((WContainerWidget)null)

WImage

public WImage(WLink link,
              WContainerWidget parent)

Creates an image widget with a given image link.

The imageLink may link to a URL or resource.

WImage

public WImage(WLink link)

Creates an image widget with a given image link.

Calls this(link, (WContainerWidget)null)

WImage

public WImage(WLink link,
              java.lang.CharSequence altText,
              WContainerWidget parent)

Creates an image widget with a given image link and alternate text.

The imageLink may link to a URL or resource.

WImage

public WImage(WLink link,
              java.lang.CharSequence altText)

Creates an image widget with a given image link and alternate text.

Calls this(link, altText, (WContainerWidget)null)

WImage

public WImage(java.lang.String imageRef,
              WContainerWidget parent)

Deprecated. Use WImage() instead.

Creates an image widget with given image URL (deprecated).

WImage

public WImage(java.lang.String imageRef)

Creates an image widget with given image URL (deprecated).

Calls this(imageRef, (WContainerWidget)null)

WImage

public WImage(java.lang.String imageRef,
              java.lang.CharSequence altText,
              WContainerWidget parent)

Deprecated. Use WImage() instead.

Creates an image widget with given image URL and alternate text (deprecated).

WImage

public WImage(java.lang.String imageRef,
              java.lang.CharSequence altText)

Creates an image widget with given image URL and alternate text (deprecated).

Calls this(imageRef, altText, (WContainerWidget)null)

WImage

public WImage(WResource resource,
              java.lang.CharSequence altText,
              WContainerWidget parent)

Deprecated. Use WImage() instead.

Creates an image widget with given image resource and alternate text (deprecated).

WImage

public WImage(WResource resource,
              java.lang.CharSequence altText)

Creates an image widget with given image resource and alternate text (deprecated).

Calls this(resource, altText, (WContainerWidget)null)

Method Detail

remove

public void remove()

Description copied from class: WWidget

Destructor.

Deletes a widget and all children (recursively). If the widget is contained in another widget, it is removed first.

Overrides:

remove in class WInteractWidget

See Also:

WContainerWidget.removeWidget(WWidget widget)

setAlternateText

public void setAlternateText(java.lang.CharSequence text)

Sets an alternate text.

The alternate text should provide a fallback for browsers that do not display an image. If no sensible fallback text can be provided, an empty text is preferred over nonsense.

This should not be confused with WWebWidget#getToolTip() text, which provides additional information that is displayed when the mouse hovers over the image.

The default alternate text is an empty text ("").

See Also:

getAlternateText()

getAlternateText

public WString getAlternateText()

Returns the alternate text.

See Also:

setAlternateText(CharSequence text)

setImageLink

public void setImageLink(WLink link)

Sets the image link.

The image may be specified as a URL or as a resource. A resource specifies application-dependent content, which may be used to generate an image on demand.

getImageLink

public WLink getImageLink()

Returns the image link.

setImageRef

public void setImageRef(java.lang.String ref)

Deprecated. Use setImageLink() instead.

Sets the image URL (deprecated).

getImageRef

public java.lang.String getImageRef()

Deprecated. Use getImageLink() instead.

Returns the image URL (deprecated).

When the image is specified as a resource, this returns the current resource URL.

setResource

public void setResource(WResource resource)

Deprecated. Use setImageLink() instead.

Sets the image resource (deprecated).

getResource

public WResource getResource()

Deprecated. Use setImageLink() instead.

Returns the image resource (deprecated.

Returns null if no image resource was set.

addArea

public void addArea(WAbstractArea area)

Adds an interactive area.

Adds the area which listens to events in a specific region of the image. Areas are organized in an indexed list, to which the given area is appended. When areas overlap, the area with the lowest index receives the event.

Ownership of the area is transferred to the image.

See Also:

insertArea(int index, WAbstractArea area)

insertArea

public void insertArea(int index,
                       WAbstractArea area)

Inserts an interactive area.

Inserts the area which listens to events in the coresponding area of the image. Areas are organized in a list, and the area is inserted at index index. When areas overlap, the area with the lowest index receives the event.

Ownership of the area is transferred to the image.

See Also:

addArea(WAbstractArea area)

removeArea

public void removeArea(WAbstractArea area)

Removes an interactive area.

Removes the area from this widget, and also returns the ownership.

See Also:

addArea(WAbstractArea area)

getArea

public WAbstractArea getArea(int index)

Returns the interactive area at the given index.

Returns null if index was invalid.

See Also:

insertArea(int index, WAbstractArea area)

getAreas

public java.util.List<WAbstractArea> getAreas()

Returns the interactive areas set for this widget.

See Also:

addArea(WAbstractArea area)

imageLoaded

public EventSignal imageLoaded()

Event emitted when the image was loaded.