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; 029 030import com.google.gwt.event.shared.GwtEvent; 031 032/** 033 * Event to be fired by a widget being activated or deactivated.<p> 034 * 035 * @since 8.0.0 036 * 037 */ 038public class CmsToggleEvent extends GwtEvent<I_CmsToggleHandler> { 039 040 /** Handler type. */ 041 private static Type<I_CmsToggleHandler> TYPE; 042 043 /** If the event source has been activated. */ 044 private boolean m_isActivated; 045 046 /** 047 * Creates a new open event.<p> 048 * 049 * @param isActivated if the source has been activated 050 */ 051 protected CmsToggleEvent(boolean isActivated) { 052 053 m_isActivated = isActivated; 054 } 055 056 /** 057 * Fires a toggle event on all registered handlers in the handler manager.If no 058 * such handlers exist, this method will do nothing.<p> 059 * 060 * @param source the event source 061 * @param isActivated if the source has been activated 062 */ 063 public static void fire(I_CmsHasToggleHandlers source, boolean isActivated) { 064 065 if (TYPE != null) { 066 CmsToggleEvent event = new CmsToggleEvent(isActivated); 067 source.fireEvent(event); 068 } 069 } 070 071 /** 072 * Gets the type associated with this event. 073 * 074 * @return returns the handler type 075 */ 076 public static com.google.gwt.event.shared.GwtEvent.Type<I_CmsToggleHandler> getType() { 077 078 if (TYPE == null) { 079 TYPE = new Type<I_CmsToggleHandler>(); 080 } 081 return TYPE; 082 } 083 084 /** 085 * @see com.google.gwt.event.shared.GwtEvent#getAssociatedType() 086 */ 087 @Override 088 public com.google.gwt.event.shared.GwtEvent.Type<I_CmsToggleHandler> getAssociatedType() { 089 090 return CmsToggleEvent.getType(); 091 } 092 093 /** 094 * Returns if the source has been activated.<p> 095 * 096 * @return if the source has been activated 097 */ 098 public boolean isActivated() { 099 100 return m_isActivated; 101 } 102 103 /** 104 * @see com.google.gwt.event.shared.GwtEvent#dispatch(com.google.gwt.event.shared.EventHandler) 105 */ 106 @Override 107 protected void dispatch(I_CmsToggleHandler handler) { 108 109 handler.onToggle(this); 110 111 } 112 113}