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 org.opencms.gwt.client.ui.contextmenu.I_CmsContextMenuHandler;
031import org.opencms.gwt.shared.CmsCoreData.AdeContext;
032import org.opencms.util.CmsUUID;
033
034/**
035 * An abstract interface used to coordinate toolbar buttons with a toolbar.<p>
036 *
037 * @since 8.0.0
038 */
039public interface I_CmsToolbarHandler extends I_CmsContextMenuHandler {
040
041    /**
042     * Activates the selection button.<p>
043     */
044    void activateSelection();
045
046    /**
047     * De-activates the current button.<p>
048     */
049    void deactivateCurrentButton();
050
051    /**
052     * Returns the currently active button (may be null).<p>
053     *
054     * @return the currently active button
055     */
056    I_CmsToolbarButton getActiveButton();
057
058    /**
059     * Loads the context menu.<p>
060     * @param structureId the structure id of the resource for which to load the context menu
061     * @param context the context menu item visibility context
062     */
063    void loadContextMenu(CmsUUID structureId, AdeContext context);
064
065    /**
066     * Sets the active button.<p>
067     *
068     * @param button the new active button
069     */
070    void setActiveButton(I_CmsToolbarButton button);
071
072}