Package com.vaadin.ui.renderers

Class DateRenderer

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

com.vaadin.ui.renderers.AbstractRenderer<java.lang.Object,java.util.Date>

com.vaadin.ui.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.lang.Object,java.util.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(java.lang.String formatString)	Creates a new date renderer.
DateRenderer(java.lang.String formatString, java.lang.String nullRepresentation)	Creates a new date renderer.
DateRenderer(java.lang.String formatString, java.util.Locale locale)	Creates a new date renderer.
DateRenderer(java.lang.String formatString, java.util.Locale locale, java.lang.String nullRepresentation)	Creates a new date renderer.
DateRenderer(java.text.DateFormat dateFormat)	Creates a new date renderer.
DateRenderer(java.text.DateFormat dateFormat, java.lang.String nullRepresentation)	Creates a new date renderer.
DateRenderer(java.util.Locale locale)	Creates a new date renderer.
DateRenderer(java.util.Locale locale, java.lang.String nullRepresentation)	Creates a new date renderer.

Method Summary

Modifier and Type	Method	Description
elemental.json.JsonValue	encode(java.util.Date value)	Encodes the given value into a JsonValue.
java.lang.String	getNullRepresentation()	Null representation for the renderer.
protected com.vaadin.shared.ui.grid.renderers.DateRendererState	getState()	Returns the shared state for this connector.
protected com.vaadin.shared.ui.grid.renderers.DateRendererState	getState(boolean markAsDirty)	Returns the shared state for this connector.
java.lang.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, 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

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(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.util.Locale locale,
                    java.lang.String nullRepresentation)
             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

nullRepresentation - the textual representation of null value

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.lang.String nullRepresentation)
             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

nullRepresentation - the textual representation of null value

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.lang.String formatString,
                    java.util.Locale locale,
                    java.lang.String nullRepresentation)
             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

nullRepresentation - the textual representation of null value

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

DateRenderer

public DateRenderer(java.text.DateFormat dateFormat,
                    java.lang.String nullRepresentation)
             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

getNullRepresentation

public java.lang.String getNullRepresentation()

Description copied from class: AbstractRenderer

Null representation for the renderer.

Overrides:

getNullRepresentation in class AbstractRenderer<java.lang.Object,java.util.Date>

Returns:

a textual representation of null

encode

public elemental.json.JsonValue encode(java.util.Date value)

Description copied from interface: Renderer

Encodes the given value into a JsonValue.

Specified by:

encode in interface Renderer<java.util.Date>

Overrides:

encode in class AbstractRenderer<java.lang.Object,java.util.Date>

Parameters:

value - the value to encode

Returns:

a JSON representation of the given value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getState

protected com.vaadin.shared.ui.grid.renderers.DateRendererState 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<java.lang.Object,java.util.Date>

Returns:

The shared state for this connector. Never null.

getState

protected com.vaadin.shared.ui.grid.renderers.DateRendererState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractRenderer<java.lang.Object,java.util.Date>

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