com.imagine.component.calendar.skins
Interface CalendarSkin

public interface CalendarSkin

All the graphics properties (colors, fonts, images, etc) used by a CalendarComponent object are stored in the CalendarSkin.

Field Summary

static CalendarProperty	BACKGROUND_IMAGE
static CalendarProperty	CELL_FILL_COLOR
static CalendarProperty	CELL_FONT
static CalendarProperty	CELL_TEXT_COLOR
static CalendarProperty	DISABLED_COLOR
static CalendarProperty	EXTRA_MONTH_CELL_FONT
static CalendarProperty	EXTRA_MONTH_CELL_TEXT_COLOR
static CalendarProperty	GRID_COLOR
static CalendarProperty	HEADER_CELL_FILL_COLOR
static CalendarProperty	HEADER_CELL_FONT
static CalendarProperty	HEADER_CELL_TEXT_COLOR
static CalendarProperty	HOVERED_CELL_FILL_COLOR
static CalendarProperty	HOVERED_CELL_TEXT_COLOR
static CalendarProperty	SELECTED_CELL_FILL_COLOR
static CalendarProperty	SELECTED_CELL_TEXT_COLOR
static CalendarProperty	STATUS_PANEL_FILL_COLOR
static CalendarProperty	STATUS_PANEL_FONT
static CalendarProperty	STATUS_PANEL_HOVERED_TEXT_COLOR
static CalendarProperty	STATUS_PANEL_TEXT_COLOR
static CalendarProperty	TODAY_COLOR
static CalendarProperty	WEEK_CELL_FILL_COLOR
static CalendarProperty	WEEK_CELL_FONT
static CalendarProperty	WEEK_CELL_TEXT_COLOR
static CalendarProperty	WEEKEND_CELL_FONT
static CalendarProperty	WEEKEND_CELL_TEXT_COLOR

Method Summary

void	applyCalendarSkinStyle(CalendarSkinStyle calendarSkinStyle) Apply the specified style to this skin.
CalendarComponent	getCalendarComponent() Returns the calendarComponent associated.
CalendarSkinStyle	getCalendarSkinStyle() Returns the skin style associated.
java.awt.Color	getColorSkinProperty(CalendarProperty calendarProperty) Get the value of the specified skin property as a Color object.
java.awt.Font	getFontSkinProperty(CalendarProperty calendarProperty) Get the value of the specified property as a Font object.
java.awt.Image	getImageSkinProperty(CalendarProperty calendarProperty) Get the value of the specified property as an Image object.
java.lang.String	getName() Get the name of the skin.
java.lang.Object	getSkinProperty(CalendarProperty calendarProperty) Get the value of the specified skin property.
CalendarProperty[]	getSupportedCalendarSkinProperties() Get the list of properties suported.
boolean	isSkinPropertyObtainedDynamically(CalendarProperty calendarProperty) Returns true if the specified skin property is obtained dynamically by the call of getDynamicalCalendarSkinProperty(calendarSkin, calendarProperty) function from CalendarSkinStyle associated.
void	setName(java.lang.String name) Set the name of the skin.
void	setSkinProperty(CalendarProperty calendarProperty, java.lang.Object value) Set the specified skin property to the specified value.

Field Detail

CELL_TEXT_COLOR

public static final CalendarProperty CELL_TEXT_COLOR

CELL_FILL_COLOR

public static final CalendarProperty CELL_FILL_COLOR

EXTRA_MONTH_CELL_TEXT_COLOR

public static final CalendarProperty EXTRA_MONTH_CELL_TEXT_COLOR

WEEKEND_CELL_TEXT_COLOR

public static final CalendarProperty WEEKEND_CELL_TEXT_COLOR

TODAY_COLOR

public static final CalendarProperty TODAY_COLOR

DISABLED_COLOR

public static final CalendarProperty DISABLED_COLOR

GRID_COLOR

public static final CalendarProperty GRID_COLOR

SELECTED_CELL_TEXT_COLOR

public static final CalendarProperty SELECTED_CELL_TEXT_COLOR

SELECTED_CELL_FILL_COLOR

public static final CalendarProperty SELECTED_CELL_FILL_COLOR

WEEK_CELL_TEXT_COLOR

public static final CalendarProperty WEEK_CELL_TEXT_COLOR

WEEK_CELL_FILL_COLOR

public static final CalendarProperty WEEK_CELL_FILL_COLOR

HEADER_CELL_TEXT_COLOR

public static final CalendarProperty HEADER_CELL_TEXT_COLOR

HEADER_CELL_FILL_COLOR

public static final CalendarProperty HEADER_CELL_FILL_COLOR

HOVERED_CELL_TEXT_COLOR

public static final CalendarProperty HOVERED_CELL_TEXT_COLOR

HOVERED_CELL_FILL_COLOR

public static final CalendarProperty HOVERED_CELL_FILL_COLOR

STATUS_PANEL_FILL_COLOR

public static final CalendarProperty STATUS_PANEL_FILL_COLOR

STATUS_PANEL_TEXT_COLOR

public static final CalendarProperty STATUS_PANEL_TEXT_COLOR

STATUS_PANEL_HOVERED_TEXT_COLOR

public static final CalendarProperty STATUS_PANEL_HOVERED_TEXT_COLOR

CELL_FONT

public static final CalendarProperty CELL_FONT

WEEKEND_CELL_FONT

public static final CalendarProperty WEEKEND_CELL_FONT

EXTRA_MONTH_CELL_FONT

public static final CalendarProperty EXTRA_MONTH_CELL_FONT

WEEK_CELL_FONT

public static final CalendarProperty WEEK_CELL_FONT

HEADER_CELL_FONT

public static final CalendarProperty HEADER_CELL_FONT

STATUS_PANEL_FONT

public static final CalendarProperty STATUS_PANEL_FONT

BACKGROUND_IMAGE

public static final CalendarProperty BACKGROUND_IMAGE

Method Detail

isSkinPropertyObtainedDynamically

public boolean isSkinPropertyObtainedDynamically(CalendarProperty calendarProperty)

Returns true if the specified skin property is obtained dynamically by the call of getDynamicalCalendarSkinProperty(calendarSkin, calendarProperty) function from CalendarSkinStyle associated. Returns false otherwise.

Parameters:

calendarProperty - The property for which it is wanted to be determined whether it is dynamically obtained or not.

Returns:

true if the specified skin property is obtained dynamically by the call of getDynamicalCalendarSkinProperty(calendarSkin, calendarProperty) function from CalendarSkinStyle object associated; false otherwise.

getSkinProperty

public java.lang.Object getSkinProperty(CalendarProperty calendarProperty)

Get the value of the specified skin property.

Parameters:

calendarProperty - The property for which the value must be returned.

Returns:

The value for the specified skin property.

getColorSkinProperty

public java.awt.Color getColorSkinProperty(CalendarProperty calendarProperty)

Get the value of the specified skin property as a Color object. This is an alias of the getSkinProperty function and returns directly the type of this property without forcing the user to cast the return type to the proper type.

Parameters:

calendarProperty - The property for which the value must be returned.

Returns:

The value for the specified property.

getFontSkinProperty

public java.awt.Font getFontSkinProperty(CalendarProperty calendarProperty)

Get the value of the specified property as a Font object. This is an alias of the getSkinProperty function and returns directly the type of this property without forcing the user to cast the return type to the proper type.

Parameters:

calendarProperty - The property for which the value must be returned.

Returns:

The value for the specified property.

getImageSkinProperty

public java.awt.Image getImageSkinProperty(CalendarProperty calendarProperty)

Get the value of the specified property as an Image object. This is an alias of the getSkinProperty function and returns directly the type of this property without forcing the user to cast the return type to the proper type.

Parameters:

calendarProperty - The property for which the value must be returned.

Returns:

The value for the specified property.

setSkinProperty

public void setSkinProperty(CalendarProperty calendarProperty,
                            java.lang.Object value)
                     throws CalendarPropertyException

Set the specified skin property to the specified value. The value must be an instance of the class type defined by the specified property.

Parameters:

calendarProperty - The property to be set.

value - The value to set for the specified property.

Throws:

CalendarPropertyException

getSupportedCalendarSkinProperties

public CalendarProperty[] getSupportedCalendarSkinProperties()

Get the list of properties suported.

Returns:

The list of properties supported.

getName

public java.lang.String getName()

Get the name of the skin.

Returns:

The name of the skin.

setName

public void setName(java.lang.String name)

Set the name of the skin.

Parameters:

name - The name of the skin.

applyCalendarSkinStyle

public void applyCalendarSkinStyle(CalendarSkinStyle calendarSkinStyle)
                            throws CalendarPropertyException

Apply the specified style to this skin.

Parameters:

calendarSkinStyle - The style to be applied.

Throws:

CalendarPropertyException

getCalendarSkinStyle

public CalendarSkinStyle getCalendarSkinStyle()

Returns the skin style associated.

Returns:

The skin style associated.

getCalendarComponent

public CalendarComponent getCalendarComponent()

Returns the calendarComponent associated.

Returns:

the calendarComponent associated.