com.goldencode.p2j.ui.client.format

Class DateFormat.DateBuf

java.lang.Object

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

com.goldencode.p2j.ui.client.format.DateFormat.DateBuf

Enclosing class:

DateFormat

private class DateFormat.DateBuf
extends DisplayFormat.Presentation

Internal form of date data.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	edited The behavior changes after any editing was done.
private java.lang.StringBuilder	screenValue The screen value buffer
private static char	SPACE Special value for an empty digit place.

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

forFieldValue, presCursorPos, presInsertMode

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DateBuf() Constructs default presentation used for clear operation.
	DateBuf(date varDate) Constructs presentation initialized with given date.

Method Summary

Modifier and Type	Method and Description
private boolean	charIsDelimiter(char ch, int cursorPos) Test if a character at given position is a delimiter.
void	checkFormat() Checks format rules.
void	clear() Delete the screen value.
boolean	deleteBack() Erases one symbol before the cursor position.
boolean	deleteCurrent() Erases one symbol in the cursor position.
boolean	deleteRegion(int start, int end) Erases a region.
private java.lang.String	extractComponentText(java.lang.String screen, byte kind) Extract component text.
private int	extractDayOrMonth(java.lang.String screen, byte kind) Extract day or month component value as integer.
boolean	finishEdit() Indicates completion of an edit.
private void	initScreen(java.lang.StringBuilder sb, date varDate) Format a date for using in fill-in.
boolean	input(char ch) Inputs character.
boolean	isFixedFont() Determine if this format must use the DEFAULT-FIXED-FONT, if no font is specified.
boolean	isUnknown() Returns if the presentation currently represents the unknown value.
boolean	moveCursorBegin() Moves cursor to the beginning of the field.
boolean	moveCursorEnd() Moves cursor to the end of the field.
boolean	moveCursorLeft() Moves cursor one character to the left.
boolean	moveCursorRight() Moves cursor one character to the right.
private boolean	normalizeComponent(java.lang.String screen, int kind) Normalize component text: remove possible leading or trailing spaces and pad with leading zeroes.
private int	parseYear(java.lang.String yearSpec, java.util.List<ErrorManager.ErrorEntry> errors) Parse a string into a year.
private void	setAppendCharacter(char ch, int index) Set or append a character at given position.
private boolean	setCursor(int newPosition) Move cursor to the new position
private date	toDate(java.util.List<ErrorManager.ErrorEntry> errors) Returns the current presentation's value converted to date or just validates the format
private date	toDateNoDelimiters(java.lang.String screen, java.util.List<ErrorManager.ErrorEntry> errors) Parse a string to a date for formats with no delimiters.
java.lang.String	toScreenValue() Formats the data as a string that is ready for display.
java.lang.String	toScreenValue(boolean edit) Formats the data as a string that is ready for display.
void	toVar(BaseDataType var) Instantiates a variable that is equivalent to the presentation's internal representation.
ErrorManager.ErrorEntry[]	validateFormat() Validate representation according to format rules and return error message if there is an error.
private java.lang.String	yearNormalize(java.lang.String spec) Normalize the year component to use for display

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

activate, forFieldValue, getCursorPos, getInitialCursorPos, getInsertMode, getLastPos, isFixedNumeric, isLastCharEntered, isNegative, isOptionalLeftSign, setCursorPos, setInsertMode, setLastCharEntered

Methods inherited from class java.lang.Object

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

Field Detail

edited

private boolean edited

The behavior changes after any editing was done. This flag is raised after any input was done to the buffer

screenValue

private final java.lang.StringBuilder screenValue

The screen value buffer

SPACE

private static final char SPACE

Special value for an empty digit place.

See Also:

Constant Field Values

Constructor Detail

DateBuf

private DateBuf()

Constructs default presentation used for clear operation.

DateBuf

public DateBuf(date varDate)

Constructs presentation initialized with given date.

Parameters:

varDate - Initial value.

Method Detail

initScreen

private final void initScreen(java.lang.StringBuilder sb,
                              date varDate)

Format a date for using in fill-in.

Parameters:

sb - the buffer to initialize, must be initially empty

varDate - the object to format to the buffer

checkFormat

public void checkFormat()
                 throws DisplayFormatCheckException

Checks format rules. Method finishEdit() should be called before it.

Specified by:

checkFormat in class DisplayFormat.Presentation

Throws:

DisplayFormatCheckException - When data is incompatible with format

deleteBack

public boolean deleteBack()

Erases one symbol before the cursor position.

Specified by:

deleteBack in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

deleteCurrent

public boolean deleteCurrent()

Erases one symbol in the cursor position.

Specified by:

deleteCurrent in class DisplayFormat.Presentation

Returns:

true if delete operation completed successfully.

deleteRegion

public boolean deleteRegion(int start,
                            int end)

Erases a region.

Overrides:

deleteRegion in class DisplayFormat.Presentation

Parameters:

start - region start index inclusive

end - region end index exclusive

Returns:

true if something has changed

finishEdit

public boolean finishEdit()

Indicates completion of an edit. The presentation instance may fill some unfilled places.

Specified by:

finishEdit in class DisplayFormat.Presentation

Returns:

true if rendering is necessary.

input

public boolean input(char ch)

Inputs character. The result depends from the current insert mode.

Specified by:

input in class DisplayFormat.Presentation

Parameters:

ch - Input character

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

isFixedFont

public boolean isFixedFont()

Determine if this format must use the DEFAULT-FIXED-FONT, if no font is specified.

Specified by:

isFixedFont in class DisplayFormat.Presentation

Returns:

Always true.

isUnknown

public boolean isUnknown()

Returns if the presentation currently represents the unknown value. If any editing has occurred, then this will return false even if the editing is not complete.

Specified by:

isUnknown in class DisplayFormat.Presentation

Returns:

true if this is unknown.

moveCursorBegin

public boolean moveCursorBegin()

Moves cursor to the beginning of the field.

Specified by:

moveCursorBegin in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

moveCursorEnd

public boolean moveCursorEnd()

Moves cursor to the end of the field.

Specified by:

moveCursorEnd in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

moveCursorLeft

public boolean moveCursorLeft()

Moves cursor one character to the left.

Specified by:

moveCursorLeft in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

moveCursorRight

public boolean moveCursorRight()

Moves cursor one character to the right. Also updates insert mode.

Specified by:

moveCursorRight in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

toScreenValue

public java.lang.String toScreenValue()

Formats the data as a string that is ready for display.

Specified by:

toScreenValue in class DisplayFormat.Presentation

Returns:

The formatted string.

toScreenValue

public java.lang.String toScreenValue(boolean edit)

Formats the data as a string that is ready for display.

Overrides:

toScreenValue in class DisplayFormat.Presentation

Parameters:

edit - true if the screen value is being generated for interactive editing purposes.

Returns:

The formatted string.

toVar

public void toVar(BaseDataType var)

Instantiates a variable that is equivalent to the presentation's internal representation.

Specified by:

toVar in class DisplayFormat.Presentation

Parameters:

var - A variable which must be compatible with the format.

validateFormat

public ErrorManager.ErrorEntry[] validateFormat()

Validate representation according to format rules and return error message if there is an error.

Overrides:

validateFormat in class DisplayFormat.Presentation

Returns:

null if no error or error message if there is an error.

extractComponentText

private java.lang.String extractComponentText(java.lang.String screen,
                                              byte kind)

Extract component text. FIXME: use this method wherever possible

Parameters:

screen - the screen value

kind - the component type (DAY, MONTH or YEAR)

Returns:

see above

charIsDelimiter

private final boolean charIsDelimiter(char ch,
                                      int cursorPos)

Test if a character at given position is a delimiter.

Parameters:

ch - the character to test

cursorPos - the position

Returns:

true if the character value is one of allowed delimiter values, and equals to the formatting character at the same position

extractDayOrMonth

private int extractDayOrMonth(java.lang.String screen,
                              byte kind)

Extract day or month component value as integer. On error return 0 (which is invalid day or month value). If the format has delimiters, then the component is trimmed and parsed as a signed integer. Otherwise the component is not trimmed and parsed as unsigned integer.

Parameters:

screen - the screen value

kind - the day or month component type (DAY, MONTH)

Returns:

see above

normalizeComponent

private final boolean normalizeComponent(java.lang.String screen,
                                         int kind)

Normalize component text: remove possible leading or trailing spaces and pad with leading zeroes. FIXME: this method should works OK for day and month components, for years additional treatment may be required.

Parameters:

screen - current screen value to extract the unnormalized component text

kind - component type, one of DAY, MONTH or YEAR

Returns:

true if the screen value was changed

parseYear

private final int parseYear(java.lang.String yearSpec,
                            java.util.List<ErrorManager.ErrorEntry> errors)
                     throws ErrorConditionException

Parse a string into a year. For an empty argument string return the today's year value. Otherwise parse as an integer. Calculates numeric value of the year. Calculation can be described by the following algorithm:

If format separator isn't null then:

1. If the extreme right position holds '-' then it is discarded (e.g. -10- -> -10)
2. Remaining characters are parsed as a usual integer.

If format separator is null then:

1. Only the extreme left (before the space if it presents) digits are taken into account. If the first character is a space then the whole field content is ignored (e.g. 12_3 -> 12; _123 -> null)
2. If input consists of three digits then the last one is ignored (e.g. 123_ -> 12).
3. Remaining characters are parsed as a usual integer. If it cannot be parsed then the current year is used.

Parameters:

yearSpec - The input year specification, auto-completed.

errors - if not null, then this is an output list of error entries. The method adds errors to the list instead of throwing them

Returns:

The numeric value of the year or 0 if an error occurred.

Throws:

ErrorConditionException - If the input sequence does not represent a valid year.

setAppendCharacter

private void setAppendCharacter(char ch,
                                int index)

Set or append a character at given position.

Parameters:

ch - the character to set

index - the screen value index

setCursor

private final boolean setCursor(int newPosition)

Move cursor to the new position

Parameters:

newPosition - the new cursor position

Returns:

true if the cursor position was changed

toDate

private date toDate(java.util.List<ErrorManager.ErrorEntry> errors)
             throws ErrorConditionException

Returns the current presentation's value converted to date or just validates the format

Parameters:

errors - if not null, then this is an output list of error entries. The method adds errors to the list instead of throwing them

Returns:

The current presentation's value converted to date or null if the error list is not empty

Throws:

ErrorConditionException - Value doesn't represent a correct date.

toDateNoDelimiters

private date toDateNoDelimiters(java.lang.String screen,
                                java.util.List<ErrorManager.ErrorEntry> errors)

Parse a string to a date for formats with no delimiters. On return of this method either a successfully parsed date is returned, or in case of errors, the error list as updated with an error entry and null is returned.

Parameters:

screen - the screen value

errors - the errors to report

Returns:

see above

yearNormalize

private java.lang.String yearNormalize(java.lang.String spec)

Normalize the year component to use for display

Parameters:

spec - the year specification before normalization

Returns:

the component value normalized

clear

public void clear()

Delete the screen value.

Specified by:

clear in class DisplayFormat.Presentation