Eclipse BIRT Report Object Model (ROM)

TimeFormatValue Structure

Structure Overview

Used to format a time value.

Details

Display Name: Time Format Value
Since: 2.2

Property Summary

category
Provides a list of pre-defined datetime formatter, Long Time, Medium Time, Short Time and Custom Time
locale
Locale of the formatter.
pattern
Pattern of the formatter.

Description

Provides a set of pre-defined time formatter, or user can define a customized formatter given a pattern.

Property Detail

category Property

Provides a list of pre-defined datetime formatter, Long Time, Medium Time, Short Time and Custom Time

Details

Type: choice (timeFormat)
Since: 2.2
Required: No
Display Name: Category
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Choices

NameDisplay Name ValueDescription
Unformatted Unformatted Unformatted
Long Time Long Time Long Time
Medium Time Medium Time Medium Time
Short Time Short Time Short Time
Custom Custom Custom

Description

Allow user to choose from a list of pre-defined datetime formatter. Use a certain formatter to convert a "time" typed value using the given formatter.


locale Property

Locale of the formatter.

Details

Type: locale
Since: 2.5
Required: No
Display Name: Locale
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

The locale of the time formatter.


pattern Property

Pattern of the formatter.

Details

Type: string
Since: 2.2
Required: No
Display Name: Pattern
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

Pattern of the time formatter.