001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (https://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: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://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.ade.containerpage.client;
029
030import com.google.web.bindery.event.shared.Event;
031
032/**
033 * This event is fired when a container page's elements or the page itself are edited.<p>
034 */
035public class CmsContainerpageEvent extends Event<I_CmsContainerpageEventHandler> {
036
037    /** Enum for the event type. */
038    public enum EventType {
039        /** Fired when an element has been edited. */
040        elementEdited,
041        /** Fired when the page has been saved. */
042        pageSaved;
043    }
044
045    /**
046     * Handler type.
047     */
048    public static Type<I_CmsContainerpageEventHandler> TYPE = new Type<I_CmsContainerpageEventHandler>();
049
050    /** The type the event. */
051    private EventType m_type;
052
053    /**
054     * Creates a new event with a given type.<p>
055     *
056     * @param type the event type
057     */
058    public CmsContainerpageEvent(EventType type) {
059
060        m_type = type;
061    }
062
063    /**
064     * @see com.google.web.bindery.event.shared.Event#getAssociatedType()
065     */
066    @Override
067    public Event.Type<I_CmsContainerpageEventHandler> getAssociatedType() {
068
069        return TYPE;
070
071    }
072
073    /**
074     * Gets the type of the event.<p>
075     *
076     * @return the type of the event
077     */
078    public EventType getEventType() {
079
080        return m_type;
081    }
082
083    /**
084     * @see com.google.web.bindery.event.shared.Event#dispatch(java.lang.Object)
085     */
086    @Override
087    protected void dispatch(I_CmsContainerpageEventHandler handler) {
088
089        handler.onContainerpageEvent(this);
090    }
091}