org.fujion.highcharts

Class DateTimeFormatOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.DateTimeFormatOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class DateTimeFormatOptions
extends Options

For a date/time axis, the scale will automatically adjust to the appropriate unit. This class gives the default string representations used for each unit.

 Supported format specifiers are:

 %a: Short weekday, like 'Mon'.
 %A: Long weekday, like 'Monday'.
 %d: Two digit day of the month, 01 to 31.
 %e: Day of the month, 1 through 31.
 %b: Short month, like 'Jan'.
 %B: Long month, like 'January'.
 %m: Two digit month number, 01 through 12.
 %y: Two digits year, like 09 for 2009.
 %Y: Four digits year, like 2009.
 %H: Two digits hours in 24h format, 00 through 23.
 %I: Two digits hours in 12h format, 00 through 11.
 %l  Hours in 12h format, 1 through 11. (Lower case L)
 %M: Two digits minutes, 00 through 59.
 %p: Upper case AM or PM.
 %P: Lower case AM or PM.
 %S: Two digits seconds, 00 through 59
 

Field Summary

Fields

Modifier and Type	Field and Description
String	day Axis defaults: "%e.
String	hour Axis defaults: "%H:%M" Tooltip defaults: "%A, %b %e, %H:%M"
String	millisecond Axis defaults: "%H:%M:%S.%L" Tooltip defaults: "%A, %b %e, %H:%M:%S.%L"
String	minute Axis defaults: "%H:%M" Tooltip defaults: "%A, %b %e, %H:%M"
String	month Axis defaults: "%b \'%y" Tooltip defaults: "%B %Y"
String	second Axis defaults: "%H:%M:%S" Tooltip defaults: "%A, %b %e, %H:%M:%S"
String	week Axis defaults: "%e.
String	year Axis defaults: "%Y" Tooltip defaults: "%Y"

Constructor Summary

Constructors

Constructor and Description
DateTimeFormatOptions()

Method Summary

Modifier and Type	Method and Description
void	setAllFormats(String value) Sets all formats to the specified value.
void	setDateFormats(String value) Sets all date formats to specified value.
void	setTimeFormats(String value) Sets all time formats to specified value.

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

millisecond

@Option
public String millisecond

Axis defaults: "%H:%M:%S.%L"
Tooltip defaults: "%A, %b %e, %H:%M:%S.%L"

second

@Option
public String second

Axis defaults: "%H:%M:%S"
Tooltip defaults: "%A, %b %e, %H:%M:%S"

minute

@Option
public String minute

Axis defaults: "%H:%M"
Tooltip defaults: "%A, %b %e, %H:%M"

hour

@Option
public String hour

Axis defaults: "%H:%M"
Tooltip defaults: "%A, %b %e, %H:%M"

day

@Option
public String day

Axis defaults: "%e. %b"
Tooltip defaults: "%A, %b %e, %Y"

week

@Option
public String week

Axis defaults: "%e. %b"
Tooltip defaults: "Week from %A, %b %e, %Y"

month

@Option
public String month

Axis defaults: "%b \'%y"
Tooltip defaults: "%B %Y"

year

@Option
public String year

Axis defaults: "%Y"
Tooltip defaults: "%Y"

Constructor Detail

DateTimeFormatOptions

public DateTimeFormatOptions()

Method Detail

setAllFormats

public void setAllFormats(String value)

Sets all formats to the specified value.

Parameters:

value - Format value.

setDateFormats

public void setDateFormats(String value)

Sets all date formats to specified value.

Parameters:

value - Date format value.

setTimeFormats

public void setTimeFormats(String value)

Sets all time formats to specified value.

Parameters:

value - Time format value.