org.apache.pivot.wtk
Class CalendarButton

java.lang.Object
  extended by org.apache.pivot.wtk.Component
      extended by org.apache.pivot.wtk.Button
          extended by org.apache.pivot.wtk.CalendarButton
All Implemented Interfaces:
ConstrainedVisual, Visual

public class CalendarButton
extends Button

A component that allows a user to select a calendar date. The calendar is hidden until the user pushes the button.


Nested Class Summary
static interface CalendarButton.Skin
          CalendarButton skin interface.
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Button
Button.ButtonDataBindMapping, Button.DataRenderer, Button.SelectedBindMapping, Button.State, Button.StateBindMapping
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component
Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary
 
Field Summary
static String COUNTRY_KEY
           
static String LANGUAGE_KEY
           
static String VARIANT_KEY
           
 
Constructor Summary
CalendarButton()
           
CalendarButton(int year, int month)
           
 
Method Summary
 void clear()
          Clears any bound values in the component.
 void clearSelection()
          Clears the selection.
 ListenerList<CalendarButtonListener> getCalendarButtonListeners()
          Returns the calendar button listener list.
 ListenerList<CalendarButtonSelectionListener> getCalendarButtonSelectionListeners()
          Returns the calendar button selection listener list.
 Filter<CalendarDate> getDisabledDateFilter()
           
 Window getListPopup()
           
 Locale getLocale()
          Returns the locale used to present calendar data.
 int getMonth()
          Gets the month to which this calendar button is currently set.
 CalendarDate getSelectedDate()
          Returns the currently selected date.
 Calendar.SelectedDateBindMapping getSelectedDateBindMapping()
           
 BindType getSelectedDateBindType()
           
 String getSelectedDateKey()
          Gets the data binding key that is set on this calendar button.
 int getYear()
          Gets the year to which this calendar button is currently set.
 void load(Object context)
          Copies bound values from the bind context to the component.
 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 selected date.
 void setSelectedDate(String selectedDate)
          Sets the selected date to the date represented by the specified date string.
 void setSelectedDateBindMapping(Calendar.SelectedDateBindMapping bindMapping)
           
 void setSelectedDateBindType(BindType selectedDateBindType)
           
 void setSelectedDateKey(String selectedDateKey)
          Sets this calendar button's data binding key.
protected  void setSkin(Skin skin)
          Sets the skin, replacing any previous skin.
 void setToggleButton(boolean toggleButton)
          Sets the button's toggle state.
 void setYear(int year)
          Sets this calendar's year.
 void store(Object context)
          Copies bound values from the component to the bind context.
 
Methods inherited from class org.apache.pivot.wtk.Button
getAction, getButtonBindingListeners, getButtonData, getButtonDataBindMapping, getButtonDataBindType, getButtonDataKey, getButtonGroup, getButtonListeners, getButtonPressListeners, getButtonStateListeners, getDataRenderer, getSelectedBindMapping, getSelectedBindType, getSelectedKey, getState, getStateBindMapping, getStateBindType, getStateKey, isSelected, isToggleButton, isTriState, press, setAction, setAction, setButtonData, setButtonDataBindMapping, setButtonDataBindType, setButtonDataKey, setButtonGroup, setDataRenderer, setEnabled, setSelected, setSelectedBindMapping, setSelectedBindType, setSelectedKey, setState, setStateBindMapping, setStateBindType, setStateKey, setTriState
 
Methods inherited from class org.apache.pivot.wtk.Component
clearFocus, contains, getAncestor, getAncestor, getAttribute, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getComponentStyleListeners, getComponentTooltipListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getGraphics, getHeight, getHeightLimits, getLocation, getMaximumHeight, getMaximumWidth, getMenuHandler, getMinimumHeight, getMinimumWidth, getMouseLocation, getName, getNamedStyles, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getSize, getSkin, getStyles, getTooltipDelay, getTooltipText, getTooltipWrapText, getTypedStyles, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWidthLimits, getWindow, getX, getY, indexBoundsCheck, installSkin, invalidate, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyReleased, keyTyped, layout, mapPointFromAncestor, mapPointFromAncestor, mapPointToAncestor, mapPointToAncestor, mouseClick, mouseDown, mouseMove, mouseOut, mouseOver, mouseUp, mouseWheel, paint, reenterMouse, repaint, repaint, repaint, repaint, repaint, repaint, requestFocus, scrollAreaToVisible, scrollAreaToVisible, setAttribute, setAutomationID, setCursor, setDragSource, setDropTarget, setFocused, setHeight, setHeightLimits, setHeightLimits, setLocation, setLocation, setMaximumHeight, setMaximumWidth, setMenuHandler, setMinimumHeight, setMinimumWidth, setName, setParent, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSize, setStyleName, setStyleNames, setStyleNames, setStyles, setStyles, setTooltipDelay, setTooltipText, setTooltipWrapText, setVisible, setWidth, setWidthLimits, setWidthLimits, setX, setY, 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

CalendarButton

public CalendarButton()

CalendarButton

public CalendarButton(int year,
                      int month)
Method Detail

setSkin

protected void setSkin(Skin skin)
Description copied from class: Component
Sets the skin, replacing any previous skin.

Overrides:
setSkin in class Component
Parameters:
skin - The new skin.

getListPopup

public Window getListPopup()
Returns:
the popup window associated with this components skin

setToggleButton

public void setToggleButton(boolean toggleButton)
Description copied from class: Button
Sets the button's toggle state.

Overrides:
setToggleButton in class Button
Throws:
UnsupportedOperationException - This method is not supported by CalendarButton.

getYear

public int getYear()
Gets the year to which this calendar button 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 button is currently set.


setMonth

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


getSelectedDate

public CalendarDate getSelectedDate()
Returns the currently selected date.

Returns:
The currently selected date, or null if nothing is selected.

setSelectedDate

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

Parameters:
selectedDate - The date to select, or null to clear the 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 button.


setSelectedDateKey

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


getSelectedDateBindType

public BindType getSelectedDateBindType()

setSelectedDateBindType

public void setSelectedDateBindType(BindType selectedDateBindType)

getSelectedDateBindMapping

public Calendar.SelectedDateBindMapping getSelectedDateBindMapping()

setSelectedDateBindMapping

public void setSelectedDateBindMapping(Calendar.SelectedDateBindMapping bindMapping)

load

public void load(Object context)
Description copied from class: Component
Copies bound values from the bind context to the component. This functionality must be provided by the subclass; the base implementation is a no-op.

Overrides:
load in class Button

store

public void store(Object context)
Description copied from class: Component
Copies bound values from the component to the bind context. This functionality must be provided by the subclass; the base implementation is a no-op.

Overrides:
store in class Button

clear

public void clear()
Description copied from class: Component
Clears any bound values in the component.

Overrides:
clear in class Button

clearSelection

public void clearSelection()
Clears the selection.


getCalendarButtonListeners

public ListenerList<CalendarButtonListener> getCalendarButtonListeners()
Returns the calendar button listener list.


getCalendarButtonSelectionListeners

public ListenerList<CalendarButtonSelectionListener> getCalendarButtonSelectionListeners()
Returns the calendar button selection listener list.