Package com.vaadin.ui.renderers

Class ImageRenderer

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

com.vaadin.ui.Grid.AbstractGridExtension

com.vaadin.ui.Grid.AbstractRenderer<T>

com.vaadin.ui.renderers.ClickableRenderer<Resource>

com.vaadin.ui.renderers.ImageRenderer

All Implemented Interfaces:

MethodEventSource, ClientConnector, Extension, Connector, Renderer<Resource>, Serializable

public class ImageRenderer
extends ClickableRenderer<Resource>

A renderer for presenting images.

The image for each rendered cell is read from a Resource-typed property in the data source. Only ExternalResources and ThemeResources are currently supported.

Since:

7.4

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.renderers.ClickableRenderer

ClickableRenderer.RendererClickEvent, ClickableRenderer.RendererClickListener

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

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

Constructor Summary

Constructors

Constructor	Description
ImageRenderer()	Creates a new image renderer.
ImageRenderer(ClickableRenderer.RendererClickListener listener)	Creates a new image renderer and adds the given click listener to it.

Method Summary

Modifier and Type	Method	Description
JsonValue	encode(Resource resource)	Encodes the given value into a JsonValue.

Methods inherited from class com.vaadin.ui.renderers.ClickableRenderer

addClickListener, removeClickListener

Methods inherited from class com.vaadin.ui.Grid.AbstractRenderer

encode, encodeValue, extend, getNullRepresentation, getPresentationType, getSupportedParentType

Methods inherited from class com.vaadin.ui.Grid.AbstractGridExtension

addComponentToGrid, getColumn, getItemId, getParentGrid, refreshRow, remove, removeComponentFromGrid

Methods inherited from class com.vaadin.server.AbstractExtension

getParent, setParent

Methods inherited from class com.vaadin.server.AbstractClientConnector

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getParent, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.ui.renderers.Renderer

remove, setParent

Constructor Detail

ImageRenderer

public ImageRenderer()

Creates a new image renderer.

ImageRenderer

public ImageRenderer(ClickableRenderer.RendererClickListener listener)

Creates a new image renderer and adds the given click listener to it.

Parameters:

listener - the click listener to register

Method Detail

encode

public JsonValue encode(Resource resource)

Description copied from interface: Renderer

Encodes the given value into a JsonValue.

Specified by:

encode in interface Renderer<Resource>

Overrides:

encode in class Grid.AbstractRenderer<Resource>

Parameters:

resource - the value to encode

Returns:

a JSON representation of the given value