com.vaadin.ui.renderers

Class ComponentRenderer

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

com.vaadin.ui.renderers.AbstractRenderer<Object,Component>

com.vaadin.ui.renderers.ComponentRenderer

All Implemented Interfaces:

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

public class ComponentRenderer
extends AbstractRenderer<Object,Component>

A renderer for presenting Components.

Note: The use of ComponentRenderer causes the Grid to generate components for all items currently available in the client-side. This means that a number of components is always generated and sent to the client. Using complex structures of many nested components might be heavy to generate and store, which will lead to performance problems.

Note: Components will occasionally be generated again during runtime e.g. when selection changes. If your component has an internal state that is not stored into the object, you should reuse the same component instances.

Example of how to add a Label component to Grid:

 Grid grid;
 grid.addColumn(person -> new Label(person.getFullName()),
         new ComponentRenderer()).setCaption("Full Name");
 

Since:

8.1

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
ComponentRenderer() Constructor for ComponentRenderer.

Method Summary

Modifier and Type	Method and Description
JsonValue	encode(Component value) Encodes the given value into a JsonValue.
protected ComponentRendererState	getState() Returns the shared state for this connector.
protected ComponentRendererState	getState(boolean markAsDirty) Returns the shared state for this connector.

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

encode, extend, getNullRepresentation, getParent, getParentGrid, getPresentationType, getSupportedParentType

Methods inherited from class com.vaadin.server.AbstractExtension

remove, 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, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, 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.renderers.Renderer

remove, setParent

Methods inherited from interface com.vaadin.server.ClientConnector

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

ComponentRenderer

public ComponentRenderer()

Constructor for ComponentRenderer.

Method Detail

encode

public JsonValue encode(Component value)

Description copied from interface: Renderer

Encodes the given value into a JsonValue.

Specified by:

encode in interface Renderer<Component>

Overrides:

encode in class AbstractRenderer<Object,Component>

Parameters:

value - the value to encode

Returns:

a JSON representation of the given value

getState

protected ComponentRendererState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractRenderer<Object,Component>

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()

getState

protected ComponentRendererState getState()

Description copied from class: AbstractClientConnector

Returns the shared state for this connector. The shared state object is shared between the server connector and the client connector. Changes are only communicated from the server to the client and not in the other direction.

As a side effect, marks the connector dirty so any changes done to the state will be sent to the client. Use getState(false) to avoid marking the connector as dirty.

Overrides:

getState in class AbstractRenderer<Object,Component>

Returns:

The shared state for this connector. Never null.