org.opencms.gwt.client.ui.I_CmsToolbarHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-gwt Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.gwt.client.ui;

import org.opencms.gwt.client.ui.contextmenu.I_CmsContextMenuHandler;
import org.opencms.gwt.shared.CmsCoreData.AdeContext;
import org.opencms.util.CmsUUID;

/**
 * An abstract interface used to coordinate toolbar buttons with a toolbar.
 *
 * @since 8.0.0
 */
public interface I_CmsToolbarHandler extends I_CmsContextMenuHandler {

    /**
     * Activates the selection button.

     */
    void activateSelection();

    /**
     * De-activates the current button.

     */
    void deactivateCurrentButton();

    /**
     * Returns the currently active button (may be null).

     *
     * @return the currently active button
     */
    I_CmsToolbarButton getActiveButton();

    /**
     * Loads the context menu.

     * @param structureId the structure id of the resource for which to load the context menu
     * @param context the context menu item visibility context
     */
    void loadContextMenu(CmsUUID structureId, AdeContext context);

    /**
     * Sets the active button.
     *
     * @param button the new active button
     */
    void setActiveButton(I_CmsToolbarButton button);

}