public interface IPanel extends Comparable<IPanel>
Common interface for all kinds of AbstractPanel
.
An IPanel has:
AbstractPanelGroup
.IPanel
panels
of a AbstractPanelGroup
.Modifier and Type | Method and Description |
---|---|
void |
accept()
Notifies to this panel of an accept action.
|
void |
apply()
Notifies this panel of an apply action.
|
void |
cancel()
Notifies this panel of a cancel action.
|
String |
getID()
Gets the panel identifier.
|
String |
getLabel()
Gets the identifier of the panel used by a
AbstractPanelGroup . |
String |
getLabelGroup()
Gets the identifier of the panel used to group together different
IPanel panels
in a AbstractPanelGroup . |
AbstractPanelGroup |
getPanelGroup()
Gets a reference to the object that contains the group which this panel is a member.
|
int |
getPriority()
The priority of this properties page.
|
Object |
getReference()
Gets the object that has a ''semantically'' or ''conceptually'' relation to this panel, this is used to group
IPanel panels on a IPanelGroup object. |
boolean |
hasChanged()
Determines if this panel has changed since it was created, or applied (or accepted or cancelled).
|
boolean |
isAlwaysApplicable()
Gets if this panel will always be applied and accepted (by default), or only when has changed.
|
boolean |
isInGroupGUI()
Returns
true if this panel belongs to a 'panel group' and it's loaded in the graphical user interface
of that component; otherwise returns false . |
boolean |
remainsWithItsDefaultPreferredSize()
Returns if this panel remains with its initial preferred size of it has been changed.
|
void |
resetChangedStatus()
Resets this panel changed status to its initial value.
|
void |
selected()
Notifies this panel that has been selected at the
AbstractPanelGroup |
void |
setAlwaysApplicable(boolean b)
Sets if this panel will always be applied and accepted (by default), or only when has changed.
|
void |
setID(String id)
Sets the identifier of the panel used by a
AbstractPanelGroup . |
void |
setInGroupGUI(boolean b)
If this panel belongs to a 'panel group', changes its visibility at the interface of the panel group.
|
void |
setLabel(String label)
Sets the identifier of the panel used by a
AbstractPanelGroup . |
void |
setLabelGroup(String labelGroup)
Sets the identifier of the panel used to group together different
IPanel panels
of a AbstractPanelGroup . |
void |
setPanelGroup(AbstractPanelGroup panelGroup)
Sets a reference to the object that contains the group which this panel is a member.
|
void |
setPriority(int priority)
Sets priority of this properties page.
|
void |
setReference(Object ref)
Sets a reference to an object that is ''semantically' or 'contextually' related to this panel.
|
compareTo
String getID()
Gets the panel identifier.
.null
if undefinedsetID(String)
String getLabel()
Gets the identifier of the panel used by a AbstractPanelGroup
.
null
if undefinedsetLabel(String)
String getLabelGroup()
Gets the identifier of the panel used to group together different IPanel
panels
in a AbstractPanelGroup
.
null
if undefinedsetLabelGroup(String)
void setID(String id)
Sets the identifier of the panel used by a AbstractPanelGroup
.
id
- panel label identifier, or null
if undefinedgetID()
void setLabel(String label)
Sets the identifier of the panel used by a AbstractPanelGroup
.
label
- panel label identifier, or null
if undefinedgetLabel()
void setLabelGroup(String labelGroup)
Sets the identifier of the panel used to group together different IPanel
panels
of a AbstractPanelGroup
.
labelGroup
- label group identifier, or null
if undefinedgetLabelGroup()
Object getReference()
Gets the object that has a ''semantically'' or ''conceptually'' relation to this panel, this is used to group
IPanel
panels on a IPanelGroup
object.
null
if there has reference
to no objectsetReference(Object)
void setReference(Object ref)
Sets a reference to an object that is ''semantically' or 'contextually' related to this panel.
ref
- an objectgetReference()
AbstractPanelGroup getPanelGroup()
Gets a reference to the object that contains the group which this panel is a member.
setPanelGroup(AbstractPanelGroup)
void setPanelGroup(AbstractPanelGroup panelGroup)
Sets a reference to the object that contains the group which this panel is a member.
panelGroup
- object that contains this panel's groupgetPanelGroup()
void setInGroupGUI(boolean b)
If this panel belongs to a 'panel group', changes its visibility at the interface of the panel group. If changes to invisible, then this panel won't be accessible by the user interface. But if changes to visible and was invisible before, then will appear at the same position it was in the user interface. The position is according the order of the insertion at the group. Anyway, the group will have this panel.
b
- the new visibility for that panel.boolean isInGroupGUI()
Returns true
if this panel belongs to a 'panel group' and it's loaded in the graphical user interface
of that component; otherwise returns false
.
true
if this panel belongs to a 'panel group' and it's loaded in the graphical user interface
of that componentboolean remainsWithItsDefaultPreferredSize()
Returns if this panel remains with its initial preferred size of it has been changed.
void accept()
Notifies to this panel of an accept action.
void apply()
Notifies this panel of an apply action.
void cancel()
Notifies this panel of a cancel action.
void selected()
Notifies this panel that has been selected at the AbstractPanelGroup
boolean hasChanged()
Determines if this panel has changed since it was created, or applied (or accepted or cancelled). The
programmer of each panel will be whom would set to true
that a panel has changed.
true
if this panel has changed since it was created, or applied (or accepted or cancelled); otherwise false
void resetChangedStatus()
Resets this panel changed status to its initial value.
void setAlwaysApplicable(boolean b)
Sets if this panel will always be applied and accepted (by default), or only when has changed.
b
- if this panel will always be applied and accepted, or only when has changedisAlwaysApplicable()
,
hasChanged()
boolean isAlwaysApplicable()
Gets if this panel will always be applied and accepted (by default), or only when has changed.
setAlwaysApplicable(boolean)
,
hasChanged()
int getPriority()
void setPriority(int priority)