org.zkoss.text

Interface DateFormatInfo

public interface DateFormatInfo

The format information for date/time. It is used with DateFormats.setLocalFormatInfo(org.zkoss.text.DateFormatInfo) to provide the format information for different styling and locales.

Since:

5.0.7

Author:

tomyeh

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDateFormat(int style, java.util.Locale locale) Return the date format of the given style and locale, or null if the default one shall be used.
java.lang.String	getDateTimeFormat(int dateStyle, int timeStyle, java.util.Locale locale) Return the date/time format of the given style and locale, or null if the default one shall be used.
java.lang.String	getTimeFormat(int style, java.util.Locale locale) Return the time format of the given style and locale, or null if the default one shall be used.

Method Detail

getDateFormat

java.lang.String getDateFormat(int style,
                             java.util.Locale locale)

Return the date format of the given style and locale, or null if the default one shall be used.

Parameters:

style - the giving formatting style (never null). For example, DateFormat.SHORT for "M/d/yy" in the US locale.

locale - the locale (never null).

getTimeFormat

java.lang.String getTimeFormat(int style,
                             java.util.Locale locale)

Return the time format of the given style and locale, or null if the default one shall be used.

Parameters:

style - the giving formatting style (never null). For example, DateFormat.SHORT for "h:mm a" in the US locale.

locale - the locale (never null).

getDateTimeFormat

java.lang.String getDateTimeFormat(int dateStyle,
                                 int timeStyle,
                                 java.util.Locale locale)

Return the date/time format of the given style and locale, or null if the default one shall be used.

Parameters:

dateStyle - the giving formatting style (never null). For example, DateFormat.SHORT for "M/d/yy" in the US locale.

timeStyle - the giving formatting style (never null). For example, DateFormat.SHORT for "h:mm a" in the US locale.

locale - the locale (never null).