Revision 42458 trunk/org.gvsig.desktop/org.gvsig.desktop.library/org.gvsig.ui/src/main/java/org/gvsig/gui/beans/panelGroup/panels/IPanel.java
IPanel.java | ||
---|---|---|
40 | 40 |
* <li>An optional reference to an object that is related ''semantically'' or ''conceptually'' to this panel (Ex. this panel is about some properties of a raster layer).</li> |
41 | 41 |
* </ul> |
42 | 42 |
* </p> |
43 |
*
|
|
43 |
* |
|
44 | 44 |
* @version 15/10/2007 |
45 |
* @author Pablo Piqueras Bartolom? (pablo.piqueras@iver.es)
|
|
45 |
* @author Pablo Piqueras Bartolom? (pablo.piqueras@iver.es) |
|
46 | 46 |
*/ |
47 |
public interface IPanel { |
|
47 |
public interface IPanel extends Comparable<IPanel>{
|
|
48 | 48 |
/** |
49 | 49 |
* <p>Gets the panel identifier.</p>. |
50 |
*
|
|
50 |
* |
|
51 | 51 |
* @return panel identifier, or <code>null</code> if undefined |
52 |
*
|
|
52 |
* |
|
53 | 53 |
* @see #setID(String) |
54 | 54 |
*/ |
55 | 55 |
public abstract String getID(); |
56 | 56 |
|
57 | 57 |
/** |
58 | 58 |
* <p>Gets the identifier of the panel used by a {@link AbstractPanelGroup AbstractPanelGroup}.</p> |
59 |
*
|
|
59 |
* |
|
60 | 60 |
* @return panel label identifier, or <code>null</code> if undefined |
61 |
*
|
|
61 |
* |
|
62 | 62 |
* @see #setLabel(String) |
63 | 63 |
*/ |
64 | 64 |
public abstract String getLabel(); |
... | ... | |
66 | 66 |
/** |
67 | 67 |
* <p>Gets the identifier of the panel used to group together different <code>IPanel</code> panels |
68 | 68 |
* in a {@link AbstractPanelGroup AbstractPanelGroup}.</p> |
69 |
*
|
|
69 |
* |
|
70 | 70 |
* @return panel label group identifier, or <code>null</code> if undefined |
71 |
*
|
|
71 |
* |
|
72 | 72 |
* @see #setLabelGroup(String) |
73 | 73 |
*/ |
74 | 74 |
public abstract String getLabelGroup(); |
75 | 75 |
|
76 | 76 |
/** |
77 | 77 |
* <p>Sets the identifier of the panel used by a {@link AbstractPanelGroup AbstractPanelGroup}.</p> |
78 |
*
|
|
78 |
* |
|
79 | 79 |
* @param id panel label identifier, or <code>null</code> if undefined |
80 |
*
|
|
80 |
* |
|
81 | 81 |
* @see #getID() |
82 | 82 |
*/ |
83 | 83 |
public abstract void setID(String id); |
84 | 84 |
|
85 | 85 |
/** |
86 | 86 |
* <p>Sets the identifier of the panel used by a {@link AbstractPanelGroup AbstractPanelGroup}.</p> |
87 |
*
|
|
87 |
* |
|
88 | 88 |
* @param label panel label identifier, or <code>null</code> if undefined |
89 |
*
|
|
89 |
* |
|
90 | 90 |
* @see #getLabel() |
91 | 91 |
*/ |
92 | 92 |
public abstract void setLabel(String label); |
... | ... | |
94 | 94 |
/** |
95 | 95 |
* <p>Sets the identifier of the panel used to group together different <code>IPanel</code> panels |
96 | 96 |
* of a {@link AbstractPanelGroup AbstractPanelGroup}.</p> |
97 |
*
|
|
97 |
* |
|
98 | 98 |
* @param labelGroup label group identifier, or <code>null</code> if undefined |
99 |
*
|
|
99 |
* |
|
100 | 100 |
* @see #getLabelGroup() |
101 | 101 |
*/ |
102 | 102 |
public abstract void setLabelGroup(String labelGroup); |
... | ... | |
104 | 104 |
/** |
105 | 105 |
* <p>Gets the object that has a ''semantically'' or ''conceptually'' relation to this panel, this is used to group |
106 | 106 |
* <code>IPanel</code> panels on a {@link IPanelGroup IPanelGroup} object.</p> |
107 |
*
|
|
107 |
* |
|
108 | 108 |
* @return object that has reference this panel, or <code>null</code> if there has reference |
109 | 109 |
* to no object |
110 |
*
|
|
110 |
* |
|
111 | 111 |
* @see #setReference(Object) |
112 | 112 |
*/ |
113 | 113 |
public abstract Object getReference(); |
114 | 114 |
|
115 | 115 |
/** |
116 | 116 |
* <p>Sets a reference to an object that is ''semantically' or 'contextually' related to this panel.</p> |
117 |
*
|
|
117 |
* |
|
118 | 118 |
* @param ref an object |
119 |
*
|
|
119 |
* |
|
120 | 120 |
* @see #getReference() |
121 | 121 |
*/ |
122 | 122 |
public abstract void setReference(Object ref); |
123 | 123 |
|
124 | 124 |
/** |
125 | 125 |
* <p>Gets a reference to the object that contains the group which this panel is a member.</p> |
126 |
*
|
|
126 |
* |
|
127 | 127 |
* @return an object that contains this panel's group |
128 |
*
|
|
128 |
* |
|
129 | 129 |
* @see #setPanelGroup(AbstractPanelGroup) |
130 | 130 |
*/ |
131 | 131 |
public abstract AbstractPanelGroup getPanelGroup(); |
132 | 132 |
|
133 | 133 |
/** |
134 | 134 |
* <p>Sets a reference to the object that contains the group which this panel is a member.</p> |
135 |
*
|
|
135 |
* |
|
136 | 136 |
* @param panelGroup object that contains this panel's group |
137 |
*
|
|
137 |
* |
|
138 | 138 |
* @see #getPanelGroup() |
139 | 139 |
*/ |
140 | 140 |
public abstract void setPanelGroup(AbstractPanelGroup panelGroup); |
... | ... | |
144 | 144 |
* If changes to invisible, then this panel won't be accessible by the user interface. But if changes to visible |
145 | 145 |
* and was invisible before, then will appear at the same position it was in the user interface. The position is |
146 | 146 |
* according the order of the insertion at the group. Anyway, the group will have this panel.</p> |
147 |
*
|
|
147 |
* |
|
148 | 148 |
* @param b the new visibility for that panel. |
149 | 149 |
*/ |
150 | 150 |
public abstract void setInGroupGUI(boolean b); |
... | ... | |
152 | 152 |
/** |
153 | 153 |
* <p>Returns <code>true</code> if this panel belongs to a 'panel group' and it's loaded in the graphical user interface |
154 | 154 |
* of that component; otherwise returns <code>false</code>.</p> |
155 |
*
|
|
155 |
* |
|
156 | 156 |
* @return <code>true</code> if this panel belongs to a 'panel group' and it's loaded in the graphical user interface |
157 | 157 |
* of that component |
158 | 158 |
*/ |
... | ... | |
160 | 160 |
|
161 | 161 |
/** |
162 | 162 |
* <p>Returns if this panel remains with its initial preferred size of it has been changed.</p> |
163 |
*
|
|
163 |
* |
|
164 | 164 |
* @return if this panel remains with its initial preferred size of it has been changed |
165 | 165 |
*/ |
166 | 166 |
public abstract boolean remainsWithItsDefaultPreferredSize(); |
... | ... | |
186 | 186 |
public abstract void selected(); |
187 | 187 |
|
188 | 188 |
/** |
189 |
* <p>Determines if this panel has changed since it was created, or applied (or accepted or cancelled). The
|
|
189 |
* <p>Determines if this panel has changed since it was created, or applied (or accepted or cancelled). The |
|
190 | 190 |
* programmer of each panel will be whom would set to <code>true</code> that a panel has changed.</p> |
191 | 191 |
* |
192 |
* @return <code>true</code> if this panel has changed since it was created, or applied (or accepted or cancelled); otherwise <code>false</code>
|
|
192 |
* @return <code>true</code> if this panel has changed since it was created, or applied (or accepted or cancelled); otherwise <code>false</code> |
|
193 | 193 |
*/ |
194 | 194 |
public abstract boolean hasChanged(); |
195 | 195 |
|
... | ... | |
200 | 200 |
|
201 | 201 |
/** |
202 | 202 |
* <p>Sets if this panel will always be applied and accepted (by default), or only when has changed.</i></p> |
203 |
*
|
|
203 |
* |
|
204 | 204 |
* @param b if this panel will always be applied and accepted, or only when has changed |
205 |
*
|
|
205 |
* |
|
206 | 206 |
* @see #isAlwaysApplicable() |
207 | 207 |
* @see #hasChanged() |
208 | 208 |
*/ |
209 | 209 |
public abstract void setAlwaysApplicable(boolean b); |
210 |
|
|
210 |
|
|
211 | 211 |
/** |
212 | 212 |
* <p>Gets if this panel will always be applied and accepted (by default), or only when has changed.</i></p> |
213 |
*
|
|
213 |
* |
|
214 | 214 |
* @return if this panel will always be applied and accepted, or only when has changed |
215 |
*
|
|
215 |
* |
|
216 | 216 |
* @see #setAlwaysApplicable(boolean) |
217 | 217 |
* @see #hasChanged() |
218 | 218 |
*/ |
219 | 219 |
public abstract boolean isAlwaysApplicable(); |
220 |
|
|
221 |
|
|
222 |
/** |
|
223 |
* The priority of this properties page. |
|
224 |
* When more high is the priority more to the left are set properties page. |
|
225 |
* |
|
226 |
* @return the priority of the properties page |
|
227 |
*/ |
|
228 |
public abstract int getPriority(); |
|
229 |
|
|
230 |
/** |
|
231 |
* Sets priority of this properties page. |
|
232 |
* When more high is the priority more to the left are set properties page. |
|
233 |
* |
|
234 |
*/ |
|
235 |
public abstract void setPriority(int priority); |
|
220 | 236 |
} |
Also available in: Unified diff