001: /*
002: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/tools/I_CmsHtmlIconButton.java,v $
003: * Date : $Date: 2008-02-27 12:05:31 $
004: * Version: $Revision: 1.9 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.workplace.tools;
033:
034: import org.opencms.i18n.CmsMessageContainer;
035: import org.opencms.workplace.CmsWorkplace;
036:
037: /**
038: * Interface for html buttons with icon.<p>
039: *
040: * @author Michael Moossen
041: *
042: * @version $Revision: 1.9 $
043: *
044: * @since 6.0.0
045: */
046: public interface I_CmsHtmlIconButton {
047:
048: /**
049: * Returns the necessary html code.<p>
050: *
051: * @param wp the jsp page to write the code to
052: *
053: * @return html code
054: */
055: String buttonHtml(CmsWorkplace wp);
056:
057: /**
058: * Returns the help text.<p>
059: *
060: * @return the help text
061: */
062: CmsMessageContainer getHelpText();
063:
064: /**
065: * Returns the path to the icon.<p>
066: *
067: * @return the path to the icon
068: */
069: String getIconPath();
070:
071: /**
072: * Returns the id of the html component.<p>
073: *
074: * @return the id
075: */
076: String getId();
077:
078: /**
079: * Returns the display name.<p>
080: *
081: * @return the display name
082: */
083: CmsMessageContainer getName();
084:
085: /**
086: * Returns if enabled or disabled.<p>
087: *
088: * @return if enabled or disabled
089: */
090: boolean isEnabled();
091:
092: /**
093: * Returns if visible or not.<p>
094: *
095: * @return if visible or not
096: */
097: boolean isVisible();
098:
099: /**
100: * Sets if enabled or disabled.<p>
101: *
102: * @param enabled if enabled or disabled
103: */
104: void setEnabled(boolean enabled);
105:
106: /**
107: * Sets the help Text.<p>
108: *
109: * @param helpText the help Text to set
110: */
111: void setHelpText(CmsMessageContainer helpText);
112:
113: /**
114: * Sets the icon Path.<p>
115: *
116: * @param iconPath the icon Path to set
117: */
118: void setIconPath(String iconPath);
119:
120: /**
121: * Sets the name.<p>
122: *
123: * @param name the name to set
124: */
125: void setName(CmsMessageContainer name);
126:
127: /**
128: * Sets if visible or not.<p>
129: *
130: * @param visible if visible or not
131: */
132: void setVisible(boolean visible);
133:
134: }
|