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.ade.sitemap.client.control;
029
030import org.opencms.ade.sitemap.shared.CmsSitemapChange;
031
032import com.google.gwt.event.shared.GwtEvent;
033
034/**
035 * Sitemap change event.<p>
036 *
037 * @since 8.0.0
038 *
039 * @see org.opencms.ade.sitemap.client.control.CmsSitemapController
040 */
041public class CmsSitemapChangeEvent extends GwtEvent<I_CmsSitemapChangeHandler> {
042
043    /** Event type for sitemap change events. */
044    private static final Type<I_CmsSitemapChangeHandler> TYPE = new Type<I_CmsSitemapChangeHandler>();
045
046    /** The change. */
047    private CmsSitemapChange m_change;
048
049    /**
050     * Constructor.<p>
051     *
052     * @param change the change
053     */
054    public CmsSitemapChangeEvent(CmsSitemapChange change) {
055
056        m_change = change;
057    }
058
059    /**
060     * Gets the event type associated with change events.<p>
061     *
062     * @return the handler type
063     */
064    public static Type<I_CmsSitemapChangeHandler> getType() {
065
066        return TYPE;
067    }
068
069    /**
070     * @see com.google.gwt.event.shared.GwtEvent#getAssociatedType()
071     */
072    @Override
073    public final Type<I_CmsSitemapChangeHandler> getAssociatedType() {
074
075        return TYPE;
076    }
077
078    /**
079     * Returns the change.<p>
080     *
081     * @return the change
082     */
083    public CmsSitemapChange getChange() {
084
085        return m_change;
086    }
087
088    /**
089     * @see com.google.gwt.event.shared.GwtEvent#dispatch(com.google.gwt.event.shared.EventHandler)
090     */
091    @Override
092    protected void dispatch(I_CmsSitemapChangeHandler handler) {
093
094        handler.onChange(this);
095    }
096}