com.goldencode.p2j.ui.client.format

Class DatetimeFormat

java.lang.Object

com.goldencode.p2j.ui.client.format.DisplayFormat

com.goldencode.p2j.ui.client.format.DatetimeFormat

public class DatetimeFormat
extends DisplayFormat

Display format for datetime and datetime-tz variables.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DatetimeFormat.DatetimeBuf Internal form of datetime data.
private static class	DatetimeFormat.DatetimeComponent The simple structure which records what places are occupied in a screen value by the datetime component.

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.client.format.DisplayFormat

DisplayFormat.Presentation

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allQMark If a value cannot be correctly represented with current format a string of question marks will be used instead.
protected boolean	amPmUppercase
protected byte[]	dateCompOrder Order of date components for rendering.
protected byte[]	datetimeCompOrder Order of datetime(-tz) components for rendering.
protected boolean	drawSeparators Determines whether the separators will be drawn for the unknown value (applies to editing mode only).
protected DatetimeFormat.DatetimeComponent[]	fmtDatetimeComps How date components are positioned in rendered string.
protected boolean	fmtFullYear true for a 4-digit year.
protected char	fmtSeparator Date components separator.
private boolean	isDatetimeTz If set, SESSION:DISPLAY-TIMEZONE will be taken into consideration when displaying values if the format misses the timezone component.

Fields inherited from class com.goldencode.p2j.ui.client.format.DisplayFormat

editableSource, fmtScreenWidth

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DatetimeFormat(DatetimeFormat orig) Create a copy the original format.
private	DatetimeFormat(java.lang.String format, byte[] dateCompOrder, byte[] datetimeCompOrder, char fmtSeparator, boolean amPmUppercase, boolean drawSeparators, boolean fmtFullYear, boolean allQMark, boolean isDatetimeTz, int fmtScreenWidth, DatetimeFormat.DatetimeComponent[] fmtDatetimeComps) Private constructor.

Method Summary

Modifier and Type	Method and Description
DisplayFormat.Presentation	clear(DisplayFormat.Presentation pres) Returns a new presentation instance with a default initialized insert mode and cursor position.
DisplayFormat	duplicate() Duplicate this instance.
DisplayFormat.Presentation	fromVar(BaseDataType var) Initializes a presentation for variable's value.
boolean	isFormatCheck() Verify if this format needs explicit validation.
static DatetimeFormat	parse(java.lang.String pformat, boolean isDatetimeTz) Constructs a datetime format from the given Progress format string.
private static int	parseComponent(byte comp, char c, int fromIdx, java.lang.String fmt, int len, DatetimeFormat.DatetimeComponent[] fmtDatetimeComps) Parse one format component.
void	setDrawSeparators(boolean drawSeparators) Forces separators for the unknown datetime value to be drawn or not in the subsequent value rendering (applies to editing mode only).

Methods inherited from class com.goldencode.p2j.ui.client.format.DisplayFormat

clear, formatScreenValue, fromVar4FieldValue, generateQuestions, generateSpaces, genValueCannotBeDisplayedError, getFormatDef, getScreenWidth, instanceOfType, instanceOfType, instanceOfType, isCharInterface, isRightPositioning, isZapSupported, setCharInterface, setEditableSource

Methods inherited from class java.lang.Object

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

Field Detail

dateCompOrder

protected final byte[] dateCompOrder

Order of date components for rendering.

datetimeCompOrder

protected final byte[] datetimeCompOrder

Order of datetime(-tz) components for rendering.

fmtSeparator

protected final char fmtSeparator

Date components separator. In addition to date, there are some hardcoded time separator:

• T, t or one space that separates the date and time parts;
• colon that separates hours from minutes and minutes from seconds;
• dot that separates the seconds and milliseconds.
• + or - that prefixes the timezone components.

amPmUppercase

protected final boolean amPmUppercase

drawSeparators

protected boolean drawSeparators

Determines whether the separators will be drawn for the unknown value (applies to editing mode only).

fmtFullYear

protected final boolean fmtFullYear

true for a 4-digit year.

fmtDatetimeComps

protected final DatetimeFormat.DatetimeComponent[] fmtDatetimeComps

How date components are positioned in rendered string. This array is directly indexed by the component's code constants (DAY etc.).

allQMark

protected boolean allQMark

If a value cannot be correctly represented with current format a string of question marks will be used instead.

isDatetimeTz

private final boolean isDatetimeTz

If set, SESSION:DISPLAY-TIMEZONE will be taken into consideration when displaying values if the format misses the timezone component.

Constructor Detail

DatetimeFormat

protected DatetimeFormat(DatetimeFormat orig)

Create a copy the original format.

Parameters:

orig - The format to copy.

DatetimeFormat

private DatetimeFormat(java.lang.String format,
                       byte[] dateCompOrder,
                       byte[] datetimeCompOrder,
                       char fmtSeparator,
                       boolean amPmUppercase,
                       boolean drawSeparators,
                       boolean fmtFullYear,
                       boolean allQMark,
                       boolean isDatetimeTz,
                       int fmtScreenWidth,
                       DatetimeFormat.DatetimeComponent[] fmtDatetimeComps)

Private constructor. Use parse(String, boolean) to create instances of this class.

Parameters:

format - the format string

dateCompOrder - the indices of date components, an array of 3 bytes with values from 0 to 2

datetimeCompOrder - the indices of all datetime components, an array of 10 bytes

fmtSeparator - the character used to separate date components

amPmUppercase - true is the AL/PM component is defined and is in upper case characters

drawSeparators - draw separators flag

fmtFullYear - format includes a 4-digits year specification

allQMark - allQMark flag (???)

isDatetimeTz - formatting as datetime-tz (???)

fmtScreenWidth - the number of characters in formatted string

fmtDatetimeComps - all datetime components

Method Detail

duplicate

public DisplayFormat duplicate()

Duplicate this instance.

Specified by:

duplicate in class DisplayFormat

Returns:

See above.

parseComponent

private static final int parseComponent(byte comp,
                                        char c,
                                        int fromIdx,
                                        java.lang.String fmt,
                                        int len,
                                        DatetimeFormat.DatetimeComponent[] fmtDatetimeComps)

Parse one format component.

Parameters:

comp - the component id, e.g. HOURS, MINUTES

c - the placeholder character, like 'H'

fromIdx - the start index in the format string

fmt - the format string

len - the format string length

fmtDatetimeComps -

Returns:

the index to the next character in the format string.

parse

public static DatetimeFormat parse(java.lang.String pformat,
                                   boolean isDatetimeTz)
                            throws ErrorConditionException

Constructs a datetime format from the given Progress format string. If isDatetimeTz is set then when displaying the value of a datetime-tz it will take into consideration the SESSION:DISPLAY-TIMEZONE if timezone specifier is missing from format.

Parameters:

pformat - Progress format string.

isDatetimeTz - This format will be used with a datetimetz instance.

Throws:

ErrorConditionException - When passed format is not a valid datetime format.

isFormatCheck

public boolean isFormatCheck()

Verify if this format needs explicit validation.

Overrides:

isFormatCheck in class DisplayFormat

Returns:

always true.

clear

public DisplayFormat.Presentation clear(DisplayFormat.Presentation pres)

Returns a new presentation instance with a default initialized insert mode and cursor position.

Specified by:

clear in class DisplayFormat

Parameters:

pres - A Presentation instance which was constructed by this format. May be null. This presentation instance is not changed in this method.

Returns:

New presentation instance.

fromVar

public DisplayFormat.Presentation fromVar(BaseDataType var)
                                   throws DisplayFormatCheckException

Initializes a presentation for variable's value.

Specified by:

fromVar in class DisplayFormat

Parameters:

var - Variable which should be compatible with format.

Returns:

Data presentation

Throws:

DisplayFormatCheckException - Variable's value is incompatible with format.

setDrawSeparators

public void setDrawSeparators(boolean drawSeparators)

Forces separators for the unknown datetime value to be drawn or not in the subsequent value rendering (applies to editing mode only).

Parameters:

drawSeparators - If true then separators will be displayed for the unknown datetime value.