org.odftoolkit.simple.common.field
Class DateField

java.lang.Object
  org.odftoolkit.simple.Component
      org.odftoolkit.simple.common.field.Field
          org.odftoolkit.simple.common.field.DateField

public class DateField
extends Field

DateField displays a date, by default this is the current date.

Since:

0.5

Nested Class Summary

Nested classes/interfaces inherited from class org.odftoolkit.simple.common.field.Field

Field.FieldType

Method Summary

void	formatDate(String formatString) Set the format of this date field.
Field.FieldType	getFieldType() Return the type of this field.
TextDateElement	getOdfElement() Return an instance of TextDateElement which represents this feature.
void	setFixed(boolean isFixed) Set whether the date value of this field is fixed.

Methods inherited from class org.odftoolkit.simple.Component

getComponentByElement, getOwnerDocument, registerComponent, unregisterComponent

Methods inherited from class java.lang.Object

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

Method Detail

formatDate

public void formatDate(String formatString)

Set the format of this date field. Date format pattern is the same as SimpleDateFormat.

Parameters:

formatString - the format string of this date.

See Also:

SimpleDateFormat

setFixed

public void setFixed(boolean isFixed)

Set whether the date value of this field is fixed.

Parameters:

isFixed - if true, the date value shall be preserved, otherwise it may be replaced with a new value in future edits.

getOdfElement

public TextDateElement getOdfElement()

Return an instance of TextDateElement which represents this feature.

Specified by:

getOdfElement in class Component

Returns:

an instance of TextDateElement

getFieldType

public Field.FieldType getFieldType()

Description copied from class: Field

Return the type of this field.

Specified by:

getFieldType in class Field

Returns:

the type of this field.