org.opencms.ui.contextmenu.I_CmsSimpleContextMenuEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test 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.ui.contextmenu;

import org.opencms.workplace.explorer.menu.CmsMenuItemVisibilityMode;

import java.util.Locale;

/**
 * Interface for generic context menu entris.
 *
 * @param  the item data type
 */
public interface I_CmsSimpleContextMenuEntry {

    /**
     * This interface allows special styles for certain entries.

     */
    public interface I_HasCssStyles {

        /**
         * Returns the styles to use for this menu entry.

         *
         * @return the styles to use for this menu entry
         */
        String getStyles();
    }

    /**
     * Executes the entry action.

     *
     * @param context the item data
     */
    void executeAction(T context);

    /**
     * Returns the entry title for the given locale.

     *
     * @param locale the locale
     *
     * @return the title
     */
    String getTitle(Locale locale);

    /**
     * Returns the entry visibility matching the given item data.
     *
     * @param context the item data
     *
     * @return the visibility mode
     */
    CmsMenuItemVisibilityMode getVisibility(T context);
}