mseries.Calendar
Interface MDateSelectorConstraints

All Known Implementing Classes:

MDefaultPullDownConstraints

public interface MDateSelectorConstraints

The calendar panel, popup and pull down is configured using a constraints object that implements this interface. Applications will probably build an immutable implementaion so that all instances appear and behave the same.

See Also:

MDefaultPullDownConstraints

Method Summary

Color	getBackground()
Color[]	getBackgrounds()
Dimension	getCellSize()
int	getChangerStyle()
int	getFirstDay()
Font	getFont()
Color	getForeground()
Color[]	getForegrounds()
String	getImageFile()
Color	getOutOfRangeBackground()
Color	getOutOfRangeForeground()
String	getPopupTitle()
ResourceBundle	getResourceBundle()
int	getSelectionClickCount()
SpecialDayModel	getSpecialDayModel()
Color	getTodayBackground()
Color	getTodayForeground()
boolean	hasShadow()
boolean	isChangerEditable()
boolean	isSelectionEventsEnabled()

Method Detail

getPopupTitle

String getPopupTitle()

Returns:

the title for the popup window

getResourceBundle

ResourceBundle getResourceBundle()

Returns:

the resource bundle for the localisation

getFirstDay

int getFirstDay()

Returns:

the index of the day that should be displayed first, use DAY constants from java.util.Calendar

See Also:

Calendar

getImageFile

String getImageFile()

Returns:

the full path name of the image file for the background

getForeground

Color getForeground()

Returns:

the default foreground

getBackground

Color getBackground()

Returns:

the default background

getTodayForeground

Color getTodayForeground()

Returns:

the colour of the current date foreground

getTodayBackground

Color getTodayBackground()

Returns:

the colour of the current date background, the background in only drawn when no image file has been set

getFont

Font getFont()

getForegrounds

Color[] getForegrounds()

Returns:

an array of colors, each not null value is the colour for the foreground for the day of the week represented by the index. 0 is Sunday, 6 is Saturday. Null entries will inherit the foreground given by getForeground()

getBackgrounds

Color[] getBackgrounds()

Returns:

an array of colors, each not null value is the colour for the background for the day of the week represented by the index. 0 is Sunday, 6 is Saturday. Null entries will inherit the background given by getBackground()

getChangerStyle

int getChangerStyle()

Returns:

the style of changer given by MDateChanger

isChangerEditable

boolean isChangerEditable()

Returns:

true if the changer can be edited by the keyboard (if appropriate). For now, only the Spinner can be edited.

getCellSize

Dimension getCellSize()

hasShadow

boolean hasShadow()

Returns:

true if the lightweight popup is to have a shadow. Heavyweights never have shadows. Heavyweights over lap their parents boundaries.

getSelectionClickCount

int getSelectionClickCount()

Returns:

the number of mouse clicks required to select a date in the calendar

isSelectionEventsEnabled

boolean isSelectionEventsEnabled()

Returns:

true if the selection in the calendar causes events to be fired.

Usually the date is echoed by catching the events, so the date in the textfield changes as the user moves through the calendar using the TAB and arrow keys. Switching the events off causes the textfield to remain unchanged until (perhaps) the clanedar is dismissed. A value of false makes the ESCAPE and RETURN/ENTER keys more effective for the pull down calendar. In this mode, ESC will cause the value in the date field to remain unchanged regardless of the setting in the calendar. RETURN/ENTER selects the value.

getSpecialDayModel

SpecialDayModel getSpecialDayModel()

Returns:

a model that can supply the colours representing Special Days

getOutOfRangeForeground

Color getOutOfRangeForeground()

Returns:

the foreground color for out of range cells

getOutOfRangeBackground

Color getOutOfRangeBackground()

Returns:

the background color for out of range cells