001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (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.galleries.client;
029
030import org.opencms.ade.galleries.client.ui.CmsResultListItem;
031import org.opencms.ade.galleries.shared.CmsResultItemBean;
032import org.opencms.gwt.client.dnd.CmsDNDHandler;
033import org.opencms.gwt.client.ui.I_CmsAutoHider;
034
035import com.google.gwt.user.client.ui.Widget;
036
037/**
038 * A handler interface which allows the gallery dialog to interact with the context it is used in, e.g. the container page editor.
039 */
040public interface I_CmsGalleryHandler {
041
042    /**
043     * This method is used to disable drag-and-drop for specific results.<p>
044     *
045     * If this returns false, drag and drop should be disabled for the result (however, if true is returned,
046     * this does not automatically mean that drag and drop should be enabled.)
047     *
048     * @param resultBean the result for which drag-and-drop feasibility should be checked
049     * @return false if DnD should be prohibited for the element, else true
050     */
051    boolean filterDnd(CmsResultItemBean resultBean);
052
053    /**
054     * Gets an additional widget to display in the type tab.<p>
055     *
056     * @return the additional widget to display
057     */
058    Widget getAdditionalTypeTabControl();
059
060    /**
061     * Gets the auto-hide parent.<p>
062     *
063     * @return the auto-hide parent
064     */
065    I_CmsAutoHider getAutoHideParent();
066
067    /**
068     * Gets the drag-and-drop handler for the result list.
069     *
070     * @return the drag-and-drop handler
071     */
072    CmsDNDHandler getDndHandler();
073
074    /**
075     * Processes a result list item.<p>
076     *
077     * @param item the item to process
078     */
079    void processResultItem(CmsResultListItem item);
080
081}