GEnvironment (Genius 1.13.1 API)

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

```
public class GEnvironment
extends Object
```
Class representing the GENIUS environment. This class is a singleton, the access to the different services is done through the different get methods. The class includes all functions related to environment of execution that have to be shared by all widgets. The functions are:
- Handling of the object in charge of MMI language translation (translation of text strings in the user language),
- Log file handling: file used by widgets and software’s of the GENIUS library.
Author:

jjct

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GEnvironment.Format` Format for the entry field.
`static class`	`GEnvironment.UIElementColor` Enumerates describing the list of modifiable GUI elements colors.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static double[]`	`arrayCopy(double[] srcArray)` Create a copy of an double array.
`static int[]`	`arrayCopy(int[] srcArray)` Create a copy of an int array.
`static <T> T[]`	`arrayCopy(T[] srcArray)` Create a copy of an object array.
`static boolean`	`configLangIsCurrent()` Check if the translation system is initialized.
`static String`	`formatDouble(double value)` Sets a specific double format.
`static String`	`formatDouble(double value, GEnvironment.Format format, int fracDigits)` Format a double with the specified format and number of fractional digits.
`static String`	`formatDouble(double value, int fracDigits)` Sets a specific double format.
`static GIcon`	`getApplicationIcon()` Gets application frame icon
`static String`	`getErrorTooltipMessage(String interval)` Gets the ERROR tooltip message given the interval or intervals.
`static GLogger`	`getGLog()` Get the internationalization manager.
`static GLogEventTablePanel`	`getGLogViewer()` Get the GLogEventTablePanel containing the GLogEventTable associated with the log file.
`static GUncaughtExceptionHandler`	`getGUncaughtExceptionHandler()` Get the uncaughtExceptionHandler to be called in case of an exception arising in the event loop, if null the exception will be ignored.
`static Locale`	`getI18nLocale()` Get Application Lang.
`static String`	`getOkTooltipMessage(String interval)` Gets the OK tooltip message given the interval or intervals.
`static String`	`getWarningTooltipMessage(String interval)` Gets the WARNING tooltip message given the interval or intervals.
`static boolean`	`getWriteLogDataModififiedEvent()` Gets the status of writeLogDataModififiedEvent parameter.
`static boolean`	`getWriteLogDataValidityEvent()` Gets the status of writeLogDataValidityEvent parameter.
`static void`	`initI18n()` Initialize the translation system to the default language: English.
`static void`	`initI18n(Locale locale)` Initialize the translation system.
`static boolean`	`isHeadless()` Return if the environment is headless calling GraphicsEnvironment.isHeadless().
`static String`	`marktr(String string)` Marks text to be translated, but doesn't return the translation but text itself.
`static String`	`removeLeftZeroes(String string)` Remove the zeroes at the left of the string.
`static String`	`removeRightZeroes(String string)` Remove the zeroes at the right of the string.
`static void`	`sendProgress(int value)` Send the progress output mode to the stdout in the form of @value@.
`static void`	`setConfigurationLang(String lang)` Set Configuration Lang.
`static void`	`setGUncaughtExceptionHandler(GUncaughtExceptionHandler uncaughtExceptionHandler)` Set the uncaughtExceptionHandler to be called in case of an exception arising in the event loop.
`static void`	`setHeadless()` Set the headless property of the environment.
`static void`	`setIcon(GIcon applicationIcon)` Change application icon.
`static void`	`setIcon(String filePath)` Change application icon.
`static void`	`setIcon(URL fileURL)` Change application icon.
`static void`	`setLogFilename(String filename, boolean createViewer)` Sets the log filename.
`static void`	`setOutputEncoding(String encoding)` Set the stdout and stderr encoding to .
`static void`	`setProgressOutputMode(boolean flag)` Sets the progress output mode.
`static void`	`setUIColor(GEnvironment.UIElementColor element, Color color)` Change the color of an UI item for all the instances.
`static void`	`setWriteLogDataModififiedEvent(boolean flag)` Sets the status of writeLogDataModififiedEvent parameter.
`static void`	`setWriteLogDataValidityEvent(boolean flag)` Sets the status of writeLogDataValidityEvent parameter.
`static String`	`tr(String string)` Translate string using the current locale if the i18n has been initialize with the initI18n method, else it returns the untranslated string.
`static String`	`trConfToCurrent(String string, boolean underscoreAsWhitespace)` Translate value read from configuration from configuration locale to application locale
`static String`	`trf(boolean localizeNumbers, String formatString, Object... args)` Translate a string doing a String.format.
`static String`	`trf(String formatString, Object... args)` Translate a string doing a String.format.
`static String`	`trn(String singularString, String pluralString, long n)` Translate string using the current locale if the i18n has been initialize with the initI18n method, else it returns the untranslated string.

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

- Method Detail
  - getErrorTooltipMessage
```
public static String getErrorTooltipMessage(String interval)
```
    Gets the ERROR tooltip message given the interval or intervals.
    
    Parameters:
    
    interval - the interval or intervals to show in the message.
    
    Returns:
    
    the complete message for the tooltip in ERROR status
  - getApplicationIcon
```
public static GIcon getApplicationIcon()
```
    Gets application frame icon
    
    Returns:
    
    the frame icon
  - getWarningTooltipMessage
```
public static String getWarningTooltipMessage(String interval)
```
    Gets the WARNING tooltip message given the interval or intervals.
    
    Parameters:
    
    interval - the interval or intervals to show in the message.
    
    Returns:
    
    the complete message for the tooltip in WARNING status
  - getOkTooltipMessage
```
public static String getOkTooltipMessage(String interval)
```
    Gets the OK tooltip message given the interval or intervals.
    
    Parameters:
    
    interval - the interval or intervals to show in the message.
    
    Returns:
    
    the complete message for the tooltip in OK status
  - setIcon
```
public static void setIcon(GIcon applicationIcon)
```
    Change application icon.
    
    Parameters:
    
    applicationIcon - GIcon object
  - setIcon
```
public static void setIcon(URL fileURL)
                    throws IOException
```
    Change application icon.
    
    Parameters:
    
    fileURL - icon file URL
    
    Throws:
    
    IOException - thrown if the icon can not be read
  - setIcon
```
public static void setIcon(String filePath)
                    throws IOException
```
    Change application icon.
    
    Parameters:
    
    filePath - icon file path (absolute or relative from resources)
    
    Throws:
    
    IOException - thrown if the icon can not be read
  - setUIColor
```
public static void setUIColor(GEnvironment.UIElementColor element,
                              Color color)
```
    Change the color of an UI item for all the instances.
    
    Parameters:
    
    element - type of element to modify
    
    color - new color of the element.
  - removeLeftZeroes
```
public static String removeLeftZeroes(String string)
```
    Remove the zeroes at the left of the string.
    
    Parameters:
    
    string - to be treated.
    
    Returns:
    
    the string with the left zeroes removed.
  - removeRightZeroes
```
public static String removeRightZeroes(String string)
```
    Remove the zeroes at the right of the string.
    
    Parameters:
    
    string - to be treated.
    
    Returns:
    
    the string with the right zeroes removed.
  - formatDouble
```
public static String formatDouble(double value,
                                  GEnvironment.Format format,
                                  int fracDigits)
```
    Format a double with the specified format and number of fractional digits.
    
    Parameters:
    
    value - value to format.
    
    format - format SCIENTIFIC or NORMAL.
    
    fracDigits - number of fractional digits.
    
    Returns:
    
    the formatted value as a string.
  - setOutputEncoding
```
public static void setOutputEncoding(String encoding)
                              throws UnsupportedEncodingException
```
    Set the stdout and stderr encoding to .
    
    Parameters:
    
    encoding - the encoding to use for the stdout and stderr, for example to set them to UTF-8 use "UTF-8".
    
    Throws:
    
    UnsupportedEncodingException - in case the encoding is not supported.
  - setProgressOutputMode
```
public static void setProgressOutputMode(boolean flag)
```
    Sets the progress output mode.
    
    Parameters:
    
    flag - true the progress output is send to the stdout, false otherwise.
  - sendProgress
```
public static void sendProgress(int value)
```
    Send the progress output mode to the stdout in the form of @value@.
    
    Parameters:
    
    value - between 0 and 100 to send to the stdout.
  - setGUncaughtExceptionHandler
```
public static void setGUncaughtExceptionHandler(GUncaughtExceptionHandler uncaughtExceptionHandler)
```
    Set the uncaughtExceptionHandler to be called in case of an exception arising in the event loop.
    
    Parameters:
    
    uncaughtExceptionHandler - the uncaughtExceptionHandler to be called in case of an exception arising in the event loop, if null the exception will be ignored.
  - getGUncaughtExceptionHandler
```
public static GUncaughtExceptionHandler getGUncaughtExceptionHandler()
```
    Get the uncaughtExceptionHandler to be called in case of an exception arising in the event loop, if null the exception will be ignored.
    
    Returns:
    
    the uncaughtExceptionHandler to be called in case of an exception arising in the event loop, if null the exception will be ignored.
  - initI18n
```
public static void initI18n()
                     throws GEnvironmentException
```
    Initialize the translation system to the default language: English.
    
    Throws:
    
    GEnvironmentException - in case that the translation file is not found. The default language is used (English).
    
    See Also:
    
    https://code.google.com/p/gettext-commons/
  - initI18n
```
public static void initI18n(Locale locale)
                     throws GEnvironmentException
```
    Initialize the translation system.
    
    Parameters:
    
    locale - to be use to translate the strings in the code.
    - Use new Locale("lang") to set the "lang" language. Ex: new Locale("fr"). A translation file must exist.
    - Use Locale.getDefault() to set the default machine locale.
    - In any other case no translation will be made (the default language is English).
    
    Throws:
    
    GEnvironmentException - in case that the translation file is not found. The default language is used (English).
    
    See Also:
    
    https://code.google.com/p/gettext-commons/
  - getI18nLocale
```
public static Locale getI18nLocale()
```
    Get Application Lang.
    
    Returns:
    
    Locale the application lang
  - setConfigurationLang
```
public static void setConfigurationLang(String lang)
                                 throws GEnvironmentException
```
    Set Configuration Lang.
    
    Parameters:
    
    lang - language to init lang ressources :( "fr", "en", ... ) read from "locale" element in configuration
    
    Throws:
    
    GEnvironmentException - in case that the translation file is not found. The default language is used (English).
  - configLangIsCurrent
```
public static boolean configLangIsCurrent()
```
    Check if the translation system is initialized.
    
    Returns:
    
    True if read configuration and application have the same locale
  - trConfToCurrent
```
public static String trConfToCurrent(String string,
                                     boolean underscoreAsWhitespace)
```
    Translate value read from configuration from configuration locale to application locale
    
    Parameters:
    
    string - to be translated
    
    underscoreAsWhitespace - True if whitespace has to be replace in values ( for name attribute the whitesapces are replaced by '_' on configuration write )
    
    Returns:
    
    the translated value
  - tr
```
public static String tr(String string)
```
    Translate string using the current locale if the i18n has been initialize with the initI18n method, else it returns the untranslated string.
    
    Parameters:
    
    string - to be translated.
    
    Returns:
    
    the translated string using the current locale if the i18n has been initialize with the initI18n method, else it the original string.
  - trn
```
public static String trn(String singularString,
                         String pluralString,
                         long n)
```
    Translate string using the current locale if the i18n has been initialize with the initI18n method, else it returns the untranslated string. The singular or plural format of the string is chosen depending on the value of n, if n > 1 then the plural form is used.
    
    Parameters:
    
    singularString - singular form of the string to be translated.
    
    pluralString - plural form of the string to be translated.
    
    n - number to determine if the singular or plural form of the string is used.
    
    Returns:
    
    the translated string using the current locale if the i18n has been initialize with the initI18n method, else it the original string.
  - trf
```
public static String trf(String formatString,
                         Object... args)
```
    Translate a string doing a String.format.
    
    Parameters:
    
    formatString - a format string.
    
    args - Arguments referenced by the format specifiers in the format string.
    
    Returns:
    
    the formatted and translated string.
    
    See Also:
    
    String.format(String formatString, Object... args).
  - trf
```
public static String trf(boolean localizeNumbers,
                         String formatString,
                         Object... args)
```
    Translate a string doing a String.format.
    
    Parameters:
    
    localizeNumbers - true if the numbers being formatted shall be localized, false otherwise.
    
    formatString - a format string.
    
    args - Arguments referenced by the format specifiers in the format string.
    
    Returns:
    
    the formatted and translated string.
    
    See Also:
    
    String.format(String formatString, Object... args).
  - marktr
```
public static String marktr(String string)
```
    Marks text to be translated, but doesn't return the translation but text itself.
    
    Parameters:
    
    string - to be marked for translation.
    
    Returns:
    
    text itself.
  - setLogFilename
```
public static void setLogFilename(String filename,
                                  boolean createViewer)
                           throws GEnvironmentException
```
    Sets the log filename. This method can only be called before the log is initialized in the first getLog call.
    
    Parameters:
    
    filename - of the log file.
    
    createViewer - true it the logEventTable shall be created, false otherwise.
    
    Throws:
    
    GEnvironmentException - in case the log object has already being initialized by a call to getLog.
  - getGLog
```
public static GLogger getGLog()
```
    Get the internationalization manager.
    
    Returns:
    
    the internationalization manager.
    
    See Also:
    
    https://code.google.com/p/gettext-commons/
  - getGLogViewer
```
public static GLogEventTablePanel getGLogViewer()
```
    Get the GLogEventTablePanel containing the GLogEventTable associated with the log file.
    
    Returns:
    
    the GLogEventTablePanel containing the GLogEventTable associated with the log file.
  - formatDouble
```
public static String formatDouble(double value,
                                  int fracDigits)
                           throws GEnvironmentException
```
    Sets a specific double format.
    
    Parameters:
    
    value - value to be formated.
    
    fracDigits - the precision.
    
    Returns:
    
    the formated value.
    
    Throws:
    
    GEnvironmentException - in case the fracDigits is greater than MAX_FRAC_DIGITS.
  - formatDouble
```
public static String formatDouble(double value)
```
    Sets a specific double format.
    
    Parameters:
    
    value - value to be formated.
    
    Returns:
    
    the formated value.
  - getWriteLogDataValidityEvent
```
public static boolean getWriteLogDataValidityEvent()
```
    Gets the status of writeLogDataValidityEvent parameter.
    
    Returns:
    
    true if the events are written, false otherwise.
  - setWriteLogDataValidityEvent
```
public static void setWriteLogDataValidityEvent(boolean flag)
```
    Sets the status of writeLogDataValidityEvent parameter.
    
    Parameters:
    
    flag - if false, the events are disabled, otherwise they are written.
  - getWriteLogDataModififiedEvent
```
public static boolean getWriteLogDataModififiedEvent()
```
    Gets the status of writeLogDataModififiedEvent parameter.
    
    Returns:
    
    true if the events are written, false otherwise.
  - setWriteLogDataModififiedEvent
```
public static void setWriteLogDataModififiedEvent(boolean flag)
```
    Sets the status of writeLogDataModififiedEvent parameter.
    
    Parameters:
    
    flag - if false, the events are disabled, otherwise they are written.
  - arrayCopy
```
public static int[] arrayCopy(int[] srcArray)
```
    Create a copy of an int array.
    
    Parameters:
    
    srcArray - the source int array to copy.
    
    Returns:
    
    a copy of an int array, or null if the source array is null.
  - arrayCopy
```
public static double[] arrayCopy(double[] srcArray)
```
    Create a copy of an double array.
    
    Parameters:
    
    srcArray - the source double array to copy.
    
    Returns:
    
    a copy of an double array, or null if the source array is null.
  - arrayCopy
```
public static <T> T[] arrayCopy(T[] srcArray)
```
    Create a copy of an object array.
    
    Type Parameters:
    
    T - Type of object in the array.
    
    Parameters:
    
    srcArray - the source String array to copy.
    
    Returns:
    
    a copy of an String array, or null if the source array is null.
  - isHeadless
```
public static boolean isHeadless()
```
    Return if the environment is headless calling GraphicsEnvironment.isHeadless().
    
    Returns:
    
    true if the environment is headless, false otherwise.
  - setHeadless
```
public static void setHeadless()
```
    Set the headless property of the environment.

Class GEnvironment

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getErrorTooltipMessage

getApplicationIcon

getWarningTooltipMessage

getOkTooltipMessage

setIcon

setIcon

setIcon

setUIColor

removeLeftZeroes

removeRightZeroes

formatDouble

setOutputEncoding

setProgressOutputMode

sendProgress

setGUncaughtExceptionHandler

getGUncaughtExceptionHandler

initI18n

initI18n

getI18nLocale

setConfigurationLang

configLangIsCurrent

trConfToCurrent

tr

trn

trf

trf

marktr

setLogFilename

getGLog

getGLogViewer

formatDouble

formatDouble

getWriteLogDataValidityEvent

setWriteLogDataValidityEvent

getWriteLogDataModififiedEvent

setWriteLogDataModififiedEvent

arrayCopy

arrayCopy

arrayCopy

isHeadless

setHeadless