Revision 17543 trunk/libraries/libUIComponent/src/org/gvsig/gui/beans/panelGroup/panels/IPanel.java
| IPanel.java | ||
|---|---|---|
| 20 | 20 |
package org.gvsig.gui.beans.panelGroup.panels; |
| 21 | 21 |
|
| 22 | 22 |
import org.gvsig.gui.beans.panelGroup.AbstractPanelGroup; |
| 23 |
import org.gvsig.gui.beans.panelGroup.IPanelGroup; |
|
| 23 | 24 |
|
| 24 | 25 |
/** |
| 25 | 26 |
* <p>Common interface for all kinds of {@link AbstractPanel AbstractPanel}.</p>
|
| ... | ... | |
| 47 | 48 |
* |
| 48 | 49 |
* @see #setID(String) |
| 49 | 50 |
*/ |
| 50 |
public String getID(); |
|
| 51 |
public abstract String getID();
|
|
| 51 | 52 |
|
| 52 | 53 |
/** |
| 53 | 54 |
* <p>Gets the identifier of the panel used by a {@link AbstractPanelGroup AbstractPanelGroup}.</p>
|
| ... | ... | |
| 56 | 57 |
* |
| 57 | 58 |
* @see #setLabel(String) |
| 58 | 59 |
*/ |
| 59 |
public String getLabel(); |
|
| 60 |
public abstract String getLabel();
|
|
| 60 | 61 |
|
| 61 | 62 |
/** |
| 62 | 63 |
* <p>Gets the identifier of the panel used to group together different <code>IPanel</code> panels |
| ... | ... | |
| 66 | 67 |
* |
| 67 | 68 |
* @see #setLabelGroup(String) |
| 68 | 69 |
*/ |
| 69 |
public String getLabelGroup(); |
|
| 70 |
public abstract String getLabelGroup();
|
|
| 70 | 71 |
|
| 71 | 72 |
/** |
| 72 | 73 |
* <p>Sets the identifier of the panel used by a {@link AbstractPanelGroup AbstractPanelGroup}.</p>
|
| ... | ... | |
| 75 | 76 |
* |
| 76 | 77 |
* @see #getID() |
| 77 | 78 |
*/ |
| 78 |
public void setID(String id); |
|
| 79 |
public abstract void setID(String id);
|
|
| 79 | 80 |
|
| 80 | 81 |
/** |
| 81 | 82 |
* <p>Sets the identifier of the panel used by a {@link AbstractPanelGroup AbstractPanelGroup}.</p>
|
| ... | ... | |
| 84 | 85 |
* |
| 85 | 86 |
* @see #getLabel() |
| 86 | 87 |
*/ |
| 87 |
public void setLabel(String label); |
|
| 88 |
public abstract void setLabel(String label);
|
|
| 88 | 89 |
|
| 89 | 90 |
/** |
| 90 | 91 |
* <p>Sets the identifier of the panel used to group together different <code>IPanel</code> panels |
| ... | ... | |
| 94 | 95 |
* |
| 95 | 96 |
* @see #getLabelGroup() |
| 96 | 97 |
*/ |
| 97 |
public void setLabelGroup(String labelGroup); |
|
| 98 |
public abstract void setLabelGroup(String labelGroup);
|
|
| 98 | 99 |
|
| 99 | 100 |
/** |
| 100 |
* <p>Gets the class of the object that has a ''semantically'' or ''conceptually'' relation to this panel.</p> |
|
| 101 |
* <p>Gets the object that has a ''semantically'' or ''conceptually'' relation to this panel, this is used to group |
|
| 102 |
* <code>IPanel</code> panels on a {@link IPanelGroup IPanelGroup} object.</p>
|
|
| 101 | 103 |
* |
| 102 |
* @return class of the object that has reference this panel, or <code>null</code> if there has reference
|
|
| 104 |
* @return object that has reference this panel, or <code>null</code> if there has reference |
|
| 103 | 105 |
* to no object |
| 104 | 106 |
* |
| 105 | 107 |
* @see #setReference(Object) |
| 106 | 108 |
*/ |
| 107 |
public Class getReferenceClass();
|
|
| 109 |
public abstract Object getReference();
|
|
| 108 | 110 |
|
| 109 | 111 |
/** |
| 110 | 112 |
* <p>Sets a reference to an object that is ''semantically' or 'contextually' related to this panel.</p> |
| 111 |
* <p><i>This method is optional.</i></p> |
|
| 112 | 113 |
* |
| 113 | 114 |
* @param ref an object |
| 114 | 115 |
* |
| 115 |
* @see #getReferenceClass()
|
|
| 116 |
* @see #getReference() |
|
| 116 | 117 |
*/ |
| 117 |
public void setReference(Object ref); |
|
| 118 |
public abstract void setReference(Object ref);
|
|
| 118 | 119 |
|
| 119 | 120 |
/** |
| 120 | 121 |
* <p>Gets a reference to the object that contains the group which this panel is a member.</p> |
| ... | ... | |
| 123 | 124 |
* |
| 124 | 125 |
* @see #setPanelGroup(AbstractPanelGroup) |
| 125 | 126 |
*/ |
| 126 |
public AbstractPanelGroup getPanelGroup(); |
|
| 127 |
public abstract AbstractPanelGroup getPanelGroup();
|
|
| 127 | 128 |
|
| 128 | 129 |
/** |
| 129 | 130 |
* <p>Sets a reference to the object that contains the group which this panel is a member.</p> |
| ... | ... | |
| 132 | 133 |
* |
| 133 | 134 |
* @see #getPanelGroup() |
| 134 | 135 |
*/ |
| 135 |
public void setPanelGroup(AbstractPanelGroup panelGroup); |
|
| 136 |
public abstract void setPanelGroup(AbstractPanelGroup panelGroup);
|
|
| 136 | 137 |
|
| 137 | 138 |
/** |
| 138 | 139 |
* <p>If this panel belongs to a 'panel group', changes its visibility at the interface of the panel group. |
| ... | ... | |
| 142 | 143 |
* |
| 143 | 144 |
* @param b the new visibility for that panel. |
| 144 | 145 |
*/ |
| 145 |
public void setInGroupGUI(boolean b); |
|
| 146 |
public abstract void setInGroupGUI(boolean b);
|
|
| 146 | 147 |
|
| 147 | 148 |
/** |
| 148 | 149 |
* <p>Returns <code>true</code> if this panel belongs to a 'panel group' and it's loaded in the graphical user interface |
| ... | ... | |
| 151 | 152 |
* @return <code>true</code> if this panel belongs to a 'panel group' and it's loaded in the graphical user interface |
| 152 | 153 |
* of that component |
| 153 | 154 |
*/ |
| 154 |
public boolean isInGroupGUI(); |
|
| 155 |
public abstract boolean isInGroupGUI();
|
|
| 155 | 156 |
|
| 156 | 157 |
/** |
| 157 | 158 |
* <p>Returns if this panel remains with its initial preferred size of it has been changed.</p> |
| 158 | 159 |
* |
| 159 | 160 |
* @return if this panel remains with its initial preferred size of it has been changed |
| 160 | 161 |
*/ |
| 161 |
public boolean remainsWithItsDefaultPreferredSize(); |
|
| 162 |
public abstract boolean remainsWithItsDefaultPreferredSize();
|
|
| 162 | 163 |
|
| 163 | 164 |
/** |
| 164 | 165 |
* <p>Notifies to this panel of an <i>accept</i> action.</p> |
| ... | ... | |
| 179 | 180 |
* <p>Notifies this panel that has been selected at the {@link AbstractPanelGroup AbstractPanelGroup}</p>
|
| 180 | 181 |
*/ |
| 181 | 182 |
public abstract void selected(); |
| 183 |
|
|
| 184 |
/** |
|
| 185 |
* <p>Determines if this panel has changed since it was created, or applied (or accepted or cancelled). The |
|
| 186 |
* programmer of each panel will be whom would set to <code>true</code> that a panel has changed.</p> |
|
| 187 |
* |
|
| 188 |
* @return <code>true</code> if this panel has changed since it was created, or applied (or accepted or cancelled); otherwise <code>false</code> |
|
| 189 |
*/ |
|
| 190 |
public abstract boolean hasChanged(); |
|
| 191 |
|
|
| 192 |
/** |
|
| 193 |
* <p>Resets this panel <i>changed status</i> to its initial value.</p> |
|
| 194 |
*/ |
|
| 195 |
public abstract void resetChangedStatus(); |
|
| 196 |
|
|
| 197 |
/** |
|
| 198 |
* <p>Sets if this panel will always be applied and accepted (by default), or only when has changed.</i></p> |
|
| 199 |
* |
|
| 200 |
* @param b if this panel will always be applied and accepted, or only when has changed |
|
| 201 |
* |
|
| 202 |
* @see #isAlwaysApplicable() |
|
| 203 |
* @see #hasChanged() |
|
| 204 |
*/ |
|
| 205 |
public abstract void setAlwaysApplicable(boolean b); |
|
| 206 |
|
|
| 207 |
/** |
|
| 208 |
* <p>Gets if this panel will always be applied and accepted (by default), or only when has changed.</i></p> |
|
| 209 |
* |
|
| 210 |
* @return if this panel will always be applied and accepted, or only when has changed |
|
| 211 |
* |
|
| 212 |
* @see #setAlwaysApplicable(boolean) |
|
| 213 |
* @see #hasChanged() |
|
| 214 |
*/ |
|
| 215 |
public abstract boolean isAlwaysApplicable(); |
|
| 182 | 216 |
} |
Also available in: Unified diff