KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > workplace > tools > I_CmsHtmlIconButton


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/tools/I_CmsHtmlIconButton.java,v $
3  * Date : $Date: 2006/03/27 14:52:51 $
4  * Version: $Revision: 1.7 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.workplace.tools;
33
34 import org.opencms.i18n.CmsMessageContainer;
35 import org.opencms.workplace.CmsWorkplace;
36
37 /**
38  * Interface for html buttons with icon.<p>
39  *
40  * @author Michael Moossen
41  *
42  * @version $Revision: 1.7 $
43  *
44  * @since 6.0.0
45  */
46 public interface I_CmsHtmlIconButton {
47
48     /**
49      * Returns the necessary html code.<p>
50      *
51      * @param wp the jsp page to write the code to
52      *
53      * @return html code
54      */
55     String JavaDoc buttonHtml(CmsWorkplace wp);
56
57     /**
58      * Returns the help text.<p>
59      *
60      * @return the help text
61      */
62     CmsMessageContainer getHelpText();
63
64     /**
65      * Returns the path to the icon.<p>
66      *
67      * @return the path to the icon
68      */
69     String JavaDoc getIconPath();
70
71     /**
72      * Returns the id of the html component.<p>
73      *
74      * @return the id
75      */
76     String JavaDoc getId();
77
78     /**
79      * Returns the display name.<p>
80      *
81      * @return the display name
82      */
83     CmsMessageContainer getName();
84
85     /**
86      * Returns if enabled or disabled.<p>
87      *
88      * @return if enabled or disabled
89      */
90     boolean isEnabled();
91
92     /**
93      * Returns if visible or not.<p>
94      *
95      * @return if visible or not
96      */
97     boolean isVisible();
98
99     /**
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 JavaDoc 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 }
Popular Tags