com.ontimize.gui.field.document

Class DateDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

com.ontimize.gui.field.document.DateDocument

All Implemented Interfaces:

Internationalization, Serializable, Document

Direct Known Subclasses:

AdvancedDateDocument, HourDateDocument

public class DateDocument
extends PlainDocument
implements Internationalization

This document implements the model for managing dates in a JTextField

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DateDocument.DateFormatCache
protected static class	DateDocument.DateFormatCacheKey

Nested classes/interfaces inherited from class javax.swing.text.AbstractDocument

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	currentDate
protected Timestamp	currentTimestamp
protected SimpleDateFormat	dateFormat
protected String	datePattern
static boolean	DEBUG
protected static Locale	defaultLocale
protected static SimpleDateFormat	dfConstructor
protected Date	insertedDate
protected Locale	locale

Fields inherited from class javax.swing.text.PlainDocument

lineLimitAttribute, tabSizeAttribute

Fields inherited from class javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

DEBUG_LANGUAGE

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Constructor Summary

Constructors

Constructor and Description
DateDocument()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildPattern()
void	format()
Date	getDate()
String	getDatePattern()
SimpleDateFormat	getFormat()
Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
Timestamp	getTimestampValue()
protected Timestamp	getTimestampValue(String date)
void	insertString(int offset, String sValue, AttributeSet attributes) Date pattern is known: - Non numeric characters are allowed.
protected void	insertStringWithoutCheck(int offset, String sValue, AttributeSet attributes)
boolean	isValid()
protected boolean	isValid(String date)
void	setComponentLocale(Locale l)
void	setDatePattern(String newPattern)
void	setResourceBundle(ResourceBundle resources) Sets the language resource bundle.
void	setValue(Date value)

Methods inherited from class javax.swing.text.PlainDocument

createDefaultRoot, getDefaultRootElement, getParagraphElement, insertUpdate, removeUpdate

Methods inherited from class javax.swing.text.AbstractDocument

addDocumentListener, addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeDocumentListener, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static boolean DEBUG

dfConstructor

protected static SimpleDateFormat dfConstructor

defaultLocale

protected static Locale defaultLocale

dateFormat

protected SimpleDateFormat dateFormat

datePattern

protected String datePattern

insertedDate

protected Date insertedDate

currentDate

protected Date currentDate

currentTimestamp

protected Timestamp currentTimestamp

locale

protected Locale locale

Constructor Detail

DateDocument

public DateDocument()

Method Detail

setValue

public void setValue(Date value)

getTimestampValue

public Timestamp getTimestampValue()

getFormat

public SimpleDateFormat getFormat()

format

public void format()

buildPattern

protected void buildPattern()

setDatePattern

public void setDatePattern(String newPattern)

getDatePattern

public String getDatePattern()

getDate

public Date getDate()

isValid

public boolean isValid()

getTimestampValue

protected Timestamp getTimestampValue(String date)

isValid

protected boolean isValid(String date)

insertString

public void insertString(int offset,
                String sValue,
                AttributeSet attributes)
                  throws BadLocationException

Date pattern is known:
- Non numeric characters are allowed.
- Year field has 4 characters (9999 maximum).
- Month and day fields have 2 characters. The maximum value for day is 31 and for month 12. An the minimum value for both is 1.
- When a value is introduced in field, this one is checked and text will be showed in red color until that the value is a correct date. Moreover, field value is also checked when field losts focus or ENTER key is pressed.
- Separator for dates is /. So a valid format date could be: 12/12/2008

Specified by:

insertString in interface Document

Overrides:

insertString in class PlainDocument

Throws:

BadLocationException

insertStringWithoutCheck

protected void insertStringWithoutCheck(int offset,
                            String sValue,
                            AttributeSet attributes)
                                 throws BadLocationException

Throws:

BadLocationException

getTextsToTranslate

public Vector getTextsToTranslate()

Description copied from interface: Internationalization

Returns all the texts in the element suitable for being translated.

Specified by:

getTextsToTranslate in interface Internationalization

Returns:

all the texts in the element suitable for being translated.

setResourceBundle

public void setResourceBundle(ResourceBundle resources)

Description copied from interface: Internationalization

Sets the language resource bundle. When the application changes the configured language, for all the objects that implement this interface this method must be called with the new file.
The method must translate all the elements that have texts in the GUI

Specified by:

setResourceBundle in interface Internationalization

Parameters:

resources - the new language bundle.

setComponentLocale

public void setComponentLocale(Locale l)

Specified by:

setComponentLocale in interface Internationalization