001/* 002 * This library is part of OpenCms - 003 * the Open Source Content Management System 004 * 005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com) 006 * 007 * This library is free software; you can redistribute it and/or 008 * modify it under the terms of the GNU Lesser General Public 009 * License as published by the Free Software Foundation; either 010 * version 2.1 of the License, or (at your option) any later version. 011 * 012 * This library is distributed in the hope that it will be useful, 013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 015 * Lesser General Public License for more details. 016 * 017 * For further information about Alkacon Software, please see the 018 * company website: http://www.alkacon.com 019 * 020 * For further information about OpenCms, please see the 021 * project website: http://www.opencms.org 022 * 023 * You should have received a copy of the GNU Lesser General Public 024 * License along with this library; if not, write to the Free Software 025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 026 */ 027 028package org.opencms.gwt.client.ui.input.datebox; 029 030import java.util.Date; 031 032import com.google.gwt.event.shared.GwtEvent; 033 034/** 035 * Custom event type for CmsDateBox changes.<p> 036 * 037 * The difference between this and a ValueChangeEvent is that this event is also fired after user actions 038 * which may or may not have changed the value. The event carries information about that user action. 039 */ 040public class CmsDateBoxEvent extends GwtEvent<I_CmsDateBoxEventHandler> { 041 042 /** The event type. */ 043 public static Type<I_CmsDateBoxEventHandler> TYPE = new Type<I_CmsDateBoxEventHandler>(); 044 045 /** The currently selected date. */ 046 private Date m_date; 047 048 /** True if the event was caused by a user key press that may have changed the value. */ 049 private boolean m_isUserTyping; 050 051 /** 052 * Creates a new event.<p> 053 * 054 * @param date the date 055 * @param isUserTyping true if the event was caused by a user key press that may have changed the value.<p> 056 */ 057 public CmsDateBoxEvent(Date date, boolean isUserTyping) { 058 m_date = date; 059 m_isUserTyping = isUserTyping; 060 } 061 062 /** 063 * Fires the event. 064 * 065 * @param source the event source 066 * @param date the date 067 * @param isTyping true if event was caused by user pressing key that may have changed the value 068 */ 069 public static void fire(I_CmsHasDateBoxEventHandlers source, Date date, boolean isTyping) { 070 071 if (TYPE != null) { 072 CmsDateBoxEvent event = new CmsDateBoxEvent(date, isTyping); 073 source.fireEvent(event); 074 } 075 } 076 077 /** 078 * @see com.google.gwt.event.shared.GwtEvent#getAssociatedType() 079 */ 080 @Override 081 public com.google.gwt.event.shared.GwtEvent.Type<I_CmsDateBoxEventHandler> getAssociatedType() { 082 083 return TYPE; 084 } 085 086 /** 087 * Gets the date.<p> 088 * 089 * @return the date 090 */ 091 public Date getDate() { 092 093 return m_date; 094 095 } 096 097 /** 098 * Returns true if the event was caused by a user key press which may have changed the value.<p> 099 * 100 * @return true if caused by a keypress which may have changed the value 101 */ 102 public boolean isUserTyping() { 103 104 return m_isUserTyping; 105 } 106 107 /** 108 * @see com.google.gwt.event.shared.GwtEvent#dispatch(com.google.gwt.event.shared.EventHandler) 109 */ 110 @Override 111 protected void dispatch(I_CmsDateBoxEventHandler handler) { 112 113 handler.onDateBoxEvent(this); 114 } 115 116}