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.ui.contextmenu;
029
030import java.util.Locale;
031
032/**
033 * Interface for generic context menu entris.<p>
034 *
035 * @param <T> the item data type
036 */
037public interface I_CmsSimpleContextMenuEntry<T> {
038
039    /**
040     * This interface allows special styles for certain entries.<p>
041     */
042    public interface I_HasCssStyles {
043
044        /**
045         * Returns the styles to use for this menu entry.<p>
046         *
047         * @return the styles to use for this menu entry
048         */
049        String getStyles();
050    }
051
052    /**
053     * Executes the entry action.<p>
054     *
055     * @param context the item data
056     */
057    void executeAction(T context);
058
059    /**
060     * Returns the entry title for the given locale.<p>
061     *
062     * @param locale the locale
063     *
064     * @return the title
065     */
066    String getTitle(Locale locale);
067
068    /**
069     * Returns the entry visibility matching the given item data.<p>
070     *
071     * @param context the item data
072     *
073     * @return the visibility mode
074     */
075    CmsMenuItemVisibilityMode getVisibility(T context);
076}