Statistics
| Revision:

root / branches / v2_0_0_prep / libraries / libUIComponent / src / org / gvsig / gui / beans / buttonspanel / IButtonsPanel.java @ 26897

History | View | Annotate | Download (8.51 KB)

1
package org.gvsig.gui.beans.buttonspanel;
2

    
3
/* gvSIG. Geographic Information System of the Valencian Government
4
 *
5
 * Copyright (C) 2007-2008 Infrastructures and Transports Department
6
 * of the Valencian Government (CIT)
7
 * 
8
 * This program is free software; you can redistribute it and/or
9
 * modify it under the terms of the GNU General Public License
10
 * as published by the Free Software Foundation; either version 2
11
 * of the License, or (at your option) any later version.
12
 * 
13
 * This program is distributed in the hope that it will be useful,
14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
 * GNU General Public License for more details.
17
 *  
18
 * You should have received a copy of the GNU General Public License
19
 * along with this program; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
21
 * MA  02110-1301, USA.
22
 * 
23
 */
24

    
25
/**
26
 * <p>Interface for adding support to enable/disable the necessary buttons of a {@link ButtonsPanel ButtonsPanel} component.</p>
27
 * <p>For example, if our panel has only the <i>accept</i> and <i>cancel</i> buttons, 
28
 *  will only need to have implemented the methods related with them. And, even, only one (the set...) of them,
29
 *   if, for instance, we don't need to know if a particular button is or isn't enabled.</p>    
30
 * 
31
 * @version 09/05/2008
32
 *
33
 * @author BorSanZa - Borja Sanchez Zamorano (borja.sanchez@iver.es)
34
 */
35
public interface IButtonsPanel {
36
        /**
37
         * <p>Enables (or disables) the <i>accept button</i>.</p>
38
         * 
39
         * @param b <code>true</code> to enable the <i>accept button</i>, otherwise <code>false</code>
40
         * 
41
         * @see #isEnabledAcceptButton()
42
         */
43
        public void setEnabledAcceptButton(boolean b);
44

    
45
        /**
46
         * <p>Determines whether the <i>accept button</i> is enabled. An enabled component can respond
47
         *  to user input and generate events.</p>
48
         * 
49
         * @return <code>true</code> if the <i>accept button</i> is enabled, <code>false</code> otherwise
50
         * 
51
         * @see #setEnabledAcceptButton(boolean)
52
         */
53
        public boolean isEnabledAcceptButton();
54

    
55
        /**
56
         * <p>Enables (or disables) the <i>cancel button</i>.</p>
57
         * 
58
         * @param b <code>true</code> to enable the <i>cancel button</i>, otherwise <code>false</code>
59
         * 
60
         * @see #isEnabledCancelButton()
61
         */
62
        public void setEnabledCancelButton(boolean b);
63

    
64
        /**
65
         * <p>Determines whether the <i>cancel button</i> is enabled. An enabled component can respond
66
         *  to user input and generate events.</p>
67
         * 
68
         * @return <code>true</code> if the <i>cancel button</i> is enabled, <code>false</code> otherwise
69
         * 
70
         * @see #setEnabledCancelButton(boolean)
71
         */
72
        public boolean isEnabledCancelButton();
73

    
74
        /**
75
         * <p>Enables (or disables) the <i>apply button</i>.</p>
76
         * 
77
         * @param b <code>true</code> to enable the <i>apply button</i>, otherwise <code>false</code>
78
         * 
79
         * @see #isEnabledApplyButton()
80
         */
81
        public void setEnabledApplyButton(boolean b);
82

    
83
        /**
84
         * <p>Determines whether the <i>apply button</i> is enabled. An enabled component can respond
85
         *  to user input and generate events.</p>
86
         * 
87
         * @return <code>true</code> if the <i>apply button</i> is enabled, <code>false</code> otherwise
88
         * 
89
         * @see #setEnabledApplyButton(boolean)
90
         */
91
        public boolean isEnabledApplyButton();
92

    
93
        /**
94
         * <p>Enables (or disables) the <i>yes button</i>.</p>
95
         * 
96
         * @param b <code>true</code> to enable the <i>yes button</i>, otherwise <code>false</code>
97
         * 
98
         * @see #isEnabledYesButton()
99
         */
100
        public void setEnabledYesButton(boolean b);
101

    
102
        /**
103
         * <p>Determines whether the <i>yes button</i> is enabled. An enabled component can respond
104
         *  to user input and generate events.</p>
105
         * 
106
         * @return <code>true</code> if the <i>yes button</i> is enabled, <code>false</code> otherwise
107
         * 
108
         * @see #setEnabledYesButton(boolean)
109
         */
110
        public boolean isEnabledYesButton();
111

    
112
        /**
113
         * <p>Enables (or disables) the <i>no button</i>.</p>
114
         * 
115
         * @param b <code>true</code> to enable the <i>no button</i>, otherwise <code>false</code>
116
         * 
117
         * @see #isEnabledNoButton()
118
         */
119
        public void setEnabledNoButton(boolean b);
120

    
121
        /**
122
         * <p>Determines whether the <i>no button</i> is enabled. An enabled component can respond
123
         *  to user input and generate events.</p>
124
         * 
125
         * @return <code>true</code> if the <i>no button</i> is enabled, <code>false</code> otherwise
126
         * 
127
         * @see #setEnabledNoButton(boolean)
128
         */
129
        public boolean isEnabledNoButton();
130

    
131
        /**
132
         * <p>Enables (or disables) the <i>close button</i>.</p>
133
         * 
134
         * @param b <code>true</code> to enable the <i>close button</i>, otherwise <code>false</code>
135
         * 
136
         * @see #isEnabledCloseButton()
137
         */
138
        public void setEnabledCloseButton(boolean b);
139

    
140
        /**
141
         * <p>Determines whether the <i>close button</i> is enabled. An enabled component can respond
142
         *  to user input and generate events.</p>
143
         * 
144
         * @return <code>true</code> if the <i>close button</i> is enabled, <code>false</code> otherwise
145
         * 
146
         * @see #setEnabledCloseButton(boolean)
147
         */
148
        public boolean isEnabledCloseButton();
149

    
150
        /**
151
         * <p>Enables (or disables) the <i>exit button</i>.</p>
152
         * 
153
         * @param b <code>true</code> to enable the <i>exit button</i>, otherwise <code>false</code>
154
         * 
155
         * @see #isEnabledExitButton()
156
         */
157
        public void setEnabledExitButton(boolean b);
158

    
159
        /**
160
         * <p>Determines whether the <i>exit button</i> is enabled. An enabled component can respond
161
         *  to user input and generate events.</p>
162
         * 
163
         * @return <code>true</code> if the <i>exit button</i> is enabled, <code>false</code> otherwise
164
         * 
165
         * @see #setEnabledExitButton(boolean)
166
         */
167
        public boolean isEnabledExitButton();
168

    
169
        /**
170
         * <p>Enables (or disables) the <i>see details button</i>.</p>
171
         * 
172
         * @param b <code>true</code> to enable the <i>see details button</i>, otherwise <code>false</code>
173
         * 
174
         * @see #isEnabledSeeDetailsButton()
175
         */
176
        public void setEnabledSeeDetailsButton(boolean b);
177

    
178
        /**
179
         * <p>Determines whether the <i>see details button</i> is enabled. An enabled component can respond
180
         *  to user input and generate events.</p>
181
         * 
182
         * @return <code>true</code> if the <i>see details button</i> is enabled, <code>false</code> otherwise
183
         * 
184
         * @see #setEnabledSeeDetailsButton(boolean)
185
         */
186
        public boolean isEnabledSeeDetailsButton();
187

    
188
        /**
189
         * <p>Enables (or disables) the <i>hide details button</i>.</p>
190
         * 
191
         * @param b <code>true</code> to enable the <i>hide details button</i>, otherwise <code>false</code>
192
         * 
193
         * @see #isEnabledHideDetailsButton()
194
         */
195
        public void setEnabledHideDetailsButton(boolean b);
196

    
197
        /**
198
         * <p>Determines whether the <i>hide details button</i> is enabled. An enabled component can respond
199
         *  to user input and generate events.</p>
200
         * 
201
         * @return <code>true</code> if the <i>hide details button</i> is enabled, <code>false</code> otherwise
202
         * 
203
         * @see #setEnabledHideDetailsButton(boolean)
204
         */
205
        public boolean isEnabledHideDetailsButton();
206

    
207
        /**
208
         * <p>Enables (or disables) the <i>pause button</i>.</p>
209
         * 
210
         * @param b <code>true</code> to enable the <i>pause button</i>, otherwise <code>false</code>
211
         * 
212
         * @see #isEnabledPauseButton()
213
         */
214
        public void setEnabledPauseButton(boolean b);
215

    
216
        /**
217
         * <p>Determines whether the <i>pause button</i> is enabled. An enabled component can respond
218
         *  to user input and generate events.</p>
219
         * 
220
         * @return <code>true</code> if the <i>pause button</i> is enabled, <code>false</code> otherwise
221
         * 
222
         * @see #setEnabledPauseButton(boolean)
223
         */
224
        public boolean isEnabledPauseButton();
225

    
226
        /**
227
         * <p>Enables (or disables) the <i>restart button</i>.</p>
228
         * 
229
         * @param b <code>true</code> to enable the <i>restart button</i>, otherwise <code>false</code>
230
         * 
231
         * @see #isEnabledRestartButton()
232
         */
233
        public void setEnabledRestartButton(boolean b);
234

    
235
        /**
236
         * <p>Determines whether the <i>restart button</i> is enabled. An enabled component can respond
237
         *  to user input and generate events.</p>
238
         * 
239
         * @return <code>true</code> if the <i>restart button</i> is enabled, <code>false</code> otherwise
240
         * 
241
         * @see #setEnabledRestartButton(boolean)
242
         */
243
        public boolean isEnabledRestartButton();
244

    
245
        /**
246
         * <p>Enables (or disables) the <i>save button</i>.</p>
247
         * 
248
         * @param b <code>true</code> to enable the <i>save button</i>, otherwise <code>false</code>
249
         * 
250
         * @see #isEnabledSaveButton()
251
         */
252
        public void setEnabledSaveButton(boolean b);
253

    
254
        /**
255
         * <p>Determines whether the <i>save button</i> is enabled. An enabled component can respond
256
         *  to user input and generate events.</p>
257
         * 
258
         * @return <code>true</code> if the <i>save button</i> is enabled, <code>false</code> otherwise
259
         * 
260
         * @see #setEnabledSaveButton(boolean)
261
         */
262
        public boolean isEnabledSaveButton();
263
}