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 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:
-
-
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
All Methods Modifier and Type Method and Description JsonValueencode(Number value)Encodes the given value into a
JsonValue.StringgetNullRepresentation()Null representation for the renderer.
protected NumberRendererStategetState()Returns the shared state for this connector.
protected NumberRendererStategetState(boolean markAsDirty)Returns the shared state for this connector.
StringtoString()-
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, 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
-
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 numbersThrows:
IllegalArgumentException- ifnumberFormatisnull
-
NumberRenderer
public NumberRenderer(NumberFormat numberFormat, String nullRepresentation) throws IllegalArgumentExceptionCreates 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 numbersnullRepresentation- the textual representation ofnullvalueThrows:
IllegalArgumentException- ifnumberFormatisnull
-
NumberRenderer
public NumberRenderer(Locale locale) throws IllegalArgumentExceptionCreates 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 numbersThrows:
IllegalArgumentException- iflocaleisnull
-
NumberRenderer
public NumberRenderer(String formatString, Locale locale) throws IllegalArgumentExceptionCreates 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 numberlocale- the locale in which to display numbersThrows:
IllegalArgumentException- iflocaleisnull
-
NumberRenderer
public NumberRenderer(String formatString) throws IllegalArgumentExceptionCreates 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 numberThrows:
IllegalArgumentException- ifformatStringisnullSee Also:
-
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 numberlocale- the locale in which to present numbersThrows:
IllegalArgumentException- if either argument isnullSee Also:
-
-
Method Detail
-
encode
public JsonValue encode(Number 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,Number>Returns:
a textual representation of
null
-
getState
protected NumberRendererState 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,Number>Returns:
The shared state for this connector. Never null.
-
getState
protected NumberRendererState getState(boolean markAsDirty)Description copied from class:
AbstractClientConnectorReturns the shared state for this connector.
Overrides:
getStatein classAbstractRenderer<Object,Number>Parameters:
markAsDirty- true if the connector should automatically be marked dirty, false otherwiseReturns:
The shared state for this connector. Never null.
See Also:
-
-