fr.cnes.genius.highLevel

Class GComponentList

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genius.highLevel.GComponentList

All Implemented Interfaces:

GClear, GCondensedIsModifiedInterface, GCondensedStatusInterface, GDisplay, GReadWrite, MouseWheelListener, EventListener

public class GComponentList
extends GPanel
implements GClear, GReadWrite, GCondensedStatusInterface, GCondensedIsModifiedInterface

Class GComponentList allows handling a list of widgets extending from GComponent. Two modes are available: displaying all the widgets of the list or only one widget at the same time. In every case, a menu is available to get the possibility to insert new widgets, to remove existing ones or to place them at another rank. At last, a special treatment is available for class having Cloneable interface with the possibility to duplicate one element of the list. The class does not include scroll bars in order to display a list larger than the viewable area. The application maker will include GComponentList in a GPanel object with scrolls. It is possible to change the dimension of the list by changing the value of the field « Amount of Items ». The class allows to save / load the component list from a configuration file.

Author:

goesterjf

Default Constraint(s):

Index	Class	Item	Constraint
0	GHeaderPanel	header	"newline , pushx , pushy , growx , growy" (see table below)
1	GLabel	spaceLabel	"newline , height 30"

Default Constraint(s) for header:

Index	Class	Item	Constraint
0, 0	GEntryInt	totalNumberItemsEntry	0, 0, 0, 0 => "newline , split 2" 0, 0, 0, 1 => (null) 0, 0, 1 => "skip 2 , width 50"
0, 1	GEntryInt	currentItemRankEntry	0, 1, 0, 0 => "split 2" 0, 1, 0, 1 => (null) 0, 1, 1 => "width 50"
0, 2	GButton	decrButton	"alignx Right , height 20"
0, 3	GButton	incrButton	"height 20"
0, 4	GPopupList	menu	(null)

Note:

The GLabel "spaceLabel" represents an empty space between the header and the list of items.

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.lowLevel.GPanel

GPanel.Panel, GPanel.ScrollBarVisibility

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GComponentList() Constructor by default
GComponentList(String name, Class<?> classType, boolean singleMode) Constructor only with a class type.
GComponentList(String name, GComponent byDefault, boolean singleMode) Constructor with a default object (used to initialize a new widget element of the list using "clone" method).
GComponentList(String widgetId, String name, Class<?> classType, boolean singleMode) Constructor only with a class type.
GComponentList(String widgetId, String name, GComponent byDefault, boolean singleMode) Constructor with a default object (used to initialize a new widget element of the list using "clone" method).

Method Summary

Modifier and Type	Method and Description
void	add(int rank, GComponent item) Add an item to the list
void	clear() Called when the element is to be cleared, so it can perform the actions required to return to the last saved/loaded values.
void	display() Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.
void	generic() Abstract generic function that need to be implemented by the descendants.
int	getCurrentItemRank() Get the rank of the current item in the list.
GEntryInt	getGEntryRealTotalNumberItems() Getter for the total number of items entry int.
<T> ArrayList<T>	getList() Method returning a list of widgets.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
boolean	isModified() Gets the modification status of the component against the last set of values loaded or saved.
void	read() Implementaion of the routines that allow the component to be loaded from a configuration file.
void	remove(int rank) Remove an item in the list
void	setCurrentElementNumber(int currentNumberOfItems) Set the current number of items in the component list, if the value is not contained in minNumberOfItems <= currentNumberOfItems <= maxNumberOfItems, nothing is done.
void	setCurrentItemRank(int rank) Set the rank of the current item in the list.
protected void	setDefaultConstraints() set the defaults constraints
void	setDefaultItem(GComponent defaultItem) Sets the default item for the list.
void	setDisplayIsModifiedIndicatorAll(GComponent.DisplayIndicatorStatus displayIndicatorStatus) Controls the display of the isModified indicator of all itmes in the list.
void	setEditable(boolean flag) Set the item to be editable or not.
void	setEnabled(boolean flag) Set the enable status of the component.
void	setHeaderToListDistance(int separation) Set separation between header and list in pixels.
void	setLabels(String totalLabelString, String currentLabelString, String itemPrefixString) Set the labels for: The entry field containing the total number of entries.
void	setList(List<GComponent> list) Method testing consistency between the widget list given as an argument and data type classType.
void	setMinMaxElementNumber(Integer minElementNumber, Integer maxElementNumber) Set the minimum and maximum number of items allowed in the component list.
void	setWidgetId(String widgetId) Sets the widget identifier of the component.
void	updateCondensedStatus(GCondensedStatus condensedStatus) Update a condensed status object with the status of one or more components.
void	updateIsModified(GCondensedIsModified condensedIsModified) Update a condensed isModified object with the status of one or more components.
void	write() Implementaion of the routines that allow the component to be saved to a configuration file.

Methods inherited from class fr.cnes.genius.lowLevel.GPanel

clearConstraint, getClassConstraint, getComponent, getHorizontalScroll, getInnerDescendantClassConstraint, getJPanel, getJScrollPane, getLayoutConstraints, getStringClassConstraint, getVerticalScroll, mainClear, mainDisplay, processMouseWheelEvent, put, setClassConstraint, setColumnConstraints, setConstraint, setHorizontalScroll, setInnerDescendantClassConstraint, setLayoutConstraints, setMargins, setPanelConstraints, setPreferredSize, setRowConstraints, setUnitIncrement, setVerticalScroll, unput

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GComponentList

public GComponentList()

Constructor by default

GComponentList

public GComponentList(String name,
                      Class<?> classType,
                      boolean singleMode)

Constructor only with a class type.

Parameters:

name - in the configuration file.

classType - type of the class of the elements of the list.

singleMode - flag to determine if "single widget mode" is selected or not.

GComponentList

public GComponentList(String widgetId,
                      String name,
                      Class<?> classType,
                      boolean singleMode)

Constructor only with a class type.

Parameters:

widgetId - widget identifier.

name - in the configuration file.

classType - type of the class of the elements of the list.

singleMode - flag to determine if "single widget mode" is selected or not.

GComponentList

public GComponentList(String name,
                      GComponent byDefault,
                      boolean singleMode)

Constructor with a default object (used to initialize a new widget element of the list using "clone" method). As a consequence, the class of the object must be the same of the one of the elements of the list.

Parameters:

name - in the configuration file.

byDefault - object used to initialize a new widget element of the list using "clone" method.

singleMode - flag to determine if "single widget mode" is selected or not.

GComponentList

public GComponentList(String widgetId,
                      String name,
                      GComponent byDefault,
                      boolean singleMode)

Constructor with a default object (used to initialize a new widget element of the list using "clone" method). As a consequence, the class of the object must be the same of the one of the elements of the list.

Parameters:

widgetId - widget identifier.

name - in the configuration file.

byDefault - object used to initialize a new widget element of the list using "clone" method.

singleMode - flag to determine if "single widget mode" is selected or not.

Method Detail

setDefaultConstraints

protected final void setDefaultConstraints()

set the defaults constraints

Overrides:

setDefaultConstraints in class GPanel

setWidgetId

public final void setWidgetId(String widgetId)

Sets the widget identifier of the component.

Overrides:

setWidgetId in class GComponent

Parameters:

widgetId - the widget identifier of the component.

setMinMaxElementNumber

public void setMinMaxElementNumber(Integer minElementNumber,
                                   Integer maxElementNumber)

Set the minimum and maximum number of items allowed in the component list.

Parameters:

minElementNumber - minimum number of items, if null do not change the current value.

maxElementNumber - maximum number of items, if null do not change the current value, if -1 do limit the maximum number of items.

setCurrentElementNumber

public void setCurrentElementNumber(int currentNumberOfItems)

Set the current number of items in the component list, if the value is not contained in minNumberOfItems <= currentNumberOfItems <= maxNumberOfItems, nothing is done.

Parameters:

currentNumberOfItems - current number of items in the component list, if the value is not contained in minNumberOfItems <= currentNumberOfItems <= maxNumberOfItems, nothing is done.

setHeaderToListDistance

public final void setHeaderToListDistance(int separation)

Set separation between header and list in pixels.

Parameters:

separation - in pixels.

setDefaultItem

public void setDefaultItem(GComponent defaultItem)

Sets the default item for the list.

Parameters:

defaultItem - item to be set as default one.

updateCondensedStatus

public void updateCondensedStatus(GCondensedStatus condensedStatus)

Update a condensed status object with the status of one or more components. In almost 100% of cases the implementation of this method should just make :

condensedStatus.update(widget1, widget2, etc)

Being widget_i the widgets contained in current component with a status defined. These widgets might be simple components that have redefined the setStatus(GStatus) method or complex components, having other subcomponents and implementing also this interface.

Specified by:

updateCondensedStatus in interface GCondensedStatusInterface

Parameters:

condensedStatus - the condensed status object to be updated.

updateIsModified

public void updateIsModified(GCondensedIsModified condensedIsModified)

Update a condensed isModified object with the status of one or more components. In almost 100% of cases the implementation of this method should just make :

condensedIsModified.update(widget1, widget2, etc)

Being widget_i the widgets contained in current component with a status defined. These widgets might be simple components that have redefined the setStatus(GStatus) method or complex components, having other subcomponents and implementing also this interface.

Specified by:

updateIsModified in interface GCondensedIsModifiedInterface

Parameters:

condensedIsModified - the condensed isModified object to be updated.

setEnabled

public void setEnabled(boolean flag)

Description copied from class: GComponent

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

flag - new enable status of the component.

setEditable

public void setEditable(boolean flag)

Set the item to be editable or not.

Parameters:

flag - if true the item is editable, otherwise not.

getCurrentItemRank

public int getCurrentItemRank()

Get the rank of the current item in the list.

Returns:

the rank of the current item in the list.

setList

public void setList(List<GComponent> list)
             throws GComponentListException

Method testing consistency between the widget list given as an argument and data type classType.

Parameters:

list - list of widget (could be without elements but anyway instanced).

Throws:

GComponentListException - if the list is not compatible in size with the minimum and maximum of the component.

setLabels

public void setLabels(String totalLabelString,
                      String currentLabelString,
                      String itemPrefixString)

Set the labels for: The entry field containing the total number of entries. The entry field containing the current entry number. The prefix for each elements's title.

Parameters:

totalLabelString - label for the field containing the total number of entries.

currentLabelString - label for the field containing the current element number.

itemPrefixString - prefix for each element's title.

generic

public void generic()

Abstract generic function that need to be implemented by the descendants.

Specified by:

generic in class GPanel

read

public void read()
          throws GException

Implementaion of the routines that allow the component to be loaded from a configuration file.

Specified by:

read in interface GReadWrite

Throws:

GException - in case of problem while reading the value from file.

write

public void write()
           throws GException

Implementaion of the routines that allow the component to be saved to a configuration file.

Specified by:

write in interface GReadWrite

Throws:

GException - in case of problem while writing the value to file.

display

public void display()
             throws GException

Description copied from interface: GDisplay

Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.

Specified by:

display in interface GDisplay

Throws:

GException - in case of problem while reading the value from file.

getList

public <T> ArrayList<T> getList()

Method returning a list of widgets.

Type Parameters:

T - Type of the items managed by the list.

Returns:

list of widgets.

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GComponent

Parameters:

position - position of the requested component.

Returns:

the subcomponent occupying the position defined by position.

Throws:

GComponentException - in case the position argument is invalid.

getGEntryRealTotalNumberItems

public GEntryInt getGEntryRealTotalNumberItems()

Getter for the total number of items entry int.

Returns:

the total number of items entry int.

isModified

public boolean isModified()

Gets the modification status of the component against the last set of values loaded or saved.

Overrides:

isModified in class GComponent

Returns:

the modification status of the component against the last set of values loaded or saved.

setDisplayIsModifiedIndicatorAll

public void setDisplayIsModifiedIndicatorAll(GComponent.DisplayIndicatorStatus displayIndicatorStatus)

Controls the display of the isModified indicator of all itmes in the list.

Parameters:

displayIndicatorStatus - if Always the modifiedStatusIndicator is always shown, if Never the modifiedStatusIndicator is never shown, if Automatic the modifiedStatusIndicator is shown as needed.

add

public void add(int rank,
                GComponent item)

Add an item to the list

Parameters:

rank - rank

item - item

remove

public void remove(int rank)

Remove an item in the list

Parameters:

rank - rank

setCurrentItemRank

public void setCurrentItemRank(int rank)

Set the rank of the current item in the list.

Parameters:

rank - the rank of the current item in the list.

clear

public void clear()
           throws GException

Description copied from interface: GClear

Called when the element is to be cleared, so it can perform the actions required to return to the last saved/loaded values.

Specified by:

clear in interface GClear

Throws:

GException - in case of problem while clearing the values.