com.bradrydzewski.gwt.calendar.client.CalendarView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-cal Show documentation
a personal calendar widget similar to iCal, Outlook, Google Calendar, etc
The newest version!
/*
 * This file is part of gwt-cal
 * Copyright (C) 2009  Scottsdale Software LLC
 * 
 * gwt-cal is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  Subclasses will provide the
 * details of rendering the calendar to visualize by day (Day View), monthly
 * (month view), agenda (list view) and the logic implementing the user-input
 * event processing.
 *
 * @author Brad Rydzewski
 */
public abstract class CalendarView implements HasSettings {

    /**
     * Calendar widget bound to the view.
     *
     * @see CalendarWidget
     */
    protected CalendarWidget calendarWidget = null;

    /**
     * Number of days the calendar should display at a given time, 3 by
     * default.
     */
    private int displayedDays = 3;

    /**
     * Attaches this view to the provided {@link CalendarWidget}.
     *
     * @param calendarWidget The interactive widget containing the calendar
     */
    public void attach(CalendarWidget calendarWidget) {
        this.calendarWidget = calendarWidget;
    }

    /**
     * Detaches this view from the currently associated {@link CalendarWidget}.
     * TODO: The CalendarWidget might still have a reference to this
     * CalendarView, is that correct??
     */
    public void detatch() {
        calendarWidget = null;
    }

    /**
     * Returns the CSS style name of this calendar view.
     *
     * @return The CSS style that should be used when rendering this calendar
     *         view
     */
    public abstract String getStyleName();

    public void doSizing() {
    }

    public abstract void doLayout();

    /**
     * Configures this view component's  currently selected
     * appointment. Notification to the calendar widget associated
     * is optional and controlled with the fireEvent flag.
     *
     * @param appointment The appointment in the calendar in-memory model to be
     *                    configured as the currently selected
     * @param fireEvent   Indicates whether a selection event should be
     *                    triggered by the parent widget so that it informs its
     *                    set of registered listeners about the change
     */
//    public void setSelectedAppointment(Appointment appointment,
//                                       boolean fireEvent) {
//        calendarWidget.setSelectedAppointment(appointment);
//        if (fireEvent) {
//            calendarWidget.fireSelectionEvent(appointment);
//        }
//    }

    /**
     * Configures this view component's currently selected
     * appointment and notifies widget about the change in the
     * model state.
     *
     * @param appointment The appointment in the calendar in-memory model to be
     *                    configured as the currently selected
     */
//    public void setSelectedAppointment(Appointment appointment) {
//        setSelectedAppointment(appointment, true);
//    }

    /**
     * Returns the configured number of days the calendar should display at a
     * given time.
     *
     * @return The number of days this calendar view should display at a given
     *         time
     */
    public int getDisplayedDays() {
        return displayedDays;
    }

    /**
     * Sets the configured number of days the calendar should display at a given
     * time.
     *
     * @param displayedDays The number of days this calendar view should display
     *                      at a given time
     */
    public void setDisplayedDays(int displayedDays) {
        this.displayedDays = displayedDays;
    }

    /* on clicks */
    public abstract void onDoubleClick(Element element, Event event);
    
    public abstract void onSingleClick(Element element, Event event);

    public abstract void onMouseOver(Element element, Event event);
    
    /**
     * Processes user {@link com.google.gwt.event.dom.client.KeyCodes.KEY_DELETE}
     * keystrokes. The CalendarView implementation is empty so that
     * subclasses are not forced to implement it if no specific logic is needed
     * for {@link com.google.gwt.event.dom.client.KeyCodes.KEY_DELETE}
     * keystrokes.
     */
    public void onDeleteKeyPressed() {
    }

    /**
     * Processes user {@link com.google.gwt.event.dom.client.KeyCodes.KEY_UP}
     * keystrokes. The CalendarView implementation is empty so that
     * subclasses are not forced to implement it if no specific logic is needed
     * for {@link com.google.gwt.event.dom.client.KeyCodes.KEY_UP} keystrokes.
     */
    public void onUpArrowKeyPressed() {
    }

    /**
     * Processes user {@link com.google.gwt.event.dom.client.KeyCodes.KEY_DOWN}
     * keystrokes. The CalendarView implementation is empty so that
     * subclasses are not forced to implement it if no specific logic is needed
     * for {@link com.google.gwt.event.dom.client.KeyCodes.KEY_DOWN}
     * keystrokes.
     */
    public void onDownArrowKeyPressed() {
    }

    /**
     * Processes user {@link com.google.gwt.event.dom.client.KeyCodes.KEY_LEFT}
     * keystrokes. The CalendarView implementation is empty so that
     * subclasses are not forced to implement it if no specific logic is needed
     * for {@link com.google.gwt.event.dom.client.KeyCodes.KEY_LEFT}
     * keystrokes.
     */
    public void onLeftArrowKeyPressed() {
    }

    /**
     * Processes user {@link com.google.gwt.event.dom.client.KeyCodes.KEY_RIGHT}
     * keystrokes. The CalendarView implementation is empty so that
     * subclasses are not forced to implement it if no specific logic is needed
     * for {@link com.google.gwt.event.dom.client.KeyCodes.KEY_RIGHT}
     * keystrokes.
     */
    public void onRightArrowKeyPressed() {
    }

    /* appointment */
    public abstract void onAppointmentSelected(Appointment appt);
    
    //public abstract void onAppointmentUpdated(Appointment oldAppt, Appointment newAppt);
    
    //public abstract void onAppointmentDeleted(Appointment appt);

    public final void selectAppointment(Appointment appt) {
        calendarWidget.setSelectedAppointment(appt, true);
    }

    public final void selectNextAppointment() {
    	calendarWidget.selectNextAppointment();
    }
    
    public final void selectPreviousAppointment() {
    	calendarWidget.selectPreviousAppointment();
    }
    
    public final void updateAppointment(Appointment toAppt) {
    	calendarWidget.fireUpdateEvent(toAppt);
    }
    
    public final void deleteAppointment(Appointment appt) {
    	calendarWidget.fireDeleteEvent(appt);
    }
    
    public final void openAppointment(Appointment appt) {
    	calendarWidget.fireOpenEvent(appt);
    }
    
    public final void createAppointment(Appointment appt) {
    	createAppointment(appt.getStart(), appt.getEnd());
    }
    
    public final void createAppointment(Date start, Date end) {
    	calendarWidget.fireTimeBlockClickEvent(start);
    }
    
    public void scrollToHour(int hour) {
    	
    }
    
	public CalendarSettings getSettings() {
		return calendarWidget.getSettings();
	}

	public void setSettings(CalendarSettings settings) {
		calendarWidget.setSettings(settings);
	}

//    /* loading and unloading of view */
//    onLoad()
//    onUnload()
//
//    /* size */
//    onResize()
//    onLayout()
//
//    /* widget */
//    onParentSizeChanged()
//    onParentWidthChanged()
//    onParentHeightChanged()
//
//    getParent()
//    getDate()
//    getDays()
    
//    public final void setRollbackAppointment(Appointment appt) {
//    	calendarWidget.setRollbackAppointment(appt);
//    }
//
//    public final void setCommittedAppointment(Appointment appt) {
//    	calendarWidget.setCommittedAppointment(appt);
//    }
}