Package com.vaadin.ui.renderers

Class DateRenderer

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

com.vaadin.ui.Grid.AbstractGridExtension

com.vaadin.ui.Grid.AbstractRenderer<Date>

com.vaadin.ui.renderers.DateRenderer

All Implemented Interfaces:

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

public class DateRenderer
extends Grid.AbstractRenderer<Date>

A renderer for presenting date 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	Description
DateRenderer()	Creates a new date renderer.
DateRenderer(String formatString)	Creates a new date renderer.
DateRenderer(String formatString, String nullRepresentation)	Creates a new date renderer.
DateRenderer(String formatString, Locale locale)	Creates a new date renderer.
DateRenderer(String formatString, Locale locale, String nullRepresentation)	Creates a new date renderer.
DateRenderer(DateFormat dateFormat)	Creates a new date renderer.
DateRenderer(DateFormat dateFormat, String nullRepresentation)	Creates a new date renderer.
DateRenderer(Locale locale)	Creates a new date renderer.
DateRenderer(Locale locale, String nullRepresentation)	Creates a new date renderer.

Method Summary

Modifier and Type	Method	Description
JsonValue	encode(Date value)	Encodes the given value into a JsonValue.
String	getNullRepresentation()	Null representation for the renderer
String	toString()

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

encode, encodeValue, extend, getPresentationType, getSupportedParentType

Methods inherited from class com.vaadin.ui.Grid.AbstractGridExtension

addComponentToGrid, getColumn, getItemId, getParentGrid, refreshRow, remove, removeComponentFromGrid

Methods inherited from class com.vaadin.server.AbstractExtension

getParent, 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, getState, getState, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

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, getParent, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.ui.renderers.Renderer

remove, setParent

Constructor Detail

DateRenderer

public DateRenderer()

Creates a new date renderer.

The renderer is configured to render with the Date.toString() representation for the default locale.

DateRenderer

public DateRenderer(Locale locale)
             throws IllegalArgumentException

Creates a new date renderer.

The renderer is configured to render with the Date.toString() representation for the given locale.

Parameters:

locale - the locale in which to present dates

Throws:

IllegalArgumentException - if locale is null

DateRenderer

public DateRenderer(Locale locale,
                    String nullRepresentation)
             throws IllegalArgumentException

Creates a new date renderer.

The renderer is configured to render with the Date.toString() representation for the given locale.

Parameters:

locale - the locale in which to present dates

nullRepresentation - the textual representation of null value

Throws:

IllegalArgumentException - if locale is null

DateRenderer

public DateRenderer(String formatString)
             throws IllegalArgumentException

Creates a new date renderer.

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

Parameters:

formatString - the format string with which to format the date

Throws:

IllegalArgumentException - if formatString is null

See Also:

Format String Syntax

DateRenderer

public DateRenderer(String formatString,
                    String nullRepresentation)
             throws IllegalArgumentException

Creates a new date renderer.

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

Parameters:

formatString - the format string with which to format the date

nullRepresentation - the textual representation of null value

Throws:

IllegalArgumentException - if formatString is null

See Also:

Format String Syntax

DateRenderer

public DateRenderer(String formatString,
                    Locale locale)
             throws IllegalArgumentException

Creates a new date renderer.

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

Parameters:

formatString - the format string to format the date with

locale - the locale to use

Throws:

IllegalArgumentException - if either argument is null

See Also:

Format String Syntax

DateRenderer

public DateRenderer(String formatString,
                    Locale locale,
                    String nullRepresentation)
             throws IllegalArgumentException

Creates a new date renderer.

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

Parameters:

formatString - the format string to format the date with

locale - the locale to use

nullRepresentation - the textual representation of null value

Throws:

IllegalArgumentException - if either argument is null

See Also:

Format String Syntax

DateRenderer

public DateRenderer(DateFormat dateFormat)
             throws IllegalArgumentException

Creates a new date renderer.

The renderer is configured to render with he given date format.

Parameters:

dateFormat - the date format to use when rendering dates

Throws:

IllegalArgumentException - if dateFormat is null

DateRenderer

public DateRenderer(DateFormat dateFormat,
                    String nullRepresentation)
             throws IllegalArgumentException

Creates a new date renderer.

The renderer is configured to render with he given date format.

Parameters:

dateFormat - the date format to use when rendering dates

Throws:

IllegalArgumentException - if dateFormat is null

Method Detail

getNullRepresentation

public String getNullRepresentation()

Description copied from class: Grid.AbstractRenderer

Null representation for the renderer

Overrides:

getNullRepresentation in class Grid.AbstractRenderer<Date>

Returns:

a textual representation of null

encode

public JsonValue encode(Date value)

Description copied from interface: Renderer

Encodes the given value into a JsonValue.

Specified by:

encode in interface Renderer<Date>

Overrides:

encode in class Grid.AbstractRenderer<Date>

Parameters:

value - the value to encode

Returns:

a JSON representation of the given value

toString

public String toString()

Overrides:

toString in class Object