com.vaadin.client.renderers

Class NumberRenderer

java.lang.Object

com.vaadin.client.renderers.NumberRenderer

All Implemented Interfaces:

Renderer<Number>

public class NumberRenderer
extends Object
implements Renderer<Number>

Renders a number into a cell using a specific NumberFormat. By default uses the default number format returned by NumberFormat.getDecimalFormat().

Since:

7.4

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor and Description
NumberRenderer() Constructs a renderer for presenting number data.
NumberRenderer(com.google.gwt.i18n.client.NumberFormat format) Constructs a renderer for presenting number data.

Method Summary

Modifier and Type	Method and Description
com.google.gwt.i18n.client.NumberFormat	getFormat() Gets the number format that the number should be formatted in.
void	render(RendererCellReference cell, Number number) Called whenever the Grid updates a cell.
void	setFormat(com.google.gwt.i18n.client.NumberFormat format) Sets the number format to use for formatting the number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NumberRenderer

public NumberRenderer()

Constructs a renderer for presenting number data.

NumberRenderer

public NumberRenderer(com.google.gwt.i18n.client.NumberFormat format)

Constructs a renderer for presenting number data.

Parameters:

format - the format to use when the number is displayed

Method Detail

getFormat

public com.google.gwt.i18n.client.NumberFormat getFormat()

Gets the number format that the number should be formatted in.

Returns:

the number format used to render the number

setFormat

public void setFormat(com.google.gwt.i18n.client.NumberFormat format)
               throws IllegalArgumentException

Sets the number format to use for formatting the number.

Parameters:

format - the format to use

Throws:

IllegalArgumentException - when the format is null

render

public void render(RendererCellReference cell,
                   Number number)

Description copied from interface: Renderer

Called whenever the Grid updates a cell.

For optimal performance, work done in this method should be kept to a minimum since it will be called continuously while the user is scrolling. It is recommended to set up the cell's DOM structure in ComplexRenderer.init(RendererCellReference) and only make incremental updates based on cell data in this method.

Specified by:

render in interface Renderer<Number>

Parameters:

cell - The cell. Note that the cell is a flyweight and should not be stored outside of the method as it will change.

number - The column data object