com.vaadin.ui.renderers

Class NumberRenderer

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

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

com.vaadin.ui.renderers.NumberRenderer

All Implemented Interfaces:

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

public class NumberRenderer
extends AbstractRenderer<Object,Number>

A renderer for presenting number values.

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
NumberRenderer() Creates a new number renderer.
NumberRenderer(Locale locale) Creates a new number renderer.
NumberRenderer(NumberFormat numberFormat) Creates a new number renderer.
NumberRenderer(NumberFormat numberFormat, String nullRepresentation) Creates a new number renderer.
NumberRenderer(String formatString) Creates a new number renderer.
NumberRenderer(String formatString, Locale locale) Creates a new number renderer.
NumberRenderer(String formatString, Locale locale, String nullRepresentation) Creates a new number renderer.

Method Summary

Modifier and Type	Method and Description
JsonValue	encode(Number value) Encodes the given value into a JsonValue.
String	getNullRepresentation() Null representation for the renderer.
protected NumberRendererState	getState() Returns the shared state for this connector.
protected NumberRendererState	getState(boolean markAsDirty) Returns the shared state for this connector.
String	toString()

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

NumberRenderer

public NumberRenderer()

Creates a new number renderer.

The renderer is configured to render with the number's natural string representation in the default locale.

NumberRenderer

public NumberRenderer(NumberFormat numberFormat)

Creates a new number renderer.

The renderer is configured to render the number as defined with the given number format.

Parameters:

numberFormat - the number format with which to display numbers

Throws:

IllegalArgumentException - if numberFormat is null

NumberRenderer

public NumberRenderer(NumberFormat numberFormat,
                      String nullRepresentation)
               throws IllegalArgumentException

Creates a new number renderer.

The renderer is configured to render the number as defined with the given number format.

Parameters:

numberFormat - the number format with which to display numbers

nullRepresentation - the textual representation of null value

Throws:

IllegalArgumentException - if numberFormat is null

NumberRenderer

public NumberRenderer(Locale locale)
               throws IllegalArgumentException

Creates a new number renderer.

The renderer is configured to render with the number's natural string representation in the given locale.

Parameters:

locale - the locale in which to display numbers

Throws:

IllegalArgumentException - if locale is null

NumberRenderer

public NumberRenderer(String formatString,
                      Locale locale)
               throws IllegalArgumentException

Creates a new number renderer.

The renderer is configured to render with the number's natural string representation in the given locale.

Parameters:

formatString - the format string with which to format the number

locale - the locale in which to display numbers

Throws:

IllegalArgumentException - if locale is null

NumberRenderer

public NumberRenderer(String formatString)
               throws IllegalArgumentException

Creates a new number renderer.

The renderer is configured to render with the given format string in the default locale.

Parameters:

formatString - the format string with which to format the number

Throws:

IllegalArgumentException - if formatString is null

See Also:

Format String Syntax

NumberRenderer

public NumberRenderer(String formatString,
                      Locale locale,
                      String nullRepresentation)

Creates a new number renderer.

The renderer is configured to render with the given format string in the given locale.

Parameters:

formatString - the format string with which to format the number

locale - the locale in which to present numbers

Throws:

IllegalArgumentException - if either argument is null

See Also:

Format String Syntax

Method Detail

encode

public JsonValue encode(Number value)

Description copied from interface: Renderer

Encodes the given value into a JsonValue.

Specified by:

encode in interface Renderer<Number>

Overrides:

encode in class AbstractRenderer<Object,Number>

Parameters:

value - the value to encode

Returns:

a JSON representation of the given value

toString

public String toString()

Overrides:

toString in class Object

getNullRepresentation

public String getNullRepresentation()

Description copied from class: AbstractRenderer

Null representation for the renderer.

Overrides:

getNullRepresentation in class AbstractRenderer<Object,Number>

Returns:

a textual representation of null

getState

protected NumberRendererState 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,Number>

Returns:

The shared state for this connector. Never null.

getState

protected NumberRendererState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractRenderer<Object,Number>

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