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 GmbH & Co. KG, 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.workplace.tools;
029
030import org.opencms.i18n.CmsMessageContainer;
031import org.opencms.workplace.CmsWorkplace;
032
033/**
034 * Interface for html buttons with icon.<p>
035 *
036 * @since 6.0.0
037 */
038public interface I_CmsHtmlIconButton {
039
040    /**
041     * Returns the necessary html code.<p>
042     *
043     * @param wp the jsp page to write the code to
044     *
045     * @return html code
046     */
047    String buttonHtml(CmsWorkplace wp);
048
049    /**
050     * Returns the help text.<p>
051     *
052     * @return the help text
053     */
054    CmsMessageContainer getHelpText();
055
056    /**
057     * Returns the path to the icon.<p>
058     *
059     * @return the path to the icon
060     */
061    String getIconPath();
062
063    /**
064     * Returns the id of the html component.<p>
065     *
066     * @return the id
067     */
068    String getId();
069
070    /**
071     * Returns the display name.<p>
072     *
073     * @return the display name
074     */
075    CmsMessageContainer getName();
076
077    /**
078     * Returns if enabled or disabled.<p>
079     *
080     * @return if enabled or disabled
081     */
082    boolean isEnabled();
083
084    /**
085     * Returns if visible or not.<p>
086     *
087     * @return if visible or not
088     */
089    boolean isVisible();
090
091    /**
092     * Sets if enabled or disabled.<p>
093     *
094     * @param enabled if enabled or disabled
095     */
096    void setEnabled(boolean enabled);
097
098    /**
099     * Sets the help Text.<p>
100     *
101     * @param helpText the help Text to set
102     */
103    void setHelpText(CmsMessageContainer helpText);
104
105    /**
106     * Sets the icon Path.<p>
107     *
108     * @param iconPath the icon Path to set
109     */
110    void setIconPath(String iconPath);
111
112    /**
113     * Sets the name.<p>
114     *
115     * @param name the name to set
116     */
117    void setName(CmsMessageContainer name);
118
119    /**
120     * Sets if visible or not.<p>
121     *
122     * @param visible if visible or not
123     */
124    void setVisible(boolean visible);
125
126}