org.millstone.base.ui
Class DateField

java.lang.Object
  |
  +--org.millstone.base.ui.AbstractComponent
        |
        +--org.millstone.base.ui.AbstractField
              |
              +--org.millstone.base.ui.DateField

All Implemented Interfaces:

Buffered, BufferedValidatable, Component, java.util.EventListener, MethodEventSource, Paintable, Property, Property.Editor, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer, Validatable, VariableOwner

public class DateField

extends AbstractField

A date editor component that can be bound to any bindable Property. that is compatible with java.util.Date.

Since DateField extends AbstractField it implements the Buffered interface. A DateField is in write-through mode by default, so AbstractField.setWriteThrough(boolean) must be called to enable buffering.

Since:

3.0

Version:

3.0.3

Author:

IT Mill Ltd.

Nested Class Summary

Nested classes inherited from class org.millstone.base.ui.AbstractField

AbstractField.ReadOnlyStatusChangeEvent, AbstractField.ValueChangeEvent

Nested classes inherited from class org.millstone.base.data.Buffered

Buffered.SourceException

Nested classes inherited from class org.millstone.base.data.Property

Property.ConversionException, Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeEvent, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeEvent, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer

Nested classes inherited from class org.millstone.base.ui.Component

Component.Event, Component.Listener

Nested classes inherited from class org.millstone.base.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Field Summary

static int	RESOLUTION_DAY Resolution identifier: days.
static int	RESOLUTION_HOUR Resolution identifier: hours.
static int	RESOLUTION_MIN Resolution identifier: minutes.
static int	RESOLUTION_MONTH Resolution identifier: months.
static int	RESOLUTION_MSEC Resolution identifier: milliseconds
static int	RESOLUTION_SEC Resolution identifier: seconds.
static int	RESOLUTION_YEAR Resolution identifier: years.

Constructor Summary

DateField()
Constructs an empty DateField with no caption.

DateField(Property dataSource)
Constructs a new DateField that's bound to the specified Property and has no caption.

DateField(java.lang.String caption)
Constructs an empty DateField with caption.

DateField(java.lang.String caption, java.util.Date value)
Constructs a new DateField with the given caption and initial text contents.

DateField(java.lang.String caption, Property dataSource)
Constructs a new DateField that's bound to the specified Property and has the given caption String.

Method Summary

void	changeVariables(java.lang.Object source, java.util.Map variables) Called when one or more variables handled by the implementing class are changed.
int	getResolution() Returns the resolution.
java.lang.String	getTag() Gets the UIDL tag corresponding to the component.
java.lang.Class	getType() Returns the type of the Property.
void	paintContent(PaintTarget target) Paints any needed component-specific things to the given UIDL stream.
void	setPropertyDataSource(Property newDataSource) Set DateField datasource.
void	setResolution(int resolution) Sets the resolution of the DateField
void	setValue(java.lang.Object newValue) Set the value of the field.
java.lang.String	toString() Returns the value of the Property in human readable textual format.

Methods inherited from class org.millstone.base.ui.AbstractField

addListener, addListener, addValidator, commit, constructField, discard, fireReadOnlyStatusChange, fireValueChange, focus, getErrorMessage, getPropertyDataSource, getValidators, getValue, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isReadThrough, isValid, isWriteThrough, removeListener, removeListener, removeValidator, setInvalidAllowed, setInvalidCommitted, setReadOnly, setReadThrough, setWriteThrough, validate, valueChange

Methods inherited from class org.millstone.base.ui.AbstractComponent

addListener, addListener, addListener, addListener, attach, childRequestedRepaint, dependsOn, detach, fireComponentEvent, fireEvent, getApplication, getCaption, getComponentError, getDescription, getDirectDependencies, getIcon, getLocale, getParent, getStyle, getWindow, isEnabled, isImmediate, isVisible, paint, removeDirectDependency, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setDescription, setEnabled, setIcon, setImmediate, setLocale, setParent, setStyle, setVisible

Methods inherited from class java.lang.Object

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

Field Detail

RESOLUTION_MSEC

public static final int RESOLUTION_MSEC

Resolution identifier: milliseconds

See Also:

Constant Field Values

RESOLUTION_SEC

public static final int RESOLUTION_SEC

Resolution identifier: seconds.

See Also:

Constant Field Values

RESOLUTION_MIN

public static final int RESOLUTION_MIN

Resolution identifier: minutes.

See Also:

Constant Field Values

RESOLUTION_HOUR

public static final int RESOLUTION_HOUR

Resolution identifier: hours.

See Also:

Constant Field Values

RESOLUTION_DAY

public static final int RESOLUTION_DAY

Resolution identifier: days.

See Also:

Constant Field Values

RESOLUTION_MONTH

public static final int RESOLUTION_MONTH

Resolution identifier: months.

See Also:

Constant Field Values

RESOLUTION_YEAR

public static final int RESOLUTION_YEAR

Resolution identifier: years.

See Also:

Constant Field Values

Constructor Detail

DateField

public DateField()

Constructs an empty DateField with no caption.

DateField

public DateField(java.lang.String caption)

Constructs an empty DateField with caption.

Parameters:

caption - The caption of the datefield.

DateField

public DateField(java.lang.String caption,
                 Property dataSource)

Constructs a new DateField that's bound to the specified Property and has the given caption String.

Parameters:

caption - caption String for the editor

dataSource - the Property to be edited with this editor

DateField

public DateField(Property dataSource)
          throws java.lang.IllegalArgumentException

Constructs a new DateField that's bound to the specified Property and has no caption.

Parameters:

dataSource - the Property to be edited with this editor

DateField

public DateField(java.lang.String caption,
                 java.util.Date value)

Constructs a new DateField with the given caption and initial text contents. The editor constructed this way will not be bound to a Property unless Property.Viewer.setPropertyDataSource(Property) is called to bind it.

Parameters:

caption - caption String for the editor

Method Detail

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Description copied from class: AbstractComponent

Paints any needed component-specific things to the given UIDL stream. The more general AbstractComponent.paint(PaintTarget) method handles all general attributes common to all components, and it calls this method to paint any component-specific attributes to the UIDL stream.

Overrides:

paintContent in class AbstractField

Parameters:

target - target UIDL stream where the component should paint itself to

Throws:

PaintException - if the operation failed

getTag

public java.lang.String getTag()

Description copied from class: AbstractComponent

Gets the UIDL tag corresponding to the component.

Specified by:

getTag in class AbstractComponent

Returns:

component's UIDL tag as String

changeVariables

public void changeVariables(java.lang.Object source,
                            java.util.Map variables)

Description copied from interface: VariableOwner

Called when one or more variables handled by the implementing class are changed.

Specified by:

changeVariables in interface VariableOwner

Overrides:

changeVariables in class AbstractComponent

Parameters:

source - Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

variables - Mapping from variable names to new variable values

getType

public java.lang.Class getType()

Description copied from interface: Property

Returns the type of the Property. The methods getValue and setValue must be compatible with this type: one must be able to safely cast the value returned from getValue to the given type and pass any variable assignable to this type as an argument to setValue.

Specified by:

getType in interface Property

Specified by:

getType in class AbstractField

Returns:

type of the Property

toString

public java.lang.String toString()

Description copied from class: AbstractField

Returns the value of the Property in human readable textual format.

Specified by:

toString in interface Property

Overrides:

toString in class AbstractField

Returns:

String representation of the value stored in the Property

setValue

public void setValue(java.lang.Object newValue)
              throws Property.ReadOnlyException,
                     Property.ConversionException

Description copied from class: AbstractField

Set the value of the field.

Specified by:

setValue in interface Property

Overrides:

setValue in class AbstractField

Parameters:

newValue - New value of the field.

Property.ReadOnlyException

Property.ConversionException

setPropertyDataSource

public void setPropertyDataSource(Property newDataSource)

Set DateField datasource. Datasource type must assignable to Date.

Specified by:

setPropertyDataSource in interface Property.Viewer

Overrides:

setPropertyDataSource in class AbstractField

Parameters:

newDataSource - the new data source Property

See Also:

Property.Viewer.setPropertyDataSource(Property)

getResolution

public int getResolution()

Returns the resolution.

Returns:

int

setResolution

public void setResolution(int resolution)

Sets the resolution of the DateField

Parameters:

resolution - The resolution to set