org.apache.pivot.wtk
Class Calendar

java.lang.Object
  extended by org.apache.pivot.wtk.Component
      extended by org.apache.pivot.wtk.Container
          extended by org.apache.pivot.wtk.Calendar
All Implemented Interfaces:
Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual

public class Calendar
extends Container

Component that allows the user to select a date.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component
Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence
Sequence.Tree<T>
 
Field Summary
static String COUNTRY_KEY
           
static String LANGUAGE_KEY
           
static String VARIANT_KEY
           
 
Constructor Summary
Calendar()
           
Calendar(int year, int month)
           
 
Method Summary
 void clear()
          If a bind key is set, clears the selected date.
 ListenerList<CalendarListener> getCalendarListeners()
          Returns the calendar listener list.
 ListenerList<CalendarSelectionListener> getCalendarSelectionListeners()
          Returns the calendar selection listener list.
 Filter<CalendarDate> getDisabledDateFilter()
           
 Locale getLocale()
          Returns the locale used to present calendar data.
 int getMonth()
          Gets the month to which this calendar is currently set.
 CalendarDate getSelectedDate()
          Gets the currently selected date, or null if no date is selected.
 String getSelectedDateKey()
          Gets the data binding key that is set on this calendar.
 int getYear()
          Gets the year to which this calendar is currently set.
 void load(Dictionary<String,?> context)
          Loads the selected date from the specified bind context using this date picker's bind key, if one is set.
 void setDisabledDateFilter(Filter<CalendarDate> disabledDateFilter)
           
 void setLocale(Dictionary<String,?> locale)
          Sets the locale used to present calendar data.
 void setLocale(Locale locale)
          Sets the locale used to present calendar data.
 void setLocale(String locale)
          Sets the locale used to present calendar data.
 void setMonth(int month)
          Sets this calendar's month.
 void setSelectedDate(CalendarDate selectedDate)
          Sets the currently selected date.
 void setSelectedDate(String selectedDate)
          Sets the selected date to the date represented by the specified date string.
 void setSelectedDateKey(String selectedDateKey)
          Sets this calendar's data binding key.
 void setYear(int year)
          Sets this calendar's year.
 void store(Dictionary<String,?> context)
          Stores the selected date into the specified bind context using this date picker's bind key, if one is set.
 
Methods inherited from class org.apache.pivot.wtk.Container
add, containsFocus, descendantAdded, descendantGainedFocus, descendantLostFocus, descendantRemoved, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getContextKey, getDescendantAt, getFocusTraversalPolicy, getLength, indexOf, insert, isAncestor, iterator, layout, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, remove, removeAll, requestFocus, setContextKey, setFocusTraversalPolicy, setParent, setVisible, transferFocus, update
 
Methods inherited from class org.apache.pivot.wtk.Component
clearFocus, getAttributes, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getGraphics, getHeight, getLocation, getMaximumPreferredHeight, getMaximumPreferredWidth, getMenuHandler, getMinimumPreferredHeight, getMinimumPreferredWidth, getParent, getPreferredHeight, getPreferredHeight, getPreferredHeightLimits, getPreferredSize, getPreferredWidth, getPreferredWidth, getPreferredWidthLimits, getSize, getSkin, getStyles, getTooltipText, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWindow, getX, getY, installThemeSkin, invalidate, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyReleased, keyTyped, load, mapPointFromAncestor, mapPointToAncestor, mouseOver, reenterMouse, repaint, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttributes, setAutomationID, setCursor, setCursor, setDragSource, setDropTarget, setEnabled, setHeight, setLocation, setLocation, setMaximumPreferredHeight, setMaximumPreferredWidth, setMenuHandler, setMinimumPreferredHeight, setMinimumPreferredWidth, setPreferredHeight, setPreferredHeightLimits, setPreferredHeightLimits, setPreferredSize, setPreferredSize, setPreferredWidth, setPreferredWidthLimits, setPreferredWidthLimits, setSize, setSize, setSkin, setStyles, setStyles, setStyles, setTooltipText, setWidth, setX, setY, store, toString, transferFocus, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LANGUAGE_KEY

public static final String LANGUAGE_KEY
See Also:
Constant Field Values

COUNTRY_KEY

public static final String COUNTRY_KEY
See Also:
Constant Field Values

VARIANT_KEY

public static final String VARIANT_KEY
See Also:
Constant Field Values
Constructor Detail

Calendar

public Calendar()

Calendar

public Calendar(int year,
                int month)
Method Detail

getYear

public int getYear()
Gets the year to which this calendar is currently set.


setYear

public void setYear(int year)
Sets this calendar's year.


getMonth

public int getMonth()
Gets the month to which this calendar is currently set.


setMonth

public void setMonth(int month)
Sets this calendar's month.


getSelectedDate

public CalendarDate getSelectedDate()
Gets the currently selected date, or null if no date is selected.


setSelectedDate

public void setSelectedDate(CalendarDate selectedDate)
Sets the currently selected date.

Parameters:
selectedDate - The selected date, or null to specify no selection

setSelectedDate

public final void setSelectedDate(String selectedDate)
Sets the selected date to the date represented by the specified date string. The date string must be in the ISO 8601 "calendar date" format, which is [YYYY]-[MM]-[DD].

Parameters:
selectedDate - A string in the form of [YYYY]-[MM]-[DD] (e.g. 2008-07-23)

getLocale

public Locale getLocale()
Returns the locale used to present calendar data.


setLocale

public void setLocale(Locale locale)
Sets the locale used to present calendar data.

Parameters:
locale -

setLocale

public void setLocale(Dictionary<String,?> locale)
Sets the locale used to present calendar data.

Parameters:
locale - An dictionary containing values for language, country, and variant. Country and variant are optional but the must adhere to the following rules:
  • If variant is specified, language and country are required;
  • Otherwise, if country is specified, language is required;
  • Otherwise, language is required.

setLocale

public void setLocale(String locale)
Sets the locale used to present calendar data.

Parameters:
locale - A JSON map containing values for language, country, and variant.
See Also:
setLocale(Dictionary)

getDisabledDateFilter

public Filter<CalendarDate> getDisabledDateFilter()

setDisabledDateFilter

public void setDisabledDateFilter(Filter<CalendarDate> disabledDateFilter)

getSelectedDateKey

public String getSelectedDateKey()
Gets the data binding key that is set on this calendar.


setSelectedDateKey

public void setSelectedDateKey(String selectedDateKey)
Sets this calendar's data binding key.


load

public void load(Dictionary<String,?> context)
Loads the selected date from the specified bind context using this date picker's bind key, if one is set.

Overrides:
load in class Container

store

public void store(Dictionary<String,?> context)
Stores the selected date into the specified bind context using this date picker's bind key, if one is set.

Overrides:
store in class Container

clear

public void clear()
If a bind key is set, clears the selected date.

Overrides:
clear in class Container

getCalendarListeners

public ListenerList<CalendarListener> getCalendarListeners()
Returns the calendar listener list.


getCalendarSelectionListeners

public ListenerList<CalendarSelectionListener> getCalendarSelectionListeners()
Returns the calendar selection listener list.