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.contextmenu;
029
030import java.util.List;
031
032/**
033 * Interface for a context menu entry.<p>
034 *
035 * @since version 8.0.0
036 */
037public interface I_CmsContextMenuEntry {
038
039    /**
040     * Executes the context menu action.<p>
041     */
042    void execute();
043
044    /**
045     * Generates the context menu item.<p>
046     *
047     * @return the context menu item
048     */
049    A_CmsContextMenuItem generateMenuItem();
050
051    /**
052     * Returns a CSS class which should be used to display an icon, or null if no icon is required.<p>
053     *
054     * @return the CSS class for the icon
055     */
056    String getIconClass();
057
058    /**
059     * Returns the JSP path for the command generation.<p>
060     *
061     * @return the JSP path
062     */
063    String getJspPath();
064
065    /**
066     * Returns the label (text) for the menu entry.<p>
067     *
068     * @return the label
069     */
070    String getLabel();
071
072    /**
073     * Returns the name of the entry.<p>
074     *
075     * @return the name of the entry
076     */
077    String getName();
078
079    /**
080     * Returns the reason if the entry is de-activated .<p>
081     *
082     * @return the reason
083     */
084    String getReason();
085
086    /**
087     * Returns a list of {@link I_CmsContextMenuEntry} objects.<p>
088     *
089     * @return the sub menu entries
090     */
091    List<I_CmsContextMenuEntry> getSubMenu();
092
093    /**
094     * Returns <code>true</code> if this menu entry has a sub menu <code>false</code> otherwise.<p>
095     *
096     * @return <code>true</code> if this menu entry has a sub menu <code>false</code> otherwise
097     */
098    boolean hasSubMenu();
099
100    /**
101     * Returns <code>true</code> if this menu entry is active <code>false</code> otherwise.<p>
102     *
103     * @return <code>true</code> if this menu entry is active <code>false</code> otherwise
104     */
105    boolean isActive();
106
107    /**
108     * Returns <code>true</code> if this menu entry is a separator <code>false</code> otherwise.<p>
109     *
110     * @return <code>true</code> if this menu entry is a separator <code>false</code> otherwise
111     */
112    boolean isSeparator();
113
114    /**
115     * Returns <code>true</code> if this menu entry is visible <code>false</code> otherwise.<p>
116     *
117     * @return <code>true</code> if this menu entry is visible <code>false</code> otherwise
118     */
119    boolean isVisible();
120
121}