Last updated

API / geotoolkit / util / DateTimeFormat / DateTimeFormat

Class: DateTimeFormat

util.DateTimeFormat.DateTimeFormat

Defines a class for formatting date time

Hierarchy

Table of contents

Constructors
Methods
Css Properties
Name Type Description
formatstringDate time format
timezoneTimeZoneTime zone

Contents

Constructors

new DateTimeFormat(options)

new DateTimeFormat(options?)

Parameters

Name Type
Optional optionsOptions

Overrides

Format.constructor

Methods

clone

clone(): Format

All inheritors should implement copy constructor or provide custom implementation for this method

Returns

Format

clone

Inherited from

Format.clone


copyConstructor

Protected copyConstructor(src): DateTimeFormat

copy constructor

Parameters

Name Type Description
srcDateTimeFormatSource to copy from

Returns

DateTimeFormat

this

Overrides

Format.copyConstructor


format

format(number): string

Formats number to string

Parameters

Name Type Description
numbernumbernumber to be formatted

Returns

string

Overrides

Format.format


getClassName

getClassName(): string

Returns

string

Inherited from

Format.getClassName


getFormat

getFormat(): string

Returns

string


getProperties

getProperties(): Options

Gets all the properties pertaining to this object

Returns

Options

Overrides

Format.getProperties


getTimeZone

getTimeZone(): string

Returns

string


setProperties

setProperties(properties?): DateTimeFormat

Sets properties

Parameters

Name Type Description
Optional propertiesOptionsproperties pertaining to this object

Returns

DateTimeFormat

Overrides

Format.setProperties


getClassName

Static getClassName(): string

Returns

string

Inherited from

Format.getClassName


getInstance

Static getInstance(locale?): DateTimeFormat

Return instance of the number format

Parameters

Name Type Description
Optional localestringlocale of formatter. Locals are not supported for now.

Returns

DateTimeFormat

instance of the format