GComponent (Genius 1.13.1 API)

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

All Implemented Interfaces:

MouseWheelListener, EventListener

Direct Known Subclasses:

GButton, GCheckBox, GComboBox, GContainer, GEntryVectorAbstract, GFrame, GFreeChartXY, GHyperlinkLabel, GImage, GLabel, GList, GLogEventTable, GMenu, GMenuBar, GMenuItem, GPanel, GPopupMenu, GProgressBar, GRadioButton, GSeparator, GSliderAbstract, GSplitPane, GTabbedPane, GTable, GTextArea, GTextField, GToggleButton, GTree
```
public class GComponent
extends Object
implements MouseWheelListener
```
Basic class of the GENIUS library, it is the base class used to represent all the GENIUS widgets. All classes of widgets inherit of class GComponent. It allows:
- Defining basic mechanisms of display,
- Handling of names, units, comments, and data groups to save / load data from configuration files,
- Creating and updating widgets hierarchy and identification of the display panel,
- Activating / deactivating the widget,
- Commanding the focus, in order to navigate from a widget to another widget using keys «Enter» and «Tab»,
- Defining a protocol that allows to determine if the value represented by a widget is modified with respect to last values saved in the file,
- Handling widgets identifiers.
Author:

jjct

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GComponent.CopyPasteOperation` Enum of the available copy-paste operations.
`protected static class`	`GComponent.DisplayIndicatorStatus` Enum to determine if the ismModifiedIndicator shall be displayed: always, never, automatic.
`static class`	`GComponent.ItemType` Enum represeting the type of items that can be saved in a configuration file.
`static class`	`GComponent.Operation` Enum to determine the operation that shall be performed by the put method.

Field Summary

Fields
Modifier and Type Field and Description

protected static String NAME_ATTRIBUTE
String constant.

Fields
Modifier and Type	Field and Description
`protected static String`	`NAME_ATTRIBUTE` String constant.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`GComponent()` Constructor by default
`protected`	`GComponent(String widgetId)` Creates a component with the corresponding widgetId, if the widgetId is null, it will be created automatically.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`activateConstraintsByType(Class<?> className)` Switch method to activate the functionality to set constraints by class for a given class. Example: To set a width of 500 to the GRealField of all the GEntryReals in current panel: `setClassConstraint(GEntryReal.class, 1, new GConstraint(GConstraint.width(500)));`
`void`	`attachCopyPasteMenu()` Attach the copy and paste menu to this component.
`void`	`attachCopyPasteMenu(String label, GComponent.CopyPasteOperation... operationList)` Attach the copy and paste menu to this component.
`protected void`	`beginOfElement(GItemTypeInterface type, String name)` Begins an XML structural element of a given type and with a given name when loading/saving to the configuration file.
`protected void`	`beginOfElement(GItemTypeInterface type, String name, Boolean allowWriteComment)` Begins an XML structural element of a given type and with a given name when loading/saving to the configuration file.
`protected void`	`beginOfElement(String type, String name)` Begins an XML structural element of a given type and with a given name when loading/saving to the configuration file.
`protected void`	`beginOfElement(String type, String name, Boolean allowWriteComment)` Begins an XML structural element of a given type and with a given name when loading/saving to the configuration file.
`void`	`clearAllInnerDescendantConstraint()` Method to clear the constraints for a given component and all its sub-components recursively.
`void`	`clearConstraint()` Clears the constraint for the component.
`void`	`clearInnerDescendantContraint(int... positionList)` Clears the constraint of the inner subcomponent.
`protected String`	`composeWidgetId(String finalWidgetId)` Compose the widget id by adding "." to the value returned by getWidgetId.
`void`	`doDisplay(GComponent component)` Perform the display of the internal component.
`protected void`	`endOfElement()` Ends an element, previously generated with beginOfElement, when loading/saving to file.
`String`	`getCommentInConfigFile()` Gets the comment to be set in the configuration file.
`Component`	`getComponent()` Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
`GConstraint`	`getConstraint()` Return the current component constraint.
`protected static GComponent.Operation`	`getCurrentOperation()` Gets the current skeleton index.
`GComponent.DisplayIndicatorStatus`	`getDisplayIndicatorStatus()` Get the display indicator status.
`boolean`	`getDisplayIsModifiedIndicator()` Get the displayIsModifiedIdicator.
`org.jdom.Element`	`getElement()` Gets the XML DOM element that will be used to store/load the component value from file.
`String`	`getGClassName()` Method to get the class name scaping the "$" character for the internal classes.
`GPanel`	`getGPanel()` Gets the current panel containing the component.
`GComponent`	`getGParent()` Get the component that is the parent of this component.
`GUnit`	`getGUnitInConfigFile()` Gets the GUnit to use to save the component in the configuration file.
`GConstraint`	`getInnerDescendantConstraint(Integer... positionList)` Get the constraint of the inner subcomponent.
`String`	`getName()` Get the name of the component at Swing level, if no Swing component is assigned to this GComponent then the class name is returned.
`String`	`getNameInConfigFile()` Get the name to be used when saving the component in the configuration file.
`protected static boolean`	`getOperationSaveValue()` Gets the boolean indicating if the operation shall update the saved not.
`String`	`getPathInConfigFile()` Get the path of current component respect to the configuration file structure
`String`	`getSimpleWidgetId()` Get the last part of the Swing name (identifier) of the component (after last ".").
`GIntervalAbstract.GStatus`	`getStatus()` Get the status of the widget.
`String`	`getStringConstraint()` Return the current component constraint.
`GComponent`	`getSubComponent(int position)` Gets the subcomponent occupying the position defined by position.
`String`	`getWidgetId()` Get the Swing name (identifier) of the component, no Swing component is encapsulated then null is returned.
`protected boolean`	`handleCopyPasteEvent(GComponent copyPasteMenuComponent, GComponent componentToBeHandled, GEvent event)` Handles the copy-paste event if possible.
`protected boolean`	`handleCopyPasteEvent(GComponent copyPasteMenuComponent, GEvent event)` Handles the copy-paste event if possible.
`protected static void`	`handleProcessEventException(GException ex)` Show the exception dialog to display an exception.
`GComponent.CopyPasteOperation`	`isCopyPasteEvent(GEvent event)` Checks if the event corresponds to one of the copy and paste menu operations.
`boolean`	`isEnabled()` Gets the enable status of the widget.
`GIntervalAbstract.GStatus`	`isForcedStatus()` Returns the forced status, null if undefined.
`boolean`	`isModified()` Gets the modification status of the component against the last set of values loaded or saved.
`protected void`	`launchInvalidPositionException(int position)` Launch an invalid position exception.
`void`	`mouseWheelMoved(MouseWheelEvent e)`
`static String`	`parseSimpleConstraint(String simpleConstraint, String prevConstraint)` Parse a new simple constraint in string format.
`protected static void`	`processGEvent(GEvent event, GComponent source)` Process an event generated by a descendant component.
`void`	`processMouseWheelEvent(MouseWheelEvent e)` Allows the user to scroll while the mouse cursor is on the panel and not exclusively when the cursor is on the scrollbar.
`void`	`setBusyCursor(boolean flag)` Set or clear the busy mouse cursor for the component.
`void`	`setCommentInConfigFile(String comment)` Sets the comment to be set in the configuration file.
`void`	`setConstraint(GConstraint constraint)` Set the constraint for the component.
`void`	`setCopyPasteMenuEnabled(boolean flag)` Set the enable status of the copy-paste menu associated to the component.
`protected static void`	`setCurrentOperation(GComponent.Operation operation, boolean operationSaveValue)` Sets the value of the current operation.
`protected void`	`setDataForConstraintsByType(Class<?> ownerClass, Integer... positionArray)` Setter for the father type and the subcomponent rank into the father type for constraints by class. Example: To set a width of 500 to the GTextField of all the GEntryReals in current panel: `setClassConstraint(GEntryReal.class, 1, new GConstraint(GConstraint.width(1000)));` In order to make this possible, GTextField in its doDiplay must know that it is a part of a GEntryReal, and that it is the subcomponent "1" of the GEntryReal.
`protected void`	`setDefaultConstraints()` Set default constraints.
`void`	`setDisplayIsModifiedIndicator(GComponent.DisplayIndicatorStatus displayIndicatorStatus)` Activates the display of the isModified indicator.
`void`	`setElement(org.jdom.Element element)` Sets the XML DOM element that will be used to store/load the component value from file.
`void`	`setEnabled(boolean flag)` Set the enable status of the component.
`void`	`setForcedStatus(GIntervalAbstract.GStatus forcedStatus)` Set the forced status.
`void`	`setGPanel(GPanel panel)` Sets the current panel containing the component.
`void`	`setGParent(GComponent parent)` Sets the component that is the parent of this component.
`void`	`setGUnitInConfigFile(GUnit unit)` Sets the GUnit to use to save the component in the configuration file.
`void`	`setInnerDescendantConstraint(GConstraint constraint, Integer... positionList)` Set the constraint of the inner subcomponent.
`void`	`setName()` Set the Swing name (identifier) of the component to the widgetId.
`protected void`	`setNameAndCommentInConfigFile(String text)` Sets the name and the comment of the item in the configuration file.
`void`	`setNameInConfigFile(String name)` Sets the name to be used when saving the component in the configuration file.
`void`	`setPathInConfigFile(String path)` Sets the Path to be used when saving the component in the configuration file.
`protected void`	`setStatus(GIntervalAbstract.GStatus status)` Set the status of the widget.
`void`	`setStringConstraint(String simpleConstraint)` Set the constraint in string format for the component.
`void`	`setToolTipText(String text)` Empty method to be overwrite by the components at a higher level if needed.
`void`	`setWidgetId(String widgetId)` Sets the widget identifier of the component.
`protected boolean`	`setWidth(Integer minWidth, Integer preferredWidth, Integer maxWidth)` Method to modify the width of a GComponent.
`static void`	`setWindowBusyCursor(boolean flag, GComponent component)`
`protected void`	`updateIsModifiedIndicator()` Updates the isModified indicator, this method shall be overwritten by the child classes that need to.
`protected org.jdom.Element`	`writeCollection(org.jdom.Element parentElement, GItemTypeInterface type, String name, Map<String,String> attributes)` Writes a collection to the configuration file.
`protected org.jdom.Element`	`writeCollection(org.jdom.Element parentElement, GItemTypeInterface type, String name, Map<String,String> attributes, Boolean allowWriteComment)` Writes a collection to the configuration file.
`protected org.jdom.Element`	`writeCollection(org.jdom.Element parentElement, String type, String name, Map<String,String> attributes, Boolean allowWriteComment)` Deprecated. The argument type should be an enum implementing the interface GItemTypeInterface instead of a String. See `GItemTypeInterface` for more details.
`protected org.jdom.Element`	`writeCollection(GItemTypeInterface type, String name, Map<String,String> attributes)` Writes a collection to the configuration file.
`protected org.jdom.Element`	`writeConfigItem(org.jdom.Element parentElement, GItemTypeInterface type, String name, String value, Map<String,String> attributes)` Writes the values of an item in the configuration file.
`protected org.jdom.Element`	`writeConfigItem(org.jdom.Element parentElement, GItemTypeInterface type, String name, String value, Map<String,String> attributes, Boolean allowWriteComment)` Writes the values of an item in the configuration file.
`protected org.jdom.Element`	`writeConfigItem(org.jdom.Element parentElement, String type, String name, String value, Map<String,String> attributes, Boolean allowWriteComment)` Deprecated. The argument type should be an enum implementing the interface GItemTypeInterface instead of a String. See `GItemTypeInterface` for more details.
`protected void`	`writeConfigItem(GItemTypeInterface type, String value, Map<String,String> attributes)` Writes the values of an item in the configuration file.
`protected void`	`writeConfigItem(GItemTypeInterface type, String value, Map<String,String> attributes, Boolean allowWriteComment)` Writes the values of an item in the configuration file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME_ATTRIBUTE
```
protected static final String NAME_ATTRIBUTE
```
    String constant.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GComponent
```
public GComponent()
```
    Constructor by default
  - GComponent
```
protected GComponent(String widgetId)
```
    Creates a component with the corresponding widgetId, if the widgetId is null, it will be created automatically.
    
    Parameters:
    
    widgetId - identifier of the widget.
- Method Detail
  - getSubComponent
```
public GComponent getSubComponent(int position)
                           throws GComponentException
```
    Gets the subcomponent occupying the position defined by position.
    
    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.
  - getInnerDescendantConstraint
```
public GConstraint getInnerDescendantConstraint(Integer... positionList)
```
    Get the constraint of the inner subcomponent.
    
    Parameters:
    
    positionList - the ordered subcomponent index.
    
    Returns:
    
    the constraint of the inner subcomponent.
  - setInnerDescendantConstraint
```
public void setInnerDescendantConstraint(GConstraint constraint,
                                         Integer... positionList)
```
    Set the constraint of the inner subcomponent.
    
    Parameters:
    
    constraint - constraint to set.
    
    positionList - the ordered subcomponent index.
  - attachCopyPasteMenu
```
public void attachCopyPasteMenu()
```
    Attach the copy and paste menu to this component. All the operations are choose: Copy, Paste, Import, Export.
  - attachCopyPasteMenu
```
public void attachCopyPasteMenu(String label,
                                GComponent.CopyPasteOperation... operationList)
```
    Attach the copy and paste menu to this component. The operations can be choosen using the operationList parameter: Copy, Paste, Import, Export.
    
    Parameters:
    
    label - of the copy&paste menu, if null no label is displayed.
    
    operationList - list of operations to set in the menu. Valid values are Copy if the "Copy" menu is available, Paste if the "Paste" menu is available, Import if the "Import" menu is available, and Export if the "Export" menu is available.
  - isCopyPasteEvent
```
public GComponent.CopyPasteOperation isCopyPasteEvent(GEvent event)
```
    Checks if the event corresponds to one of the copy and paste menu operations.
    
    Parameters:
    
    event - to check.
    
    Returns:
    
    the operation matching the event of null if the event do not correspond to the copy and paste menu.
  - handleCopyPasteEvent
```
protected boolean handleCopyPasteEvent(GComponent copyPasteMenuComponent,
                                       GEvent event)
                                throws GFileManipulatorException
```
    Handles the copy-paste event if possible. The component to be handled is this.
    
    Parameters:
    
    copyPasteMenuComponent - component that has the attached copy-paste menu.
    
    event - to be processed.
    
    Returns:
    
    true if the event was processed, false otherwise.
    
    Throws:
    
    GFileManipulatorException - in case the copy-paste operation raises an exception.
  - handleCopyPasteEvent
```
protected boolean handleCopyPasteEvent(GComponent copyPasteMenuComponent,
                                       GComponent componentToBeHandled,
                                       GEvent event)
                                throws GFileManipulatorException
```
    Handles the copy-paste event if possible.
    
    Parameters:
    
    copyPasteMenuComponent - component that has the attached copy-paste menu.
    
    componentToBeHandled - the component to be copied/pasted/imported/exported.
    
    event - to be processed.
    
    Returns:
    
    true if the event was processed, false otherwise.
    
    Throws:
    
    GFileManipulatorException - in case the copy-paste operation raises an exception.
  - getComponent
```
public Component getComponent()
```
    Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
    
    Returns:
    
    the Swing Component encapsulated by the class if any, otherwise returns null.
  - setName
```
public void setName()
```
    Set the Swing name (identifier) of the component to the widgetId.
  - getName
```
public String getName()
```
    Get the name of the component at Swing level, if no Swing component is assigned to this GComponent then the class name is returned.
    
    Returns:
    
    the name of the component at Swing level, if no Swing component is assigned to this GComponent then the class name is returned.
  - setWidgetId
```
public void setWidgetId(String widgetId)
```
    Sets the widget identifier of the component.
    
    Parameters:
    
    widgetId - the widget identifier of the component.
  - composeWidgetId
```
protected String composeWidgetId(String finalWidgetId)
```
    Compose the widget id by adding "." to the value returned by getWidgetId. This method is intended to be used by derived classes to compose their child widgetId.
    
    Parameters:
    
    finalWidgetId - chain to be added to the widget id.
    
    Returns:
    
    the widget id by adding "." to the value returned by getWidgetId.
  - getWidgetId
```
public final String getWidgetId()
```
    Get the Swing name (identifier) of the component, no Swing component is encapsulated then null is returned.
    
    Returns:
    
    name Swing name (identifier) of the encapsulated component or null if there is no encapsulated component.
  - getSimpleWidgetId
```
public String getSimpleWidgetId()
```
    Get the last part of the Swing name (identifier) of the component (after last "."). If it has no Swing identifier then null is returned.
    
    Returns:
    
    name last part of the Swing name (identifier) of the encapsulated component or null if there is no encapsulated component.
  - setStatus
```
protected void setStatus(GIntervalAbstract.GStatus status)
```
    Set the status of the widget.
    
    Parameters:
    
    status - the new status of the widget.
  - getStatus
```
public GIntervalAbstract.GStatus getStatus()
```
    Get the status of the widget.
    
    Returns:
    
    the status of the widget.
  - setForcedStatus
```
public void setForcedStatus(GIntervalAbstract.GStatus forcedStatus)
```
    Set the forced status. Forced status will override normal status even if component input are within boundaries.
    To remove forced status, call ##setForcedStatus(null).
    
    Warning: once status has been forced, in order to update status, a call to updateStatus() should be performed.
    
    Parameters:
    
    forcedStatus - the new forced status
  - isForcedStatus
```
public GIntervalAbstract.GStatus isForcedStatus()
```
    Returns the forced status, null if undefined.
    
    Returns:
    
    the forced status, null if undefined
  - setBusyCursor
```
public void setBusyCursor(boolean flag)
```
    Set or clear the busy mouse cursor for the component.
    
    Parameters:
    
    flag - if true the busy cursor is set for the component, otherwise it is cleared.
  - setWindowBusyCursor
```
public static void setWindowBusyCursor(boolean flag,
                                       GComponent component)
```
    Parameters:
    
    flag - if true change the cursor
    
    component - defining the change of the cursor
  - setCurrentOperation
```
protected static void setCurrentOperation(GComponent.Operation operation,
                                          boolean operationSaveValue)
```
    Sets the value of the current operation. This method shall be used only by the core components of the library.
    
    Parameters:
    
    operation - new value of the current operation.
    
    operationSaveValue - true if the operation shall updated the saved values.
  - getCurrentOperation
```
protected static GComponent.Operation getCurrentOperation()
```
    Gets the current skeleton index.
    
    Returns:
    
    the current value of the skeleton index.
  - getOperationSaveValue
```
protected static boolean getOperationSaveValue()
```
    Gets the boolean indicating if the operation shall update the saved not.
    
    Returns:
    
    true if the operations shall updated the saved values, otherwise not.
  - setGPanel
```
public void setGPanel(GPanel panel)
```
    Sets the current panel containing the component.
    
    Parameters:
    
    panel - containing the component.
  - getGPanel
```
public GPanel getGPanel()
```
    Gets the current panel containing the component.
    
    Returns:
    
    the current panel containing the component.
  - setGParent
```
public void setGParent(GComponent parent)
```
    Sets the component that is the parent of this component.
    
    Parameters:
    
    parent - the component that is the parent of this component.
  - getGParent
```
public GComponent getGParent()
```
    Get the component that is the parent of this component.
    
    Returns:
    
    the component that is the parent of this component.
  - setDefaultConstraints
```
protected void setDefaultConstraints()
```
    Set default constraints.
  - clearConstraint
```
public void clearConstraint()
```
    Clears the constraint for the component.
  - clearInnerDescendantContraint
```
public void clearInnerDescendantContraint(int... positionList)
```
    Clears the constraint of the inner subcomponent.
    
    Parameters:
    
    positionList - the ordered subcomponent index.
  - clearAllInnerDescendantConstraint
```
public void clearAllInnerDescendantConstraint()
```
    Method to clear the constraints for a given component and all its sub-components recursively.
  - setConstraint
```
public void setConstraint(GConstraint constraint)
```
    Set the constraint for the component.
    
    Parameters:
    
    constraint - constraint to set for the component.
  - setStringConstraint
```
public void setStringConstraint(String simpleConstraint)
```
    Set the constraint in string format for the component.
    
    Parameters:
    
    simpleConstraint - constraint in string format to set for the component.
  - parseSimpleConstraint
```
public static String parseSimpleConstraint(String simpleConstraint,
                                           String prevConstraint)
```
    Parse a new simple constraint in string format. These situations are possible:
    - simpleConstraint is null : the result is null
    - simpleConstraint is "" : the result is ""
    - simpleConstraint is "?" : the result is "prevConstraint"
    - simpleConstraint is "+ something" : the result is "prevConstraint something" (ATTENTION: if a "," is to be added it must be explicitly written)
    Parameters:
    
    simpleConstraint - constraint to be parsed
    
    prevConstraint - previous constraint
    
    Returns:
    
    the parsed constraint
  - getConstraint
```
public GConstraint getConstraint()
```
    Return the current component constraint.
    
    Returns:
    
    the current component constraint.
  - getStringConstraint
```
public String getStringConstraint()
```
    Return the current component constraint.
    
    Returns:
    
    the current component constraint.
  - doDisplay
```
public void doDisplay(GComponent component)
```
    Perform the display of the internal component.
    
    Parameters:
    
    component - to be displayed.
  - processGEvent
```
protected static void processGEvent(GEvent event,
                                    GComponent source)
```
    Process an event generated by a descendant component.
    
    Parameters:
    
    event - to be treated.
    
    source - of the event.
  - handleProcessEventException
```
protected static void handleProcessEventException(GException ex)
```
    Show the exception dialog to display an exception.
    
    Parameters:
    
    ex - exception to display.
  - setPathInConfigFile
```
public void setPathInConfigFile(String path)
```
    Sets the Path to be used when saving the component in the configuration file.
    
    Parameters:
    
    path - to be used when saving the component in the configuration file.
  - setNameInConfigFile
```
public void setNameInConfigFile(String name)
```
    Sets the name to be used when saving the component in the configuration file.
    
    Parameters:
    
    name - to be used when saving the component in the configuration file.
  - getNameInConfigFile
```
public String getNameInConfigFile()
```
    Get the name to be used when saving the component in the configuration file.
    
    Returns:
    
    the name to be used when saving the component in the configuration file.
  - getPathInConfigFile
```
public String getPathInConfigFile()
```
    Get the path of current component respect to the configuration file structure
    
    Returns:
    
    the path of current component respect to the configuration file structure
  - setGUnitInConfigFile
```
public void setGUnitInConfigFile(GUnit unit)
```
    Sets the GUnit to use to save the component in the configuration file. The unit is only used in case the value has units.
    
    Parameters:
    
    unit - to use to save the component in the configuration file.
  - setToolTipText
```
public void setToolTipText(String text)
```
    Empty method to be overwrite by the components at a higher level if needed.
    
    Parameters:
    
    text - to set in the tooltip.
  - getGUnitInConfigFile
```
public GUnit getGUnitInConfigFile()
```
    Gets the GUnit to use to save the component in the configuration file. The unit is only used in case the value has units.
    
    Returns:
    
    to use to save the component in the configuration file, if no unit is set then it returns null.
  - setCommentInConfigFile
```
public void setCommentInConfigFile(String comment)
```
    Sets the comment to be set in the configuration file. To delete the comment set it to null.
    
    Parameters:
    
    comment - to be set in the configuration file.
  - getCommentInConfigFile
```
public String getCommentInConfigFile()
```
    Gets the comment to be set in the configuration file.
    
    Returns:
    
    the comment to be set in the configuration file.
  - setNameAndCommentInConfigFile
```
protected void setNameAndCommentInConfigFile(String text)
```
    Sets the name and the comment of the item in the configuration file.
    
    Parameters:
    
    text - to be used for the name and the comment of the item in the configuration file.
  - setElement
```
public void setElement(org.jdom.Element element)
```
    Sets the XML DOM element that will be used to store/load the component value from file.
    
    Parameters:
    
    element - that will be used to store/load the component value from file.
  - getElement
```
public org.jdom.Element getElement()
```
    Gets the XML DOM element that will be used to store/load the component value from file.
    
    Returns:
    
    the XML DOM element that will be used to store/load the component value from file.
  - beginOfElement
```
protected void beginOfElement(String type,
                              String name)
                       throws GException
```
    Begins an XML structural element of a given type and with a given name when loading/saving to the configuration file. If there is a comment defined for the component and if the comment is different to the item name, it will be also written when calling this method. Use beginOfElement(GItemTypeInterface, String, Boolean) if you want to avoid it.
    
    Parameters:
    
    type - of the XML structure item.
    
    name - attribute of the XML structure item.
    
    Throws:
    
    GException - in case that the element is not found when reading from the configuration file.
  - beginOfElement
```
protected void beginOfElement(String type,
                              String name,
                              Boolean allowWriteComment)
                       throws GException
```
    Begins an XML structural element of a given type and with a given name when loading/saving to the configuration file. If allowWriteComment is true it writes also the comment in the configuration file if there is a comment defined for this component by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    type - of the XML structure item.
    
    name - attribute of the XML structure item.
    
    allowWriteComment - flag to allow writing or not the item comment in the configuration file.
    
    Throws:
    
    GException - in case that the element is not found when reading from the configuration file.
  - beginOfElement
```
protected void beginOfElement(GItemTypeInterface type,
                              String name,
                              Boolean allowWriteComment)
                       throws GException
```
    Begins an XML structural element of a given type and with a given name when loading/saving to the configuration file. If allowWriteComment is true it writes also the comment in the configuration file if there is a comment defined for this component by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    type - of the XML structure item.
    
    name - attribute of the XML structure item.
    
    allowWriteComment - flag to allow writing or not the item comment in the configuration file.
    
    Throws:
    
    GException - in case that the element is not found when reading from the configuration file.
  - beginOfElement
```
protected void beginOfElement(GItemTypeInterface type,
                              String name)
                       throws GException
```
    Begins an XML structural element of a given type and with a given name when loading/saving to the configuration file. If there is a comment defined for the component and if the comment is different to the item name, it will be also written when calling this method. Use beginOfElement(GItemTypeInterface, String, Boolean) if you want to avoid it.
    
    Parameters:
    
    type - of the XML structure item.
    
    name - attribute of the XML structure item.
    
    Throws:
    
    GException - in case that the element is not found when reading from the configuration file.
  - endOfElement
```
protected void endOfElement()
```
    Ends an element, previously generated with beginOfElement, when loading/saving to file.
  - writeCollection
```
protected org.jdom.Element writeCollection(GItemTypeInterface type,
                                           String name,
                                           Map<String,String> attributes)
```
    Writes a collection to the configuration file. Writes also the item comment in the configuration file if there is a comment defined for the item by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    type - of element.
    
    name - of the element.
    
    attributes - of the element.
    
    Returns:
    
    the element representing the collection.
  - writeCollection
```
protected org.jdom.Element writeCollection(org.jdom.Element parentElement,
                                           GItemTypeInterface type,
                                           String name,
                                           Map<String,String> attributes)
```
    Writes a collection to the configuration file. Writes also the item comment in the configuration file if there is a comment defined for the item by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    parentElement - element parent of this one.
    
    type - of element.
    
    name - of the element.
    
    attributes - of the element.
    
    Returns:
    
    the element representing the collection.
  - writeCollection
```
protected org.jdom.Element writeCollection(org.jdom.Element parentElement,
                                           GItemTypeInterface type,
                                           String name,
                                           Map<String,String> attributes,
                                           Boolean allowWriteComment)
```
    Writes a collection to the configuration file. If allowWriteComment is true it writes also the item comment in the configuration file if there is a comment defined for the item by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    parentElement - element parent of this one.
    
    type - of element.
    
    name - of the element.
    
    attributes - of the element.
    
    allowWriteComment - flag to allow writing or not the item comment in the configuration file.
    
    Returns:
    
    the element representing the collection.
  - writeCollection
```
@Deprecated
protected org.jdom.Element writeCollection(org.jdom.Element parentElement,
                                                       String type,
                                                       String name,
                                                       Map<String,String> attributes,
                                                       Boolean allowWriteComment)
```
    Deprecated. The argument type should be an enum implementing the interface GItemTypeInterface instead of a String. See GItemTypeInterface for more details.
    
    Writes a collection to the configuration file. If allowWriteComment is true it writes also the item comment in the configuration file if there is a comment defined for the item by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    parentElement - element parent of this one.
    
    type - of element.
    
    name - of the element.
    
    attributes - of the element.
    
    allowWriteComment - flag to allow writing or not the item comment in the configuration file.
    
    Returns:
    
    the element representing the collection.
  - writeConfigItem
```
@Deprecated
protected org.jdom.Element writeConfigItem(org.jdom.Element parentElement,
                                                       String type,
                                                       String name,
                                                       String value,
                                                       Map<String,String> attributes,
                                                       Boolean allowWriteComment)
```
    Deprecated. The argument type should be an enum implementing the interface GItemTypeInterface instead of a String. See GItemTypeInterface for more details.
    
    Writes the values of an item in the configuration file. If allowWriteComment is true it writes also the item comment in the configuration file if there is a comment defined for the item by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    parentElement - element parent of this one.
    
    type - of element.
    
    name - of the element.
    
    value - of the element.
    
    attributes - of the element.
    
    allowWriteComment - flag to allow writing or not the item comment in the configuration file.
    
    Returns:
    
    the element being created.
  - writeConfigItem
```
protected org.jdom.Element writeConfigItem(org.jdom.Element parentElement,
                                           GItemTypeInterface type,
                                           String name,
                                           String value,
                                           Map<String,String> attributes,
                                           Boolean allowWriteComment)
```
    Writes the values of an item in the configuration file. If allowWriteComment is true it writes also the item comment in the configuration file if there is a comment defined for the item by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    parentElement - element parent of this one.
    
    type - of element.
    
    name - of the element.
    
    value - of the element.
    
    attributes - of the element.
    
    allowWriteComment - flag to allow writing or not the item comment in the configuration file.
    
    Returns:
    
    the element being created.
  - writeConfigItem
```
protected org.jdom.Element writeConfigItem(org.jdom.Element parentElement,
                                           GItemTypeInterface type,
                                           String name,
                                           String value,
                                           Map<String,String> attributes)
```
    Writes the values of an item in the configuration file. Writes also the item comment in the configuration file if there is a comment defined for the item by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    parentElement - element parent of this one.
    
    type - of element.
    
    name - of the element.
    
    value - of the element.
    
    attributes - of the element.
    
    Returns:
    
    the element being created.
  - writeConfigItem
```
protected void writeConfigItem(GItemTypeInterface type,
                               String value,
                               Map<String,String> attributes,
                               Boolean allowWriteComment)
                        throws GException
```
    Writes the values of an item in the configuration file. Writes also the item comment in the configuration file if there is a comment defined for the item by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    type - of element.
    
    value - of the element.
    
    attributes - of the element.
    
    allowWriteComment - flag to allow writing or not the item comment in the configuration file.
    
    Throws:
    
    GException - if the element can not be created because its "name in configuration" is empty.
  - writeConfigItem
```
protected void writeConfigItem(GItemTypeInterface type,
                               String value,
                               Map<String,String> attributes)
                        throws GException
```
    Writes the values of an item in the configuration file. Writes also the item comment in the configuration file if there is a comment defined for the item by means of setCommentInConfigFile(String) and if the comment is different to the item name.
    
    Parameters:
    
    type - of element.
    
    value - of the element.
    
    attributes - of the element.
    
    Throws:
    
    GException - if the element can not be created because its "name in configuration" is empty.
  - isEnabled
```
public boolean isEnabled()
```
    Gets the enable status of the widget.
    
    Returns:
    
    true if the component is enabled, false otherwise.
  - setEnabled
```
public void setEnabled(boolean flag)
```
    Set the enable status of the component.
    
    Parameters:
    
    flag - new enable status of the component.
  - setCopyPasteMenuEnabled
```
public void setCopyPasteMenuEnabled(boolean flag)
```
    Set the enable status of the copy-paste menu associated to the component.
    
    Parameters:
    
    flag - new enable status.
  - getDisplayIndicatorStatus
```
public GComponent.DisplayIndicatorStatus getDisplayIndicatorStatus()
```
    Get the display indicator status.
    
    Returns:
    
    the display indicator status.
  - setDisplayIsModifiedIndicator
```
public void setDisplayIsModifiedIndicator(GComponent.DisplayIndicatorStatus displayIndicatorStatus)
```
    Activates the display of the isModified indicator.
    
    Parameters:
    
    displayIndicatorStatus - if Always the modifiedStatusIndicator is always shown, if Never the modifiedStatusIndicator is never shown, if Automatic the modifiedStatusIndicator is shown as needed.
  - updateIsModifiedIndicator
```
protected void updateIsModifiedIndicator()
```
    Updates the isModified indicator, this method shall be overwritten by the child classes that need to.
  - getDisplayIsModifiedIndicator
```
public boolean getDisplayIsModifiedIndicator()
```
    Get the displayIsModifiedIdicator.
    
    Returns:
    
    if true the isModified indicator is displayed, false otherwise.
  - isModified
```
public boolean isModified()
```
    Gets the modification status of the component against the last set of values loaded or saved.
    
    Returns:
    
    the modification status of the component against the last set of values loaded or saved.
  - launchInvalidPositionException
```
protected void launchInvalidPositionException(int position)
                                       throws GComponentException
```
    Launch an invalid position exception.
    
    Parameters:
    
    position - invalid position.
    
    Throws:
    
    GComponentException - in case the subcomponent position is invalid.
  - setDataForConstraintsByType
```
protected void setDataForConstraintsByType(Class<?> ownerClass,
                                           Integer... positionArray)
```
    Setter for the father type and the subcomponent rank into the father type for constraints by class.
    Example:
    To set a width of 500 to the GTextField of all the GEntryReals in current panel:
    setClassConstraint(GEntryReal.class, 1, new GConstraint(GConstraint.width(1000)));
    In order to make this possible, GTextField in its doDiplay must know that it is a part of a GEntryReal, and that it is the subcomponent "1" of the GEntryReal.
    
    Parameters:
    
    ownerClass - the class object that represents the father component.
    
    positionArray - array representing the position of this component into the owner class.
  - activateConstraintsByType
```
protected void activateConstraintsByType(Class<?> className)
```
    Switch method to activate the functionality to set constraints by class for a given class.
    Example:
    To set a width of 500 to the GRealField of all the GEntryReals in current panel:
    setClassConstraint(GEntryReal.class, 1, new GConstraint(GConstraint.width(500)));
    
    Parameters:
    
    className - The Class object that represents the runtime class of this object.
  - setWidth
```
protected boolean setWidth(Integer minWidth,
                           Integer preferredWidth,
                           Integer maxWidth)
```
    Method to modify the width of a GComponent. Use null arguments to keep values.
    
    Parameters:
    
    minWidth - minimum allowed width for the component. It prevails over the applying "width" constraint.
    
    preferredWidth - width of the component when no constraint is given.
    
    maxWidth - maximum allowed width for the component. It prevails over the applying "width" constraint.
    
    Returns:
    
    true if the change in width has been applied (Component not null).
  - getGClassName
```
public String getGClassName()
```
    Method to get the class name scaping the "$" character for the internal classes. For instance: this method will return fr.cnes.genopus.attitudes.GPAttitudeSequence.LawsComponentList instead of fr.cnes.genopus.attitudes.GPAttitudeSequence$LawsComponentList. This is to avoid problems with the domDocuments that do not allow "$" character.
    
    Returns:
    
    the component class name without "$" character.
  - mouseWheelMoved
```
public void mouseWheelMoved(MouseWheelEvent e)
```
    Specified by:
    
    mouseWheelMoved in interface MouseWheelListener
    
    Parameters:
    
    e - event
  - processMouseWheelEvent
```
public void processMouseWheelEvent(MouseWheelEvent e)
```
    Allows the user to scroll while the mouse cursor is on the panel and not exclusively when the cursor is on the scrollbar.
    
    Parameters:
    
    e - event

Class GComponent

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME_ATTRIBUTE

Constructor Detail

GComponent

GComponent

Method Detail

getSubComponent

getInnerDescendantConstraint

setInnerDescendantConstraint

attachCopyPasteMenu

attachCopyPasteMenu

isCopyPasteEvent

handleCopyPasteEvent

handleCopyPasteEvent

getComponent

setName

getName

setWidgetId

composeWidgetId

getWidgetId

getSimpleWidgetId

setStatus

getStatus

setForcedStatus

isForcedStatus

setBusyCursor

setWindowBusyCursor

setCurrentOperation

getCurrentOperation

getOperationSaveValue

setGPanel

getGPanel

setGParent

getGParent

setDefaultConstraints

clearConstraint

clearInnerDescendantContraint

clearAllInnerDescendantConstraint

setConstraint

setStringConstraint

parseSimpleConstraint

getConstraint

getStringConstraint

doDisplay

processGEvent

handleProcessEventException

setPathInConfigFile

setNameInConfigFile

getNameInConfigFile

getPathInConfigFile

setGUnitInConfigFile

setToolTipText

getGUnitInConfigFile

setCommentInConfigFile

getCommentInConfigFile

setNameAndCommentInConfigFile

setElement

getElement

beginOfElement

beginOfElement

beginOfElement

beginOfElement

endOfElement

writeCollection

writeCollection

writeCollection

writeCollection

writeConfigItem

writeConfigItem

writeConfigItem

writeConfigItem

writeConfigItem

isEnabled

setEnabled