We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.ui.renderers.
Class TextRenderer
- java.lang.Object
-
- com.vaadin.server.AbstractClientConnector
-
- com.vaadin.server.AbstractExtension
-
- com.vaadin.ui.renderers.AbstractRenderer<Object,Object>
-
- com.vaadin.ui.renderers.TextRenderer
-
All Implemented Interfaces:
MethodEventSource,ClientConnector,Extension,Connector,Renderer<Object>,Serializablepublic class TextRenderer extends AbstractRenderer<Object,Object>A renderer for presenting a plain text representation of any value.
Object.toString()is used for determining the text to show.Since:
7.4
Author:
Vaadin Ltd
See Also:
-
-
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 Description TextRenderer()Creates a new text renderer that uses
""to represent null values.TextRenderer(String nullRepresentation)Creates a new text renderer with the given string to represent null values.
-
Method Summary
All Methods Modifier and Type Method Description elemental.json.JsonValueencode(Object value)Encodes the given value into a
JsonValue.StringgetNullRepresentation()Null representation for the renderer.
protected TextRendererStategetState()Returns the shared state for this connector.
protected TextRendererStategetState(boolean markAsDirty)Returns the shared state for this connector.
-
Methods inherited from class com.vaadin.ui.renderers.AbstractRenderer
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, 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, 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.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
-
TextRenderer
public TextRenderer()Creates a new text renderer that uses
""to represent null values.
-
TextRenderer
public TextRenderer(String nullRepresentation)Creates a new text renderer with the given string to represent null values.
Parameters:
nullRepresentation- the textual representation ofnullvalue
-
-
Method Detail
-
encode
public elemental.json.JsonValue encode(Object value)Description copied from interface:
RendererEncodes the given value into a
JsonValue.
-
getNullRepresentation
public String getNullRepresentation()Description copied from class:
AbstractRendererNull representation for the renderer.
Overrides:
getNullRepresentationin classAbstractRenderer<Object,Object>Returns:
a textual representation of
null
-
getState
protected TextRendererState getState()Description copied from class:
AbstractClientConnectorReturns 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:
getStatein classAbstractRenderer<Object,Object>Returns:
The shared state for this connector. Never null.
-
getState
protected TextRendererState getState(boolean markAsDirty)Description copied from class:
AbstractClientConnectorReturns the shared state for this connector.
Overrides:
getStatein classAbstractRenderer<Object,Object>Parameters:
markAsDirty- true if the connector should automatically be marked dirty, false otherwiseReturns:
The shared state for this connector. Never null.
See Also:
-
-