Package org.apache.pivot.wtk

Class 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.

    • 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

        @UnsupportedOperation
public void setToggleButton​(boolean toggleButton)
        Description copied from class: Button
        Sets the button's toggle state.
        Overrides:
        setToggleButton in class Button
        Parameters:
        toggleButton - Whether or not this should be a toggle button.
        Throws:
        java.lang.UnsupportedOperationException - This method is not supported by CalendarButton.

      • getYear

        public int getYear()
        Returns:
        The year to which this calendar button is currently set.

      • setYear

        public void setYear​(int year)
        Sets this calendar's year.
        Parameters:
        year - The new current year for this calendar button.

      • getMonth

        public int getMonth()
        Returns:
        The month to which this calendar button is currently set.

      • setMonth

        public void setMonth​(int month)
        Sets this calendar's month.
        Parameters:
        month - The new month value to set this calendar button to.

      • 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​(java.lang.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)
        Throws:
        java.lang.IllegalArgumentException - if the selected data value is null.

      • getLocale

        public java.util.Locale getLocale()
        Returns:
        The locale used to present calendar data.

      • setLocale

        public void setLocale​(java.util.Locale locale)
        Sets the locale used to present calendar data.
        Parameters:
        locale - The new locale used to format/present the data.
        Throws:
        java.lang.IllegalArgumentException - if the given locale is null.

      • setLocale

        public void setLocale​(Dictionary<java.lang.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.
        Throws:
        java.lang.IllegalArgumentException - if the given locale dictionary is null.

      • setLocale

        public void setLocale​(java.lang.String locale)
        Sets the locale used to present calendar data.
        Parameters:
        locale - A JSON map containing values for language, country, and variant.
        Throws:
        java.lang.IllegalArgumentException - if the locale string is null or if there is a problem parsing the string.
        See Also:
        setLocale(Dictionary)

      • setDisabledDateFilter

        public void setDisabledDateFilter​(Filter<CalendarDate> disabledDateFilter)

      • getSelectedDateKey

        public java.lang.String getSelectedDateKey()
        Returns:
        The data binding key that is set on this calendar button.

      • setSelectedDateKey

        public void setSelectedDateKey​(java.lang.String selectedDateKey)
        Sets this calendar button's data binding key.
        Parameters:
        selectedDateKey - The new binding key for the calendar's selected date.

      • getSelectedDateBindType

        public BindType getSelectedDateBindType()

      • setSelectedDateBindType

        public void setSelectedDateBindType​(BindType selectedDateBindType)

      • load

        public void load​(java.lang.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
        Parameters:
        context - The object to load the bound values from.

      • store

        public void store​(java.lang.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
        Parameters:
        context - The object to store the bound values into.

      • clear

        public void clear()
        Description copied from class: Component
        Clears any bound values in the component. This functionality must be provided by the subclass; the base implementation is a no-op.
        Overrides:
        clear in class Button

      • clearSelection

        public void clearSelection()
        Clears the selection.