com.vaadin.ui.components.grid.renderers
Class DateRenderer

java.lang.Object
  com.vaadin.server.AbstractClientConnector
      com.vaadin.server.AbstractExtension
          com.vaadin.ui.components.grid.AbstractRenderer<java.util.Date>
              com.vaadin.ui.components.grid.renderers.DateRenderer

All Implemented Interfaces:

MethodEventSource, ClientConnector, Extension, com.vaadin.shared.Connector, Renderer<java.util.Date>, java.io.Serializable

public class DateRenderer
extends AbstractRenderer<java.util.Date>

A renderer for presenting date values.

Since:

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

DateRenderer()
Creates a new date renderer.

DateRenderer(java.text.DateFormat dateFormat)
Creates a new date renderer.

DateRenderer(java.util.Locale locale)
Creates a new date renderer.

DateRenderer(java.lang.String formatString)
Creates a new date renderer.

DateRenderer(java.lang.String formatString, java.util.Locale locale)
Creates a new date renderer.

Method Summary

protected java.lang.String	doEncode(java.util.Date value) Encodes the given value to an intermediate representation that can be serialized to JSON by Vaadin.
java.lang.String	toString()

Methods inherited from class com.vaadin.ui.components.grid.AbstractRenderer

encode, extend, getItemId, getPresentationType, getSupportedParentType

Methods inherited from class com.vaadin.server.AbstractExtension

getParent, 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, 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.ui.components.grid.Renderer

remove, setParent

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

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(java.util.Locale locale)
             throws java.lang.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:

java.lang.IllegalArgumentException - if locale is null

DateRenderer

public DateRenderer(java.lang.String formatString)
             throws java.lang.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:

java.lang.IllegalArgumentException - if formatString is null

See Also:

Format String Syntax

DateRenderer

public DateRenderer(java.lang.String formatString,
                    java.util.Locale locale)
             throws java.lang.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:

java.lang.IllegalArgumentException - if either argument is null

See Also:

Format String Syntax

DateRenderer

public DateRenderer(java.text.DateFormat dateFormat)
             throws java.lang.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:

java.lang.IllegalArgumentException - if dateFormat is null

Method Detail

doEncode

protected java.lang.String doEncode(java.util.Date value)

Description copied from class: AbstractRenderer

Encodes the given value to an intermediate representation that can be serialized to JSON by Vaadin. The default implementation simply returns the value as is.

This is a helper method intended to be overridden if the value must be processed somehow but doing the JSON serialization manually is not desired. For instance, a Renderer<Date> could return a formatted string from doEncode.

Overrides:

doEncode in class AbstractRenderer<java.util.Date>

Parameters:

value - the value to be encoded

Returns:

a value that can be serialized by Vaadin

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object