Constants' Group CalendarFieldIndex

Overview

Module

Use

Devguide

Index

Constants

Constants' Details

:: com :: sun :: star :: i18n ::

constants group CalendarFieldIndex

Description

Field indices to be passed to various XCalendar methods.

Field is writable only if marked both Get/Set.

ZONE_OFFSET and DST_OFFSET cooperate such that both values are added, for example, ZoneOffset=1*60 and DstOffset=1*60 results in a time difference of GMT+2. The calculation in minutes is GMT = LocalTime - ZoneOffset - DstOffset

With introduction of ZONE_OFFSET_SECOND_MILLIS and DST_OFFSET_SECOND_MILLIS the exact calculation in milliseconds is GMT = LocalTime - (ZoneOffset*60000 + ZoneOffsetMillis * sign(ZoneOffset)) - (DstOffset*60000 + DstOffsetMillis * sign(DstOffset))

Constants
AM_PM	Get AmPmValue.
DAY_OF_MONTH	Get/Set day of month [1-31].
DAY_OF_WEEK	Get day of week [0-6].
DAY_OF_YEAR	Get day of year.
DST_OFFSET	Get daylight saving time offset in minutes, e.g. [060..160]
HOUR	Get/Set hour [0-23].
MINUTE	Get/Set minute [0-59].
SECOND	Get/Set second [0-59].
MILLISECOND	Get/Set milliseconds [0-999].
WEEK_OF_MONTH	Get week of month.
WEEK_OF_YEAR	Get week of year.
YEAR	Get/Set year.
MONTH	Get/Set month [0-...].
ERA	Get/Set era, for example, 0:= Before Christ, 1:= After Christ.
ZONE_OFFSET	Get/Set time zone offset in minutes, e.g. [-1460..1460]
FIELD_COUNT	Total number of fields for < OOo 3.1
ZONE_OFFSET_SECOND_MILLIS	Get/Set additional offset in milliseconds that adds to the value of ZONE_OFFSET. This may be necessary to correctly interpret historical timezone data that consists of fractions of minutes, e.g. seconds. 1 minute == 60000 milliseconds. @ATTENTION! Though the field's type is signed 16-bit, the field value is treated as unsigned 16-bit to allow for values up to 60000 and expresses an absolute value that inherits its sign from the parent ZONE_OFFSET field.
DST_OFFSET_SECOND_MILLIS	Get additional offset in milliseconds that adds to the value of DST_OFFSET. This may be necessary to correctly interpret historical timezone data that consists of fractions of minutes, e.g. seconds. 1 minute == 60000 milliseconds. @ATTENTION! Though the field's type is signed 16-bit, the field value is treated as unsigned 16-bit to allow for values up to 60000 and expresses an absolute value that inherits its sign from the parent DST_OFFSET field.
FIELD_COUNT2	Total number of fields as of OOo 3.1

Constants' Details

AM_PM

const short AM_PM = 0; Description Get AmPmValue.

DAY_OF_MONTH

const short DAY_OF_MONTH = 1; Description Get/Set day of month [1-31].

DAY_OF_WEEK

const short DAY_OF_WEEK = 2; Description Get day of week [0-6].

DAY_OF_YEAR

const short DAY_OF_YEAR = 3; Description Get day of year.

DST_OFFSET

const short DST_OFFSET = 4; Description Get daylight saving time offset in minutes, e.g. [060..160] The DST offset value depends on the actual date set at the calendar and is determined according to the timezone rules of the locale used with the calendar. Note that there is a bug in OpenOffice.org 1.0 / StarOffice 6.0 that prevents interpreting this value correctly.

HOUR

const short HOUR = 5; Description Get/Set hour [0-23].

MINUTE

const short MINUTE = 6; Description Get/Set minute [0-59].

SECOND

const short SECOND = 7; Description Get/Set second [0-59].

MILLISECOND

const short MILLISECOND = 8; Description Get/Set milliseconds [0-999].

WEEK_OF_MONTH

const short WEEK_OF_MONTH = 9; Description Get week of month.

WEEK_OF_YEAR

const short WEEK_OF_YEAR = 10; Description Get week of year.

YEAR

const short YEAR = 11; Description Get/Set year.

MONTH

const short MONTH = 12; Description Get/Set month [0-...]. Note that the maximum value is not necessarily 11 for December but depends on the calendar used instead.

ERA

const short ERA = 13; Description Get/Set era, for example, 0:= Before Christ, 1:= After Christ.

ZONE_OFFSET

const short ZONE_OFFSET = 14; Description Get/Set time zone offset in minutes, e.g. [-1460..1460]

FIELD_COUNT

const short FIELD_COUNT = 15; Description Total number of fields for < OOo 3.1

ZONE_OFFSET_SECOND_MILLIS

const short ZONE_OFFSET_SECOND_MILLIS = 15; Description Get/Set additional offset in milliseconds that adds to the value of ZONE_OFFSET. This may be necessary to correctly interpret historical timezone data that consists of fractions of minutes, e.g. seconds. 1 minute == 60000 milliseconds. @ATTENTION! Though the field's type is signed 16-bit, the field value is treated as unsigned 16-bit to allow for values up to 60000 and expresses an absolute value that inherits its sign from the parent ZONE_OFFSET field. Since OOo 3.1

DST_OFFSET_SECOND_MILLIS

const short DST_OFFSET_SECOND_MILLIS = 16; Description Get additional offset in milliseconds that adds to the value of DST_OFFSET. This may be necessary to correctly interpret historical timezone data that consists of fractions of minutes, e.g. seconds. 1 minute == 60000 milliseconds. @ATTENTION! Though the field's type is signed 16-bit, the field value is treated as unsigned 16-bit to allow for values up to 60000 and expresses an absolute value that inherits its sign from the parent DST_OFFSET field. Since OOo 3.1

FIELD_COUNT2

const short FIELD_COUNT2 = 17; Description Total number of fields as of OOo 3.1 Since OOo 3.1

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous