com.vaadin.ui

Class Image

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractEmbedded

com.vaadin.ui.Image

All Implemented Interfaces:

ContextClickEvent.ContextClickNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, Serializable

public class Image
extends AbstractEmbedded

Component for embedding images.

Since:

7.0

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Field Summary

Fields

Modifier and Type	Field and Description
protected ImageServerRpc	rpc

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
Image() Creates a new empty Image.
Image(String caption) Creates a new empty Image with caption.
Image(String caption, Resource source) Creates a new Image whose contents is loaded from given resource.

Method Summary

Modifier and Type	Method and Description
Registration	addClickListener(MouseEvents.ClickListener listener) Add a click listener to the component.
protected ImageState	getState() Returns the shared state bean with information to be sent from the server to the client.
protected ImageState	getState(boolean markAsDirty) Returns the shared state for this connector.
void	removeClickListener(MouseEvents.ClickListener listener) Deprecated. As of 8.0, replaced by Registration.remove() in the registration object returned from #addClickListener(ClickListener).

Methods inherited from class com.vaadin.ui.AbstractEmbedded

getAlternateText, getCustomAttributes, getSource, readDesign, setAlternateText, setSource, writeDesign

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

addStyleNames, getUI, removeStyleNames, setStyleName

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Field Detail

rpc

protected ImageServerRpc rpc

Constructor Detail

Image

public Image()

Creates a new empty Image.

Image

public Image(String caption)

Creates a new empty Image with caption.

Parameters:

caption -

Image

public Image(String caption,
             Resource source)

Creates a new Image whose contents is loaded from given resource. The dimensions are assumed if possible. The type is guessed from resource.

Parameters:

caption -

source - the Source of the embedded object.

Method Detail

getState

protected ImageState getState()

Description copied from class: AbstractComponent

Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().

Overrides:

getState in class AbstractEmbedded

Returns:

updated component shared state

getState

protected ImageState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractEmbedded

Parameters:

markAsDirty - true if the connector should automatically be marked dirty, false otherwise

Returns:

The shared state for this connector. Never null.

See Also:

AbstractClientConnector.getState()

addClickListener

public Registration addClickListener(MouseEvents.ClickListener listener)

Add a click listener to the component. The listener is called whenever the user clicks inside the component. Depending on the content the event may be blocked and in that case no event is fired.

Parameters:

listener - The listener to add, not null

Returns:

a registration object for removing the listener

Since:

8.0

See Also:

Registration

removeClickListener

@Deprecated
public void removeClickListener(MouseEvents.ClickListener listener)

Deprecated. As of 8.0, replaced by Registration.remove() in the registration object returned from #addClickListener(ClickListener).

Remove a click listener from the component. The listener should earlier have been added using #addClickListener(ClickListener).

Parameters:

listener - The listener to remove