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.CmsClientSitemapEntry;
031
032import com.google.gwt.event.shared.GwtEvent;
033
034/**
035 * Sitemap load event.<p>
036 *
037 * @since 8.0.0
038 *
039 * @see org.opencms.ade.sitemap.client.control.CmsSitemapController
040 */
041public class CmsSitemapLoadEvent extends GwtEvent<I_CmsSitemapLoadHandler> {
042
043    /** Event type for sitemap change events. */
044    private static final Type<I_CmsSitemapLoadHandler> TYPE = new Type<I_CmsSitemapLoadHandler>();
045
046    /** The loaded sitemap entry. */
047    private CmsClientSitemapEntry m_entry;
048
049    /** Flag to indicate if the entry should be opened. */
050    private boolean m_setOpen;
051
052    /**
053     * Constructor.<p>
054     *
055     * @param entry the entry that loaded its children
056     * @param setOpen if the entry should be opened
057     */
058    public CmsSitemapLoadEvent(CmsClientSitemapEntry entry, boolean setOpen) {
059
060        m_entry = entry;
061        m_setOpen = setOpen;
062    }
063
064    /**
065     * Gets the event type associated with change events.<p>
066     *
067     * @return the handler type
068     */
069    public static Type<I_CmsSitemapLoadHandler> getType() {
070
071        return TYPE;
072    }
073
074    /**
075     * @see com.google.gwt.event.shared.GwtEvent#getAssociatedType()
076     */
077    @Override
078    public final Type<I_CmsSitemapLoadHandler> getAssociatedType() {
079
080        return TYPE;
081    }
082
083    /**
084     * Returns the entry.<p>
085     *
086     * @return the entry
087     */
088    public CmsClientSitemapEntry getEntry() {
089
090        return m_entry;
091    }
092
093    /**
094     * Returns if the entry should be opened.<p>
095     *
096     * @return <code>true</code> if the entry should be opened
097     */
098    public boolean isSetOpen() {
099
100        return m_setOpen;
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_CmsSitemapLoadHandler handler) {
108
109        handler.onLoad(this);
110    }
111}