Java Calendar Component v3.1
www.java-calendar.com

com.imagine.component.calendar
Interface CalendarComboBox


public interface CalendarComboBox

This is the calendar combobox you have to insert into your application.

To use this component you must get an instance of it by calling the method calendarFactory.createCalendarComboBox(java.util.Date).
In order to customize the look you must call the method getCalendarComponent() which will give you an instance of a CalendarComponent object and work with it.
To set the date you must call the method setDate() and to get the date you must call the method getDate().

See also howto.html file for further informations.


Field Summary
static CalendarProperty CLOSE_WHEN_DATE_SELECTED
          If true the combobox will be hidden when selecting a date with the mouse or with a key.
 
Method Summary
 java.lang.Boolean getBooleanCalendarComboBoxProperty(CalendarProperty calendarProperty)
          Get the value of the specified calendar property as a Boolean object.
 java.lang.Object getCalendarComboBoxProperty(CalendarProperty calendarProperty)
          Get the value of the specified calendar property.
 CalendarComponent getCalendarComponent()
          Get the calendarComponent associated.
 javax.swing.JComponent getComboBoxComponent()
          Get the comboBox component which can be added in the interface.
 java.util.Date getDate()
          Get the date.
 java.lang.String getDateFormat()
          Get the date format.
 void setCalendarComboBoxProperty(CalendarProperty calendarProperty, java.lang.Object value)
          Set the specified CalendarComboBox property to the specified value.
 void setDate(java.util.Date date)
          Set the date.
 void setDateFormat(java.lang.String dateFormat)
          Set the date format.
 

Field Detail

CLOSE_WHEN_DATE_SELECTED

public static final CalendarProperty CLOSE_WHEN_DATE_SELECTED
If true the combobox will be hidden when selecting a date with the mouse or with a key. The default value is true.

Method Detail

getCalendarComboBoxProperty

public java.lang.Object getCalendarComboBoxProperty(CalendarProperty calendarProperty)
Get the value of the specified calendar property.

Parameters:
calendarProperty - The property for which the value must be returned.
Returns:
The value for the specified property.

getBooleanCalendarComboBoxProperty

public java.lang.Boolean getBooleanCalendarComboBoxProperty(CalendarProperty calendarProperty)
Get the value of the specified calendar property as a Boolean object. This is an alias of the getCalendarComboBoxProperty 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.

setCalendarComboBoxProperty

public void setCalendarComboBoxProperty(CalendarProperty calendarProperty,
                                        java.lang.Object value)
                                 throws CalendarPropertyException
Set the specified CalendarComboBox property to the specified value. The value must be an instance of the class type defined by the specified calendar property.

Parameters:
calendarProperty - The property to be set.
value - The value to set for the specified property.
Throws:
CalendarPropertyException

getComboBoxComponent

public javax.swing.JComponent getComboBoxComponent()
Get the comboBox component which can be added in the interface.

Returns:
The comboBox component.

getCalendarComponent

public CalendarComponent getCalendarComponent()
Get the calendarComponent associated.

Returns:
The calendarComponent.

setDateFormat

public void setDateFormat(java.lang.String dateFormat)
Set the date format.

Parameters:
dateFormat - the date format to be set.

getDateFormat

public java.lang.String getDateFormat()
Get the date format.

Returns:
The date format.

getDate

public java.util.Date getDate()
Get the date.

Returns:
The date.

setDate

public void setDate(java.util.Date date)
Set the date.

Parameters:
date - The date.

Java Calendar Component v3.1
www.java-calendar.com