Package com.google.gwt.user.client.ui
Class Image
- java.lang.Object
-
- com.google.gwt.user.client.ui.UIObject
-
- com.google.gwt.user.client.ui.Widget
-
- com.google.gwt.user.client.ui.Image
-
- All Implemented Interfaces:
HasAllDragAndDropHandlers
,HasAllGestureHandlers
,HasAllMouseHandlers
,HasAllTouchHandlers
,HasClickHandlers
,HasDoubleClickHandlers
,HasDragEndHandlers
,HasDragEnterHandlers
,HasDragHandlers
,HasDragLeaveHandlers
,HasDragOverHandlers
,HasDragStartHandlers
,HasDropHandlers
,HasErrorHandlers
,HasGestureChangeHandlers
,HasGestureEndHandlers
,HasGestureStartHandlers
,HasLoadHandlers
,HasMouseDownHandlers
,HasMouseMoveHandlers
,HasMouseOutHandlers
,HasMouseOverHandlers
,HasMouseUpHandlers
,HasMouseWheelHandlers
,HasTouchCancelHandlers
,HasTouchEndHandlers
,HasTouchMoveHandlers
,HasTouchStartHandlers
,HasAttachHandlers
,HasHandlers
,EventListener
,HasVisibility
,IsWidget
,SourcesClickEvents
,SourcesLoadEvents
,SourcesMouseEvents
public class Image extends Widget implements SourcesLoadEvents, HasLoadHandlers, HasErrorHandlers, SourcesClickEvents, HasClickHandlers, HasDoubleClickHandlers, HasAllDragAndDropHandlers, HasAllGestureHandlers, HasAllMouseHandlers, HasAllTouchHandlers, SourcesMouseEvents
A widget that displays the image at a given URL. The image can be in 'unclipped' mode (the default) or 'clipped' mode. In clipped mode, a viewport is overlaid on top of the image so that a subset of the image will be displayed. In unclipped mode, there is no viewport - the entire image will be visible. Whether an image is in clipped or unclipped mode depends on how the image is constructed, and how it is transformed after construction. Methods will operate differently depending on the mode that the image is in. These differences are detailed in the documentation for each method.If an image transitions between clipped mode and unclipped mode, any
Element
-specific attributes added by the user (including style attributes, style names, and style modifiers), except for event listeners, will be lost.CSS Style Rules
- .gwt-Image The outer element
Example
public class ImageExample implements EntryPoint { private Label lbl = new Label(); private Button btn = new Button("Clip this image"); private Button btn2 = new Button("Restore image"); public void onModuleLoad() { // Create an image, not yet referencing a URL. We make it final so that we // can manipulate the image object within the ClickHandlers for the buttons. final Image image = new Image(); // Hook up an error handler, so that we can be informed if the image fails // to load. image.addErrorHandler(new ErrorHandler() { public void onError(ErrorEvent event) { lbl.setText("An error occurred while loading."); } }); // Point the image at a real URL. image.setUrl("http://www.google.com/images/logo.gif"); // When the user clicks this button, we want to clip the image. btn.addClickHandler(new ClickHandler() { public void onClick(ClickEvent event) { image.setVisibleRect(70, 0, 47, 110); } }); btn.setWidth("120px"); // When the user clicks this button, we want to restore the image to its // unclipped state. btn2.addClickHandler(new ClickHandler() { public void onClick(ClickEvent event) { image.setUrl("http://www.google.com/images/logo.gif"); } }); btn2.setWidth("120px"); // Add the image, label, and clip/restore buttons to the root panel. VerticalPanel panel = new VerticalPanel(); panel.add(lbl); panel.add(image); HorizontalPanel buttonPanel = new HorizontalPanel(); buttonPanel.add(btn); buttonPanel.add(btn2); panel.add(buttonPanel); RootPanel.get().add(panel); } }
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
-
-
Field Summary
-
Fields inherited from class com.google.gwt.user.client.ui.Widget
eventsToSink
-
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX, MISSING_ELEMENT_ERROR, SETELEMENT_TWICE_ERROR
-
-
Constructor Summary
Constructors Modifier Constructor Description Image()
Creates an empty image.protected
Image(Element element)
This constructor may be used by subclasses to explicitly use an existing element.Image(ImageResource resource)
Creates an image whose size and content are defined by an ImageResource.Image(SafeUri url)
Creates an image with a specified URL.Image(SafeUri url, int left, int top, int width, int height)
Creates a clipped image with a specified URL and visibility rectangle.Image(java.lang.String url)
Creates an image with a specified URL.Image(java.lang.String url, int left, int top, int width, int height)
Creates a clipped image with a specified URL and visibility rectangle.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description HandlerRegistration
addClickHandler(ClickHandler handler)
Adds aClickEvent
handler.void
addClickListener(ClickListener listener)
Deprecated.HandlerRegistration
addDoubleClickHandler(DoubleClickHandler handler)
Adds aDoubleClickEvent
handler.HandlerRegistration
addDragEndHandler(DragEndHandler handler)
Adds aDragEndEvent
handler.HandlerRegistration
addDragEnterHandler(DragEnterHandler handler)
Adds aDragEnterEvent
handler.HandlerRegistration
addDragHandler(DragHandler handler)
Adds aDragEvent
handler.HandlerRegistration
addDragLeaveHandler(DragLeaveHandler handler)
Adds aDragLeaveEvent
handler.HandlerRegistration
addDragOverHandler(DragOverHandler handler)
Adds aDragOverEvent
handler.HandlerRegistration
addDragStartHandler(DragStartHandler handler)
Adds aDragStartEvent
handler.HandlerRegistration
addDropHandler(DropHandler handler)
Adds aDropEvent
handler.HandlerRegistration
addErrorHandler(ErrorHandler handler)
Adds anErrorEvent
handler.HandlerRegistration
addGestureChangeHandler(GestureChangeHandler handler)
Adds aGestureChangeEvent
handler.HandlerRegistration
addGestureEndHandler(GestureEndHandler handler)
Adds aGestureEndEvent
handler.HandlerRegistration
addGestureStartHandler(GestureStartHandler handler)
Adds aGestureStartEvent
handler.HandlerRegistration
addLoadHandler(LoadHandler handler)
Adds aLoadEvent
handler.void
addLoadListener(LoadListener listener)
Deprecated.useLoadHandler
andErrorHandler
insteadHandlerRegistration
addMouseDownHandler(MouseDownHandler handler)
Adds aMouseDownEvent
handler.void
addMouseListener(MouseListener listener)
Deprecated.UseaddMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler)
addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler)
,addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler)
,addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler)
andaddMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler)
insteadHandlerRegistration
addMouseMoveHandler(MouseMoveHandler handler)
Adds aMouseMoveEvent
handler.HandlerRegistration
addMouseOutHandler(MouseOutHandler handler)
Adds aMouseOutEvent
handler.HandlerRegistration
addMouseOverHandler(MouseOverHandler handler)
Adds aMouseOverEvent
handler.HandlerRegistration
addMouseUpHandler(MouseUpHandler handler)
Adds aMouseUpEvent
handler.HandlerRegistration
addMouseWheelHandler(MouseWheelHandler handler)
Adds aMouseWheelEvent
handler.void
addMouseWheelListener(MouseWheelListener listener)
Deprecated.HandlerRegistration
addTouchCancelHandler(TouchCancelHandler handler)
Adds aTouchCancelEvent
handler.HandlerRegistration
addTouchEndHandler(TouchEndHandler handler)
Adds aTouchEndEvent
handler.HandlerRegistration
addTouchMoveHandler(TouchMoveHandler handler)
Adds aTouchMoveEvent
handler.HandlerRegistration
addTouchStartHandler(TouchStartHandler handler)
Adds aTouchStartEvent
handler.java.lang.String
getAltText()
Gets the alternate text for the image.int
getHeight()
Gets the height of the image.int
getOriginLeft()
Gets the horizontal co-ordinate of the upper-left vertex of the image's visibility rectangle.int
getOriginTop()
Gets the vertical co-ordinate of the upper-left vertex of the image's visibility rectangle.java.lang.String
getUrl()
Gets the URL of the image.int
getWidth()
Gets the width of the image.void
onBrowserEvent(Event event)
Fired whenever a browser event is received.protected void
onLoad()
This method is called immediately after a widget becomes attached to the browser's document.static void
prefetch(SafeUri url)
Causes the browser to pre-fetch the image at a given URL.static void
prefetch(java.lang.String url)
Causes the browser to pre-fetch the image at a given URL.void
removeClickListener(ClickListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned byaddClickHandler(com.google.gwt.event.dom.client.ClickHandler)
insteadvoid
removeLoadListener(LoadListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadvoid
removeMouseListener(MouseListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadvoid
removeMouseWheelListener(MouseWheelListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned byaddMouseWheelHandler(com.google.gwt.event.dom.client.MouseWheelHandler)
insteadvoid
setAltText(java.lang.String altText)
Sets the alternate text of the image for user agents that can't render the image.void
setResource(ImageResource resource)
Sets the url and the visibility rectangle for the image at the same time, based on an ImageResource instance.void
setUrl(SafeUri url)
Sets the URL of the image to be displayed.void
setUrl(java.lang.String url)
Sets the URL of the image to be displayed.void
setUrlAndVisibleRect(SafeUri url, int left, int top, int width, int height)
Sets the url and the visibility rectangle for the image at the same time.void
setUrlAndVisibleRect(java.lang.String url, int left, int top, int width, int height)
Sets the url and the visibility rectangle for the image at the same time.void
setVisibleRect(int left, int top, int width, int height)
Sets the visibility rectangle of an image.static Image
wrap(Element element)
Creates a Image widget that wraps an existing <img> element.-
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, ensureHandlers, fireEvent, getHandlerCount, getHandlerManager, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onUnload, removeFromParent, replaceElement, setLayoutData, setParent, sinkEvents, unsinkEvents
-
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
-
-
-
Constructor Detail
-
Image
public Image()
Creates an empty image.
-
Image
public Image(ImageResource resource)
Creates an image whose size and content are defined by an ImageResource.- Parameters:
resource
- the ImageResource to be displayed
-
Image
public Image(java.lang.String url)
Creates an image with a specified URL. The load event will be fired once the image at the given URL has been retrieved by the browser.- Parameters:
url
- the URL of the image to be displayed
-
Image
public Image(SafeUri url)
Creates an image with a specified URL. The load event will be fired once the image at the given URL has been retrieved by the browser.- Parameters:
url
- the URL of the image to be displayed
-
Image
public Image(java.lang.String url, int left, int top, int width, int height)
Creates a clipped image with a specified URL and visibility rectangle. The visibility rectangle is declared relative to the rectangle which encompasses the entire image, which has an upper-left vertex of (0,0). The load event will be fired immediately after the object has been constructed (i.e. potentially before the image has been loaded in the browser). Since the width and height are specified explicitly by the user, this behavior will not cause problems with retrieving the width and height of a clipped image in a load event handler.- Parameters:
url
- the URL of the image to be displayedleft
- the horizontal co-ordinate of the upper-left vertex of the visibility rectangletop
- the vertical co-ordinate of the upper-left vertex of the visibility rectanglewidth
- the width of the visibility rectangleheight
- the height of the visibility rectangle
-
Image
public Image(SafeUri url, int left, int top, int width, int height)
Creates a clipped image with a specified URL and visibility rectangle. The visibility rectangle is declared relative to the rectangle which encompasses the entire image, which has an upper-left vertex of (0,0). The load event will be fired immediately after the object has been constructed (i.e. potentially before the image has been loaded in the browser). Since the width and height are specified explicitly by the user, this behavior will not cause problems with retrieving the width and height of a clipped image in a load event handler.- Parameters:
url
- the URL of the image to be displayedleft
- the horizontal co-ordinate of the upper-left vertex of the visibility rectangletop
- the vertical co-ordinate of the upper-left vertex of the visibility rectanglewidth
- the width of the visibility rectangleheight
- the height of the visibility rectangle
-
Image
protected Image(Element element)
This constructor may be used by subclasses to explicitly use an existing element. This element must be an <img> element.- Parameters:
element
- the element to be used
-
-
Method Detail
-
prefetch
public static void prefetch(java.lang.String url)
Causes the browser to pre-fetch the image at a given URL.- Parameters:
url
- the URL of the image to be prefetched
-
prefetch
public static void prefetch(SafeUri url)
Causes the browser to pre-fetch the image at a given URL.- Parameters:
url
- the URL of the image to be prefetched
-
wrap
public static Image wrap(Element element)
Creates a Image widget that wraps an existing <img> element. This element must already be attached to the document. If the element is removed from the document, you must callRootPanel.detachNow(Widget)
.- Parameters:
element
- the element to be wrapped
-
addClickHandler
public HandlerRegistration addClickHandler(ClickHandler handler)
Description copied from interface:HasClickHandlers
Adds aClickEvent
handler.- Specified by:
addClickHandler
in interfaceHasClickHandlers
- Parameters:
handler
- the click handler- Returns:
HandlerRegistration
used to remove this handler
-
addClickListener
@Deprecated public void addClickListener(ClickListener listener)
Deprecated.Description copied from interface:SourcesClickEvents
Adds a listener interface to receive click events.- Specified by:
addClickListener
in interfaceSourcesClickEvents
- Parameters:
listener
- the listener interface to add
-
addDoubleClickHandler
public HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler)
Description copied from interface:HasDoubleClickHandlers
Adds aDoubleClickEvent
handler.- Specified by:
addDoubleClickHandler
in interfaceHasDoubleClickHandlers
- Parameters:
handler
- the double click handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragEndHandler
public HandlerRegistration addDragEndHandler(DragEndHandler handler)
Description copied from interface:HasDragEndHandlers
Adds aDragEndEvent
handler.- Specified by:
addDragEndHandler
in interfaceHasDragEndHandlers
- Parameters:
handler
- the drag end handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragEnterHandler
public HandlerRegistration addDragEnterHandler(DragEnterHandler handler)
Description copied from interface:HasDragEnterHandlers
Adds aDragEnterEvent
handler.- Specified by:
addDragEnterHandler
in interfaceHasDragEnterHandlers
- Parameters:
handler
- the drag end handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragHandler
public HandlerRegistration addDragHandler(DragHandler handler)
Description copied from interface:HasDragHandlers
Adds aDragEvent
handler.- Specified by:
addDragHandler
in interfaceHasDragHandlers
- Parameters:
handler
- the drag handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragLeaveHandler
public HandlerRegistration addDragLeaveHandler(DragLeaveHandler handler)
Description copied from interface:HasDragLeaveHandlers
Adds aDragLeaveEvent
handler.- Specified by:
addDragLeaveHandler
in interfaceHasDragLeaveHandlers
- Parameters:
handler
- the drag leave handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragOverHandler
public HandlerRegistration addDragOverHandler(DragOverHandler handler)
Description copied from interface:HasDragOverHandlers
Adds aDragOverEvent
handler.- Specified by:
addDragOverHandler
in interfaceHasDragOverHandlers
- Parameters:
handler
- the drag over handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragStartHandler
public HandlerRegistration addDragStartHandler(DragStartHandler handler)
Description copied from interface:HasDragStartHandlers
Adds aDragStartEvent
handler.- Specified by:
addDragStartHandler
in interfaceHasDragStartHandlers
- Parameters:
handler
- the drag start handler- Returns:
HandlerRegistration
used to remove this handler
-
addDropHandler
public HandlerRegistration addDropHandler(DropHandler handler)
Description copied from interface:HasDropHandlers
Adds aDropEvent
handler.- Specified by:
addDropHandler
in interfaceHasDropHandlers
- Parameters:
handler
- the drop handler- Returns:
HandlerRegistration
used to remove this handler
-
addErrorHandler
public HandlerRegistration addErrorHandler(ErrorHandler handler)
Description copied from interface:HasErrorHandlers
Adds anErrorEvent
handler.- Specified by:
addErrorHandler
in interfaceHasErrorHandlers
- Parameters:
handler
- the error handler- Returns:
HandlerRegistration
used to remove this handler
-
addGestureChangeHandler
public HandlerRegistration addGestureChangeHandler(GestureChangeHandler handler)
Description copied from interface:HasGestureChangeHandlers
Adds aGestureChangeEvent
handler.- Specified by:
addGestureChangeHandler
in interfaceHasGestureChangeHandlers
- Parameters:
handler
- the gesture change handler- Returns:
HandlerRegistration
used to remove this handler
-
addGestureEndHandler
public HandlerRegistration addGestureEndHandler(GestureEndHandler handler)
Description copied from interface:HasGestureEndHandlers
Adds aGestureEndEvent
handler.- Specified by:
addGestureEndHandler
in interfaceHasGestureEndHandlers
- Parameters:
handler
- the gesture end handler- Returns:
HandlerRegistration
used to remove this handler
-
addGestureStartHandler
public HandlerRegistration addGestureStartHandler(GestureStartHandler handler)
Description copied from interface:HasGestureStartHandlers
Adds aGestureStartEvent
handler.- Specified by:
addGestureStartHandler
in interfaceHasGestureStartHandlers
- Parameters:
handler
- the gesture start handler- Returns:
HandlerRegistration
used to remove this handler
-
addLoadHandler
public HandlerRegistration addLoadHandler(LoadHandler handler)
Description copied from interface:HasLoadHandlers
Adds aLoadEvent
handler.- Specified by:
addLoadHandler
in interfaceHasLoadHandlers
- Parameters:
handler
- the load handler- Returns:
HandlerRegistration
used to remove this handler
-
addLoadListener
@Deprecated public void addLoadListener(LoadListener listener)
Deprecated.useLoadHandler
andErrorHandler
insteadDescription copied from interface:SourcesLoadEvents
Adds a listener interface to receive load events.- Specified by:
addLoadListener
in interfaceSourcesLoadEvents
- Parameters:
listener
- the listener interface to add
-
addMouseDownHandler
public HandlerRegistration addMouseDownHandler(MouseDownHandler handler)
Description copied from interface:HasMouseDownHandlers
Adds aMouseDownEvent
handler.- Specified by:
addMouseDownHandler
in interfaceHasMouseDownHandlers
- Parameters:
handler
- the mouse down handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseListener
@Deprecated public void addMouseListener(MouseListener listener)
Deprecated.UseaddMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler)
addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler)
,addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler)
,addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler)
andaddMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler)
insteadDescription copied from interface:SourcesMouseEvents
Adds a listener interface to receive mouse events.- Specified by:
addMouseListener
in interfaceSourcesMouseEvents
- Parameters:
listener
- the listener interface to add
-
addMouseMoveHandler
public HandlerRegistration addMouseMoveHandler(MouseMoveHandler handler)
Description copied from interface:HasMouseMoveHandlers
Adds aMouseMoveEvent
handler.- Specified by:
addMouseMoveHandler
in interfaceHasMouseMoveHandlers
- Parameters:
handler
- the mouse move handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseOutHandler
public HandlerRegistration addMouseOutHandler(MouseOutHandler handler)
Description copied from interface:HasMouseOutHandlers
Adds aMouseOutEvent
handler.- Specified by:
addMouseOutHandler
in interfaceHasMouseOutHandlers
- Parameters:
handler
- the mouse out handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseOverHandler
public HandlerRegistration addMouseOverHandler(MouseOverHandler handler)
Description copied from interface:HasMouseOverHandlers
Adds aMouseOverEvent
handler.- Specified by:
addMouseOverHandler
in interfaceHasMouseOverHandlers
- Parameters:
handler
- the mouse over handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseUpHandler
public HandlerRegistration addMouseUpHandler(MouseUpHandler handler)
Description copied from interface:HasMouseUpHandlers
Adds aMouseUpEvent
handler.- Specified by:
addMouseUpHandler
in interfaceHasMouseUpHandlers
- Parameters:
handler
- the mouse up handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseWheelHandler
public HandlerRegistration addMouseWheelHandler(MouseWheelHandler handler)
Description copied from interface:HasMouseWheelHandlers
Adds aMouseWheelEvent
handler.- Specified by:
addMouseWheelHandler
in interfaceHasMouseWheelHandlers
- Parameters:
handler
- the mouse wheel handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseWheelListener
@Deprecated public void addMouseWheelListener(MouseWheelListener listener)
Deprecated.
-
addTouchCancelHandler
public HandlerRegistration addTouchCancelHandler(TouchCancelHandler handler)
Description copied from interface:HasTouchCancelHandlers
Adds aTouchCancelEvent
handler.- Specified by:
addTouchCancelHandler
in interfaceHasTouchCancelHandlers
- Parameters:
handler
- the touch cancel handler- Returns:
HandlerRegistration
used to remove this handler
-
addTouchEndHandler
public HandlerRegistration addTouchEndHandler(TouchEndHandler handler)
Description copied from interface:HasTouchEndHandlers
Adds aTouchEndEvent
handler.- Specified by:
addTouchEndHandler
in interfaceHasTouchEndHandlers
- Parameters:
handler
- the touch end handler- Returns:
HandlerRegistration
used to remove this handler
-
addTouchMoveHandler
public HandlerRegistration addTouchMoveHandler(TouchMoveHandler handler)
Description copied from interface:HasTouchMoveHandlers
Adds aTouchMoveEvent
handler.- Specified by:
addTouchMoveHandler
in interfaceHasTouchMoveHandlers
- Parameters:
handler
- the touch move handler- Returns:
HandlerRegistration
used to remove this handler
-
addTouchStartHandler
public HandlerRegistration addTouchStartHandler(TouchStartHandler handler)
Description copied from interface:HasTouchStartHandlers
Adds aTouchStartEvent
handler.- Specified by:
addTouchStartHandler
in interfaceHasTouchStartHandlers
- Parameters:
handler
- the touch start handler- Returns:
HandlerRegistration
used to remove this handler
-
getAltText
public java.lang.String getAltText()
Gets the alternate text for the image.- Returns:
- the alternate text for the image
-
getHeight
public int getHeight()
Gets the height of the image. When the image is in the unclipped state, the height of the image is not known until the image has been loaded (i.e. load event has been fired for the image).- Returns:
- the height of the image, or 0 if the height is unknown
-
getOriginLeft
public int getOriginLeft()
Gets the horizontal co-ordinate of the upper-left vertex of the image's visibility rectangle. If the image is in the unclipped state, then the visibility rectangle is assumed to be the rectangle which encompasses the entire image, which has an upper-left vertex of (0,0).- Returns:
- the horizontal co-ordinate of the upper-left vertex of the image's visibility rectangle
-
getOriginTop
public int getOriginTop()
Gets the vertical co-ordinate of the upper-left vertex of the image's visibility rectangle. If the image is in the unclipped state, then the visibility rectangle is assumed to be the rectangle which encompasses the entire image, which has an upper-left vertex of (0,0).- Returns:
- the vertical co-ordinate of the upper-left vertex of the image's visibility rectangle
-
getUrl
public java.lang.String getUrl()
Gets the URL of the image. The URL that is returned is not necessarily the URL that was passed in by the user. It may have been transformed to an absolute URL.- Returns:
- the image URL
-
getWidth
public int getWidth()
Gets the width of the image. When the image is in the unclipped state, the width of the image is not known until the image has been loaded (i.e. load event has been fired for the image).- Returns:
- the width of the image, or 0 if the width is unknown
-
onBrowserEvent
public void onBrowserEvent(Event event)
Description copied from interface:EventListener
Fired whenever a browser event is received.- Specified by:
onBrowserEvent
in interfaceEventListener
- Overrides:
onBrowserEvent
in classWidget
- Parameters:
event
- the event received
-
removeClickListener
@Deprecated public void removeClickListener(ClickListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned byaddClickHandler(com.google.gwt.event.dom.client.ClickHandler)
insteadDescription copied from interface:SourcesClickEvents
Removes a previously added listener interface.- Specified by:
removeClickListener
in interfaceSourcesClickEvents
- Parameters:
listener
- the listener interface to remove
-
removeLoadListener
@Deprecated public void removeLoadListener(LoadListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadDescription copied from interface:SourcesLoadEvents
Removes a previously added listener interface.- Specified by:
removeLoadListener
in interfaceSourcesLoadEvents
- Parameters:
listener
- the listener interface to remove
-
removeMouseListener
@Deprecated public void removeMouseListener(MouseListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadDescription copied from interface:SourcesMouseEvents
Removes a previously added listener interface.- Specified by:
removeMouseListener
in interfaceSourcesMouseEvents
- Parameters:
listener
- the listener interface to remove
-
removeMouseWheelListener
@Deprecated public void removeMouseWheelListener(MouseWheelListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned byaddMouseWheelHandler(com.google.gwt.event.dom.client.MouseWheelHandler)
instead
-
setAltText
public void setAltText(java.lang.String altText)
Sets the alternate text of the image for user agents that can't render the image.- Parameters:
altText
- the alternate text to set to
-
setResource
public void setResource(ImageResource resource)
Sets the url and the visibility rectangle for the image at the same time, based on an ImageResource instance. A single load event will be fired if either the incoming url or visiblity rectangle co-ordinates differ from the image's current url or current visibility rectangle co-ordinates. If the image is currently in the unclipped state, a call to this method will cause a transition to the clipped state.- Parameters:
resource
- the ImageResource to display
-
setUrl
public void setUrl(SafeUri url)
Sets the URL of the image to be displayed. If the image is in the clipped state, a call to this method will cause a transition of the image to the unclipped state. Regardless of whether or not the image is in the clipped or unclipped state, a load event will be fired.- Parameters:
url
- the image URL
-
setUrl
public void setUrl(java.lang.String url)
Sets the URL of the image to be displayed. If the image is in the clipped state, a call to this method will cause a transition of the image to the unclipped state. Regardless of whether or not the image is in the clipped or unclipped state, a load event will be fired.- Parameters:
url
- the image URL
-
setUrlAndVisibleRect
public void setUrlAndVisibleRect(SafeUri url, int left, int top, int width, int height)
Sets the url and the visibility rectangle for the image at the same time. A single load event will be fired if either the incoming url or visiblity rectangle co-ordinates differ from the image's current url or current visibility rectangle co-ordinates. If the image is currently in the unclipped state, a call to this method will cause a transition to the clipped state.- Parameters:
url
- the image URLleft
- the horizontal coordinate of the upper-left vertex of the visibility rectangletop
- the vertical coordinate of the upper-left vertex of the visibility rectanglewidth
- the width of the visibility rectangleheight
- the height of the visibility rectangle
-
setUrlAndVisibleRect
public void setUrlAndVisibleRect(java.lang.String url, int left, int top, int width, int height)
Sets the url and the visibility rectangle for the image at the same time. A single load event will be fired if either the incoming url or visiblity rectangle co-ordinates differ from the image's current url or current visibility rectangle co-ordinates. If the image is currently in the unclipped state, a call to this method will cause a transition to the clipped state.- Parameters:
url
- the image URLleft
- the horizontal coordinate of the upper-left vertex of the visibility rectangletop
- the vertical coordinate of the upper-left vertex of the visibility rectanglewidth
- the width of the visibility rectangleheight
- the height of the visibility rectangle
-
setVisibleRect
public void setVisibleRect(int left, int top, int width, int height)
Sets the visibility rectangle of an image. The visibility rectangle is declared relative to the rectangle which encompasses the entire image, which has an upper-left vertex of (0,0). Provided that any of the left, top, width, and height parameters are different than the those values that are currently set for the image, a load event will be fired. If the image is in the unclipped state, a call to this method will cause a transition of the image to the clipped state. This transition will cause a load event to fire.- Parameters:
left
- the horizontal coordinate of the upper-left vertex of the visibility rectangletop
- the vertical coordinate of the upper-left vertex of the visibility rectanglewidth
- the width of the visibility rectangleheight
- the height of the visibility rectangle
-
-