public interface IPanelGroup
All kind of panels which support a group of IPanel
must
implement this interface.
Modifier and Type | Method and Description |
---|---|
void |
accept()
Notifies this panel of an accept action.
|
void |
addPanel(IPanel panel)
Adds another
IPanel to this group. |
void |
apply()
Notifies this panel of an apply action.
|
void |
cancel()
Notifies this panel of a cancel action.
|
IPanel |
getActivePanel()
Gets a reference to the active panel in this group.
|
int |
getPanelCount()
Returns the number of panels registered in this group.
|
int |
getPanelInGUICount()
Returns the number of panels registered in this group that are in GUI.
|
Hashtable |
getProperties()
Gets the properties associated to this group of panels.
|
Object |
getReference()
Gets the object that has a a ''semantically'' or ''conceptually'' relation to this panel.
|
boolean |
isAccepted()
Determines if the last notification received has been IPanel.accept().
|
boolean |
isPanelInGUI(IPanel panel)
Returns
true if the panel as parameter belongs to a this group and it's loaded in the graphical user interface;
otherwise returns false . |
void |
loadPanels(IPanelGroupLoader loader)
Tries to load as most as possible panels using an
IPanelGroupLoader . |
void |
removePanel(IPanel panel)
Removes an
IPanel from this group. |
void |
setPanelInGUI(IPanel panel,
boolean b)
Changes the visibility of an existent panel of this group.
|
void |
setParentPanelGroup(IPanelGroup parent)
Sets the parent of this component.
|
void |
updateReference(Object reference)
Updates the reference of all elements of the group with the new one.
|
void addPanel(IPanel panel) throws BaseException
Adds another IPanel
to this group.
panel
- the IPanel
to addEmptyPanelGroupException
- if there was no panel loaded and tries to add a new one, launches this exception
if the panel to add hasn't been registered to this component and then, no remains without panelsEmptyPanelGroupGUIException
- if there was no panel loaded and tries to add a new one, launches this exception
if the panel to add hasn't been set to this component graphical interface and then, no remains without panels
in its graphical interfaceBaseException
loadPanels(IPanelGroupLoader)
,
removePanel(IPanel)
void removePanel(IPanel panel)
Removes an IPanel
from this group.
panel
- the IPanel
to removeaddPanel(IPanel)
,
loadPanels(IPanelGroupLoader)
void loadPanels(IPanelGroupLoader loader) throws ListCouldntAddPanelException, EmptyPanelGroupException, EmptyPanelGroupGUIException
Tries to load as most as possible panels using an IPanelGroupLoader
.
loader
- used to load the panels into this groupListCouldntAddPanelException
- list with all exceptions produced loading and adding the panelsEmptyPanelGroupException
- launched if there was no exception during the loading and adding processes
but there is no panel registered finally in this componentEmptyPanelGroupGUIException
- launched if there was no exception during the loading and adding processes
there is at least one panel registered, but finally none of them is in the graphical interface of this componentaddPanel(IPanel)
IPanel getActivePanel()
Gets a reference to the active panel in this group.
null
if there is no any activeHashtable getProperties()
Gets the properties associated to this group of panels.
Object getReference()
Gets the object that has a a ''semantically'' or ''conceptually'' relation to this panel.
null
if there has reference
to no objectvoid updateReference(Object reference)
Updates the reference of all elements of the group with the new one.
reference
- type of object that has reference this panel, or null
if there has reference
to no objectvoid setPanelInGUI(IPanel panel, boolean b)
Changes the visibility of an existent panel of this group. If a panel changes to invisible, then that 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 that panel.
panel
- reference to the panel with visibility has changed.b
- the new visibility for that panel.boolean isPanelInGUI(IPanel panel)
Returns true
if the panel as parameter belongs to a this group and it's loaded in the graphical user interface;
otherwise returns false
.
true
if the panel as parameter belongs to a this group and it's loaded in the graphical user interface;
otherwise returns false
int getPanelCount()
Returns the number of panels registered in this group.
int getPanelInGUICount()
Returns the number of panels registered in this group that are in GUI.
boolean isAccepted()
Determines if the last notification received has been IPanel.accept().
true
if that has been the last notification received, false
otherwisevoid setParentPanelGroup(IPanelGroup parent)
Sets the parent of this component. That object must be another IPanelGroup
component.
parent
- parent of this componentvoid accept()
Notifies this panel of an accept action.
void apply()
Notifies this panel of an apply action.
void cancel()
Notifies this panel of a cancel action.