GList (Genius 1.13.1 API)

java.lang.Object
- fr.cnes.genius.main.GComponent
- - fr.cnes.genius.lowLevel.GList

All Implemented Interfaces:

GDisplay, MouseWheelListener, EventListener, ListSelectionListener
```
public class GList
extends GComponent
implements GDisplay, ListSelectionListener
```
Class to implement a GENIUS version of JList.

Author:

goesterjf HISTORIQUE VERSION:1.11:FA:FA-1144:10/11/2021:[GENIUS] Correction des non-conformites résiduelles GENIUS 1.10 VERSION:1.11:DM:DM-949:10/11/2021:[GENIUS] Prise en compte equations simples dans GPlotPanel VERSION:1.10:DM:DM-877:09/12/2020:[GENIUS] Evolutions GList VERSION:1.9:DM:DM-624:08/08/2019:[GENIUS] Plots provenant de fichiers differents dans GPlotPanel VERSION:1.9:DM:DM-605:08/08/2019:[GENIUS] Objet Glist VERSION:1.9:FA:FA-604:08/08/2019:[GENIUS/GENOPUS] Remarques documentaire - Bilan qualite v1.0 FIN-HISTORIQUE

Nested Class Summary
- 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
`GList()` Constructor without arguments.
`GList(List<String> listOfAvailData)` Constructor with a predefined list as arguments.
`GList(String widgetId)` Constructor with widgetId as arguments.
`GList(String widgetId, List<String> listOfAvailData)` Constructor with a widget Id and a predefined list as arguments.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addElement(int index, String element)` Method for adding an element in the list.
`void`	`addElements(List<String> list)` Method to add a list of elements (at the end of the current list).
`void`	`clear()` Removes all of the elements from this list.
`boolean`	`containsElement(String element)` Return true if the string element is found in the list
`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.
`Component`	`getComponent()` Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
`JList`	`getJList()` Returns the low level List Component encapsulated by the class if any, otherwise returns null.
`List<String>`	`getListOfData()` Method returning the content of the complete list.
`int[]`	`getSelectedIndexes()` Method returning a table of the selected indexes.
`List<String>`	`getSelectedValues()` Method returning the list of selected values.
`int`	`getSize()` Method returning the content of the complete list.
`void`	`moveElementDown(int index)` Method to move down an element
`void`	`moveElementsDown(int[] indexes)` Method to move down a list of elements.
`void`	`moveElementsUp(int[] indexes)` Method to move up a list of elements.
`void`	`moveElementUp(int index)` Method to move up an element
`void`	`removeAllElements()` Method for removing all elements of the list.
`void`	`removeElement(int index)` Method for removing an element in the list.
`void`	`removeElements(int[] indexes)` Method for removing a list of elements.
`void`	`setEnabled(boolean b)` Set the enable status of the component.
`void`	`setIndexes(int[] indexes)` Method setting the indexes to be selected.
`void`	`setLayoutOrientation(int orientation)` Method allowing to define the list orientation.
`void`	`setListOfData(List<String> newListOfData)` Set the list of data
`void`	`setSelectionMode(int mode)` Method allowing to define the selection mode.
`void`	`setVisibleRowCount(int count)` Sets the visibleRowCount property
`void`	`valueChanged(ListSelectionEvent e)`

Methods inherited from class fr.cnes.genius.main.GComponent
activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, 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
  - GList
```
public GList(String widgetId,
             List<String> listOfAvailData)
```
    Constructor with a widget Id and a predefined list as arguments.
    
    Parameters:
    
    widgetId - widget Id.
    
    listOfAvailData - list of elements.
  - GList
```
public GList(List<String> listOfAvailData)
```
    Constructor with a predefined list as arguments.
    
    Parameters:
    
    listOfAvailData - list of elements.
  - GList
```
public GList()
```
    Constructor without arguments.
  - GList
```
public GList(String widgetId)
```
    Constructor with widgetId as arguments.
    
    Parameters:
    
    widgetId - widget Id.
- Method Detail
  - display
```
public void display()
```
    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
  - getComponent
```
public Component getComponent()
```
    Description copied from class: GComponent
    
    Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
    
    Overrides:
    
    getComponent in class GComponent
    
    Returns:
    
    the Swing Component encapsulated by the class if any, otherwise returns null.
  - setSelectionMode
```
public void setSelectionMode(int mode)
```
    Method allowing to define the selection mode.
    
    Parameters:
    
    mode - selection mode: ListSelectionModel.SINGLE_SELECTION ListSelectionModel.SINGLE_INTERVAL_SELECTION ListSelectionModel.MULTIPLE_INTERVAL_SELECTION).
  - setLayoutOrientation
```
public void setLayoutOrientation(int orientation)
```
    Method allowing to define the list orientation.
    
    Parameters:
    
    orientation - list orientation: JList.VERTICAL JList.VERTICAL_WRAP JList.HORIZONTAL_WRAP
  - addElement
```
public void addElement(int index,
                       String element)
```
    Method for adding an element in the list.
    
    Parameters:
    
    index - index where to include the element
    
    element - element to include
  - addElements
```
public void addElements(List<String> list)
```
    Method to add a list of elements (at the end of the current list).
    
    Parameters:
    
    list - list of elements to add.
  - removeAllElements
```
public void removeAllElements()
```
    Method for removing all elements of the list.
  - removeElement
```
public void removeElement(int index)
```
    Method for removing an element in the list.
    
    Parameters:
    
    index - index of the element to remove
  - removeElements
```
public void removeElements(int[] indexes)
```
    Method for removing a list of elements.
    
    Parameters:
    
    indexes - table including indexes of elements to remove.
  - moveElementUp
```
public void moveElementUp(int index)
```
    Method to move up an element
    
    Parameters:
    
    index - index of the element to move.
  - moveElementsUp
```
public void moveElementsUp(int[] indexes)
```
    Method to move up a list of elements.
    
    Parameters:
    
    indexes - table of indexes of the elements to move.
  - moveElementDown
```
public void moveElementDown(int index)
```
    Method to move down an element
    
    Parameters:
    
    index - index of the element to move.
  - moveElementsDown
```
public void moveElementsDown(int[] indexes)
```
    Method to move down a list of elements.
    
    Parameters:
    
    indexes - table of indexes of the elements to move.
  - getSelectedIndexes
```
public int[] getSelectedIndexes()
```
    Method returning a table of the selected indexes.
    
    Returns:
    
    table of the selected indexes
  - setIndexes
```
public void setIndexes(int[] indexes)
```
    Method setting the indexes to be selected.
    
    Parameters:
    
    indexes - table of indexes to be selected.
  - getSelectedValues
```
public List<String> getSelectedValues()
```
    Method returning the list of selected values.
    
    Returns:
    
    content of the list
  - getListOfData
```
public List<String> getListOfData()
```
    Method returning the content of the complete list.
    
    Returns:
    
    content of the complete list
  - getSize
```
public int getSize()
```
    Method returning the content of the complete list.
    
    Returns:
    
    content of the complete list
  - setEnabled
```
public void setEnabled(boolean b)
```
    Set the enable status of the component.
    
    Overrides:
    
    setEnabled in class GComponent
    
    Parameters:
    
    b - new enable status of the component.
  - clear
```
public void clear()
```
    Removes all of the elements from this list. The list will be empty after this call returns.
  - containsElement
```
public boolean containsElement(String element)
```
    Return true if the string element is found in the list
    
    Parameters:
    
    element - the element to find
    
    Returns:
    
    true if the element is present in the list, false otherwise
  - setListOfData
```
public void setListOfData(List<String> newListOfData)
```
    Set the list of data
    
    Parameters:
    
    newListOfData - the new data
  - getJList
```
public JList getJList()
```
    Returns the low level List Component encapsulated by the class if any, otherwise returns null.
    
    Returns:
    
    the List Component encapsulated by the class if any, otherwise returns null.
  - setVisibleRowCount
```
public void setVisibleRowCount(int count)
```
    Sets the visibleRowCount property
    
    Parameters:
    
    count - visible row count
  - valueChanged
```
public void valueChanged(ListSelectionEvent e)
```
    Specified by:
    
    valueChanged in interface ListSelectionListener

Class GList

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

GList

GList

GList

GList

Method Detail

display

getComponent

setSelectionMode

setLayoutOrientation

addElement

addElements

removeAllElements

removeElement

removeElements

moveElementUp

moveElementsUp

moveElementDown

moveElementsDown

getSelectedIndexes

setIndexes

getSelectedValues

getListOfData

getSize

setEnabled

clear

containsElement

setListOfData

getJList

setVisibleRowCount

valueChanged