Statistics
| Revision:

root / trunk / libraries / libUIComponent / src / org / gvsig / gui / beans / buttonspanel / IButtonsPanel.java @ 17543

History | View | Annotate | Download (8.44 KB)

1
/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana
2
 *
3
 * Copyright (C) 2007 IVER T.I. and Generalitat Valenciana.
4
 *
5
 * This program is free software; you can redistribute it and/or
6
 * modify it under the terms of the GNU General Public License
7
 * as published by the Free Software Foundation; either version 2
8
 * of the License, or (at your option) any later version.
9
 *
10
 * This program is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 * GNU General Public License for more details.
14
 *
15
 * You should have received a copy of the GNU General Public License
16
 * along with this program; if not, write to the Free Software
17
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.
18
 */
19

    
20
package org.gvsig.gui.beans.buttonspanel;
21

    
22
/**
23
 * <p>Interface for adding support to enable/disable the necessary buttons of a {@link ButtonsPanel ButtonsPanel} component.</p>
24
 * <p>For example, if our panel has only the <i>accept</i> and <i>cancel</i> buttons, 
25
 *  will only need to have implemented the methods related with them. And, even, only one (the set...) of them,
26
 *   if, for instance, we don't need to know if a particular button is or isn't enabled.</p>    
27
 * 
28
 * @version 04/12/2007
29
 * @author Pablo Piqueras Bartolom? (pablo.piqueras@iver.es) 
30
 */
31
public interface IButtonsPanel {
32
        /**
33
         * <p>Enables (or disables) the <i>accept button</i>.</p>
34
         * 
35
         * @param b <code>true</code> to enable the <i>accept button</i>, otherwise <code>false</code>
36
         * 
37
         * @see #isEnabledAcceptButton()
38
         */
39
        public void setEnabledAcceptButton(boolean b);
40

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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