wtk/src/org/apache/pivot/wtk/skin/CalendarButtonSkin.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except in
 * compliance with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.pivot.wtk.skin;

import java.util.Locale;

import org.apache.pivot.util.CalendarDate;
import org.apache.pivot.util.Filter;
import org.apache.pivot.util.Vote;
import org.apache.pivot.wtk.Calendar;
import org.apache.pivot.wtk.CalendarButton;
import org.apache.pivot.wtk.CalendarButtonListener;
import org.apache.pivot.wtk.CalendarButtonSelectionListener;
import org.apache.pivot.wtk.CalendarListener;
import org.apache.pivot.wtk.Component;
import org.apache.pivot.wtk.ComponentKeyListener;
import org.apache.pivot.wtk.ComponentMouseButtonListener;
import org.apache.pivot.wtk.Container;
import org.apache.pivot.wtk.ContainerMouseListener;
import org.apache.pivot.wtk.Display;
import org.apache.pivot.wtk.FocusTraversalDirection;
import org.apache.pivot.wtk.Keyboard;
import org.apache.pivot.wtk.Keyboard.KeyCode;
import org.apache.pivot.wtk.Keyboard.KeyLocation;
import org.apache.pivot.wtk.Keyboard.Modifier;
import org.apache.pivot.wtk.Mouse;
import org.apache.pivot.wtk.Window;
import org.apache.pivot.wtk.WindowStateListener;

/**
 * Abstract base class for calendar button skins.
 */
public abstract class CalendarButtonSkin extends ButtonSkin implements CalendarButton.Skin,
    CalendarButtonListener, CalendarButtonSelectionListener {
    protected Calendar calendar;
    protected Window calendarPopup;

    protected boolean pressed = false;

    private ComponentMouseButtonListener calendarPopupMouseButtonListener = new ComponentMouseButtonListener() {
        @Override
        public boolean mouseClick(final Component component, final Mouse.Button button,
            final int x, final int y, final int count) {
            CalendarButton calendarButton = (CalendarButton) getComponent();

            calendarPopup.close();

            CalendarDate date = calendar.getSelectedDate();
            calendarButton.setSelectedDate(date);

            return true;
        }
    };

    private ComponentKeyListener calendarPopupKeyListener = new ComponentKeyListener() {
        /**
         * {@link KeyCode#ESCAPE ESCAPE} Close the popup.<br>
         * {@link KeyCode#ENTER ENTER} Choose the selected date.<br>
         * {@link KeyCode#TAB TAB} Choose the selected date and transfer focus forwards.<br>
         * {@link KeyCode#TAB TAB} + {@link Modifier#SHIFT SHIFT} Choose the selected date and
         * transfer focus backwards.
         */
        @Override
        public boolean keyPressed(final Component component, final int keyCode, final KeyLocation keyLocation) {
            CalendarButton calendarButton = (CalendarButton) getComponent();

            switch (keyCode) {
                case KeyCode.ESCAPE:
                    calendarPopup.close();
                    break;

                case KeyCode.TAB:
                case KeyCode.ENTER:
                    calendarPopup.close();

                    if (keyCode == KeyCode.TAB) {
                        FocusTraversalDirection direction = (Keyboard.isPressed(Modifier.SHIFT))
                            ? FocusTraversalDirection.BACKWARD : FocusTraversalDirection.FORWARD;
                        calendarButton.transferFocus(direction);
                    }

                    CalendarDate date = calendar.getSelectedDate();
                    calendarButton.setSelectedDate(date);

                    break;

                default:
                    break;
            }

            return false;
        }
    };

    private WindowStateListener calendarPopupWindowStateListener = new WindowStateListener() {
        @Override
        public void windowOpened(final Window window) {
            Display display = window.getDisplay();
            display.getContainerMouseListeners().add(displayMouseListener);

            window.requestFocus();
        }

        @Override
        public Vote previewWindowClose(final Window window) {
            if (window.containsFocus()) {
                getComponent().requestFocus();
            }

            return Vote.APPROVE;
        }

        @Override
        public void windowCloseVetoed(final Window window, final Vote reason) {
            if (reason == Vote.DENY) {
                window.requestFocus();
            }
        }

        @Override
        public void windowClosed(final Window window, final Display display, final Window owner) {
            display.getContainerMouseListeners().remove(displayMouseListener);

            Window componentWindow = getComponent().getWindow();
            if (componentWindow != null && componentWindow.isOpen() && !componentWindow.isClosing()) {
                componentWindow.moveToFront();
            }
        }
    };

    private ContainerMouseListener displayMouseListener = new ContainerMouseListener() {
        @Override
        public boolean mouseDown(final Container container, final Mouse.Button button, final int x, final int y) {
            Display display = (Display) container;
            Component descendant = display.getDescendantAt(x, y);

            if (!calendarPopup.isAncestor(descendant)
                && descendant != CalendarButtonSkin.this.getComponent()) {
                calendarPopup.close();
            }

            return false;
        }

        @Override
        public boolean mouseWheel(final Container container, final Mouse.ScrollType scrollType,
            final int scrollAmount, final int wheelRotation, final int x, final int y) {
            boolean consumed = false;

            Display display = (Display) container;
            Window window = (Window) display.getComponentAt(x, y);

            if (window != calendarPopup) {
                consumed = true;
            }

            return consumed;
        }
    };

    public CalendarButtonSkin() {
        calendar = new Calendar();
        calendar.getCalendarListeners().add(new CalendarListener() {
            @Override
            public void yearChanged(final Calendar calendarArgument, final int previousYear) {
                CalendarButton calendarButton = (CalendarButton) getComponent();
                calendarButton.setYear(calendarArgument.getYear());
            }

            @Override
            public void monthChanged(final Calendar calendarArgument, final int previousMonth) {
                CalendarButton calendarButton = (CalendarButton) getComponent();
                calendarButton.setMonth(calendarArgument.getMonth());
            }
        });

        calendarPopup = new Window();
        calendarPopup.getComponentMouseButtonListeners().add(calendarPopupMouseButtonListener);
        calendarPopup.getComponentKeyListeners().add(calendarPopupKeyListener);
        calendarPopup.getWindowStateListeners().add(calendarPopupWindowStateListener);
    }

    @Override
    public void install(final Component component) {
        super.install(component);

        CalendarButton calendarButton = (CalendarButton) component;
        calendarButton.getCalendarButtonListeners().add(this);
        calendarButton.getCalendarButtonSelectionListeners().add(this);

        calendar.setLocale(calendarButton.getLocale());
    }


    // CalendarButton.Skin methods
    @Override
    public Window getCalendarPopup() {
        return calendarPopup;
    }

    // Component state events
    @Override
    public void enabledChanged(final Component component) {
        super.enabledChanged(component);

        if (!component.isEnabled()) {
            pressed = false;
        }

        repaintComponent();

        calendarPopup.close();
    }

    @Override
    public void focusedChanged(final Component component, final Component obverseComponent) {
        super.focusedChanged(component, obverseComponent);

        repaintComponent();

        // Close the popup if focus was transferred to a component whose
        // window is not the popup
        if (!component.isFocused()) {
            pressed = false;

            if (!calendarPopup.containsFocus()) {
                calendarPopup.close();
            }
        }
    }

    // Component mouse events
    @Override
    public void mouseOut(final Component component) {
        super.mouseOut(component);

        pressed = false;
        repaintComponent();
    }

    @Override
    public boolean mouseDown(final Component component, final Mouse.Button button, final int x, final int y) {
        boolean consumed = super.mouseDown(component, button, x, y);

        pressed = true;
        repaintComponent();

        if (calendarPopup.isOpen()) {
            calendarPopup.close();
        } else {
            calendarPopup.open(component.getWindow());
        }

        return consumed;
    }

    @Override
    public boolean mouseUp(final Component component, final Mouse.Button button, final int x, final int y) {
        boolean consumed = super.mouseUp(component, button, x, y);

        pressed = false;
        repaintComponent();

        return consumed;
    }

    /**
     * {@link KeyCode#SPACE SPACE} Repaints the component to reflect the pressed
     * state.
     *
     * @see #keyReleased(Component, int, Keyboard.KeyLocation)
     */
    @Override
    public boolean keyPressed(final Component component, final int keyCode, final KeyLocation keyLocation) {
        boolean consumed = false;

        if (keyCode == KeyCode.SPACE) {
            pressed = true;
            repaintComponent();

            if (calendarPopup.isOpen()) {
                calendarPopup.close();
            } else {
                calendarPopup.open(component.getWindow());
            }

            consumed = true;
        } else {
            consumed = super.keyPressed(component, keyCode, keyLocation);
        }

        return consumed;
    }

    /**
     * {@link KeyCode#SPACE SPACE} 'presses' the button.
     */
    @Override
    public boolean keyReleased(final Component component, final int keyCode, final KeyLocation keyLocation) {
        boolean consumed = false;

        if (keyCode == KeyCode.SPACE) {
            pressed = false;
            repaintComponent();
        } else {
            consumed = super.keyReleased(component, keyCode, keyLocation);
        }

        return consumed;
    }

    // Calendar button events
    @Override
    public void yearChanged(final CalendarButton calendarButton, final int previousYear) {
        calendar.setYear(calendarButton.getYear());
    }

    @Override
    public void monthChanged(final CalendarButton calendarButton, final int previousMonth) {
        calendar.setMonth(calendarButton.getMonth());
    }

    @Override
    public void localeChanged(final CalendarButton calendarButton, final Locale previousLocale) {
        calendar.setLocale(calendarButton.getLocale());
    }

    @Override
    public void disabledDateFilterChanged(final CalendarButton calendarButton,
        final Filter<CalendarDate> previousDisabledDateFilter) {
        calendar.setDisabledDateFilter(calendarButton.getDisabledDateFilter());
    }

    // Calendar button selection events
    @Override
    public void selectedDateChanged(final CalendarButton calendarButton, final CalendarDate previousSelectedDate) {
        // Set the selected date as the button data
        CalendarDate date = calendarButton.getSelectedDate();
        calendarButton.setButtonData(date);

        calendar.setSelectedDate(date);

        if (date != null) {
            calendar.setYear(date.year);
            calendar.setMonth(date.month);
        }
    }
}