com.vaadin.ui.renderers

Class HtmlRenderer

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

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

com.vaadin.ui.renderers.HtmlRenderer

All Implemented Interfaces:

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

public class HtmlRenderer
extends AbstractRenderer<Object,String>

A renderer for presenting HTML content.

Since:

7.4

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
HtmlRenderer() Creates a new HTML renderer.
HtmlRenderer(String nullRepresentation) Creates a new HTML renderer.

Method Summary

Modifier and Type	Method and Description
String	getNullRepresentation() Null representation for the renderer.
protected HtmlRendererState	getState() Returns the shared state for this connector.
protected HtmlRendererState	getState(boolean markAsDirty) Returns the shared state for this connector.

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

encode, encode, extend, 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

HtmlRenderer

public HtmlRenderer(String nullRepresentation)

Creates a new HTML renderer.

Parameters:

nullRepresentation - the html representation of null value

HtmlRenderer

public HtmlRenderer()

Creates a new HTML renderer.

Method Detail

getNullRepresentation

public String getNullRepresentation()

Description copied from class: AbstractRenderer

Null representation for the renderer.

Overrides:

getNullRepresentation in class AbstractRenderer<Object,String>

Returns:

a textual representation of null

getState

protected HtmlRendererState 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,String>

Returns:

The shared state for this connector. Never null.

getState

protected HtmlRendererState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractRenderer<Object,String>

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