Package org.gvsig.gui.beans.panelGroup.panels

Interface IPanel

All Superinterfaces:

Comparable<IPanel>

All Known Implementing Classes:

AbstractFilterQueryJPanel, AbstractPanel, FilterQueryJPanel, TableFilterQueryJPanel, TreePanel.DefaultPanel

public interface IPanel
extends Comparable<IPanel>

Common interface for all kinds of AbstractPanel.

An IPanel has:

• Three identifiers:
• ID: (optional) identifies neutrally the panel.
• Label: identifier of the panel, used by a AbstractPanelGroup.
• LabelGroup: identifier of the panel used to group together different IPanel panels of a AbstractPanelGroup.
• 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).

Version:

15/10/2007

Author:

Pablo Piqueras Bartolomé (pablo.piqueras@iver.es)

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

getID

String getID()

Gets the panel identifier.

.

Returns:

panel identifier, or null if undefined

See Also:

• setID(String)

getLabel

String getLabel()

Gets the identifier of the panel used by a AbstractPanelGroup.

Returns:

panel label identifier, or null if undefined

See Also:

• setLabel(String)

getLabelGroup

String getLabelGroup()

Gets the identifier of the panel used to group together different IPanel panels in a AbstractPanelGroup.

Returns:

panel label group identifier, or null if undefined

See Also:

• setLabelGroup(String)

setID

void setID(String id)

Sets the identifier of the panel used by a AbstractPanelGroup.

Parameters:

id - panel label identifier, or null if undefined

See Also:

• getID()

setLabel

void setLabel(String label)

Sets the identifier of the panel used by a AbstractPanelGroup.

Parameters:

label - panel label identifier, or null if undefined

See Also:

• getLabel()

setLabelGroup

void setLabelGroup(String labelGroup)

Sets the identifier of the panel used to group together different IPanel panels of a AbstractPanelGroup.

Parameters:

labelGroup - label group identifier, or null if undefined

See Also:

• getLabelGroup()

getReference

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.

Returns:

object that has reference this panel, or null if there has reference to no object

See Also:

• setReference(Object)

setReference

void setReference(Object ref)

Sets a reference to an object that is ''semantically' or 'contextually' related to this panel.

Parameters:

ref - an object

See Also:

• getReference()

getPanelGroup

AbstractPanelGroup getPanelGroup()

Gets a reference to the object that contains the group which this panel is a member.

Returns:

an object that contains this panel's group

See Also:

• setPanelGroup(AbstractPanelGroup)

setPanelGroup

void setPanelGroup(AbstractPanelGroup panelGroup)

Sets a reference to the object that contains the group which this panel is a member.

Parameters:

panelGroup - object that contains this panel's group

See Also:

• getPanelGroup()

setInGroupGUI

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.

Parameters:

b - the new visibility for that panel.

isInGroupGUI

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.

Returns:

true if this panel belongs to a 'panel group' and it's loaded in the graphical user interface of that component

remainsWithItsDefaultPreferredSize

boolean remainsWithItsDefaultPreferredSize()

Returns if this panel remains with its initial preferred size of it has been changed.

Returns:

if this panel remains with its initial preferred size of it has been changed

accept

void accept()

Notifies to this panel of an accept action.

apply

void apply()

Notifies this panel of an apply action.

cancel

void cancel()

Notifies this panel of a cancel action.

selected

void selected()

Notifies this panel that has been selected at the AbstractPanelGroup

hasChanged

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.

Returns:

true if this panel has changed since it was created, or applied (or accepted or cancelled); otherwise false

resetChangedStatus

void resetChangedStatus()

Resets this panel changed status to its initial value.

setAlwaysApplicable

void setAlwaysApplicable(boolean b)

Sets if this panel will always be applied and accepted (by default), or only when has changed.

Parameters:

b - if this panel will always be applied and accepted, or only when has changed

See Also:

• isAlwaysApplicable()
• hasChanged()

isAlwaysApplicable

boolean isAlwaysApplicable()

Gets if this panel will always be applied and accepted (by default), or only when has changed.

Returns:

if this panel will always be applied and accepted, or only when has changed

See Also:

• setAlwaysApplicable(boolean)
• hasChanged()

getPriority

int getPriority()

The priority of this properties page. When more high is the priority more to the left are set properties page.

Returns:

the priority of the properties page

setPriority

void setPriority(int priority)

Sets priority of this properties page. When more high is the priority more to the left are set properties page.