fr.cnes.genius.standardapplication

Class GMainFrameAbstract<T extends GDataPanelAbstract>

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genius.standardapplication.GMainFrameAbstract<T>

Type Parameters:

T - Type of the data panel of the application.

All Implemented Interfaces:

GDisplay, GListener, MouseWheelListener, EventListener

public abstract class GMainFrameAbstract<T extends GDataPanelAbstract>
extends GPanel
implements GListener

Abstract class using as a basis for upper level class defining the top level of the GUI.

Author:

goesterjf

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
GMainFrameAbstract(String title, T dataPanel, GContextFileManagement contextFileManagement, GAboutDialog aboutDialog, GSaveResults saveResultsDialog, int dataPanelHeight, int errConsoleHeight, int iconSize, boolean showProgressBar) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addMenuBar(GMenu menu, int idx) Method to add a menu to the menu bar
void	addMenuBar(JMenu menu, int idx) Method to add a menu to the menu bar
void	after(GEvent eve) Method managing what occurs after action.
void	before(GEvent event) Called before the event is processed.
protected abstract void	customPostProcessManagement() Abstract method where setting customized post process management.
protected abstract void	customPreProcessManagement() Abstract method where setting customized pre process management.
void	deleteMenuBar(GMenu menu) Method to delete an item from the menu bar
void	deleteMenuBar(JMenu menu) Method to delete an item from the menu bar
void	deleteMenuBar(String menu) Method to delete an item from the menu bar
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	displayMainFrame() Display the main frame.
void	generic() Abstract generic function that need to be implemented by the descendants.
T	getDataPanel() Get the data panel instance.
GTextArea	getErrConsole() Method allowing to get the error console.
GMenu	getGMenu(String menu) Method to get a menu from the menubar
GJavaCommandLauncher	getJavaCommandLauncher() Get the command launcher instance.
GMenuBar	getMenuBar() Method to return the menu bar to be called by the main static method.
GSaveResults	getSaveResultsDialog() Get the save results dialog instance.
static boolean	isDebugMode() Method to get debug mode.
void	moveMenuBar(GMenu menu, int idx) Method to move an item in the menu bar to the selected index
void	moveMenuBar(JMenu menu, int idx) Method to move an item in the menu bar to the selected index
void	moveMenuBar(String menu, int idx) Method to move an item in the menu bar to the selected index
static void	resetContextFileName(String newName) Reset the name of the context file (if null, text set to "no context")
protected abstract void	saveFilesManagement() Abstract method where setting mechanism for result (and context) files saving.
void	setBackGroundErrConsole(Color color) Method allowing to set background color of the error console.
static void	setDebugMode(boolean mode) Method to configure in debug mode or not.
protected void	setDefaultConstraints() set the defaults constraints
void	setErrConsoleFont(Font errConsoleFont) Method allowing to set font of the error console.
void	setForeGroundErrConsole(Color color) Method allowing to set ForeGround color of the error console.
void	setMainFrameMinimumSize(int width, int height) Set the minimum size of the main frame.

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, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setEnabled, 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

GMainFrameAbstract

public GMainFrameAbstract(String title,
                          T dataPanel,
                          GContextFileManagement contextFileManagement,
                          GAboutDialog aboutDialog,
                          GSaveResults saveResultsDialog,
                          int dataPanelHeight,
                          int errConsoleHeight,
                          int iconSize,
                          boolean showProgressBar)

Constructor.

Parameters:

title - title of the main frame.

dataPanel - panel where all data needed for the application are displayed.

contextFileManagement - GFile manager that will be displayed for searching context files.

aboutDialog - Widget displaying information about the application.

saveResultsDialog - Widget managing the save of the context+results files.

dataPanelHeight - height (in pixels) of the data panel.

errConsoleHeight - height (in pixels) of the error console.

iconSize - size of the icons.

showProgressBar - boolean to decide if a progress bar is displayed.

Method Detail

setDefaultConstraints

protected void setDefaultConstraints()

Description copied from class: GPanel

set the defaults constraints

Overrides:

setDefaultConstraints in class GPanel

getDataPanel

public T getDataPanel()

Get the data panel instance.

Returns:

the data panel instance.

getSaveResultsDialog

public GSaveResults getSaveResultsDialog()

Get the save results dialog instance.

Returns:

the save results dialog instance.

getJavaCommandLauncher

public GJavaCommandLauncher getJavaCommandLauncher()

Get the command launcher instance.

Returns:

the command launcher instance.

displayMainFrame

public void displayMainFrame()

Display the main frame.

setMainFrameMinimumSize

public void setMainFrameMinimumSize(int width,
                                    int height)

Set the minimum size of the main frame.

Parameters:

width - minimum width.

height - minimum height.

display

public void display()
             throws GException

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.

generic

public void generic()
             throws GException

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

Specified by:

generic in class GPanel

Throws:

GException - in case of problem.

before

public void before(GEvent event)
            throws GException

Called before the event is processed.

Specified by:

before in interface GListener

Parameters:

event - event to processed.

Throws:

GException - in case there is a problem managing the event.

after

public void after(GEvent eve)
           throws GException

Method managing what occurs after action.

Specified by:

after in interface GListener

Parameters:

eve - GENIUS event.

Throws:

GException - GENIUS exception

getErrConsole

public GTextArea getErrConsole()

Method allowing to get the error console.

Returns:

the error console.

setErrConsoleFont

public void setErrConsoleFont(Font errConsoleFont)

Method allowing to set font of the error console.

Parameters:

errConsoleFont - font used for output error console.

setBackGroundErrConsole

public void setBackGroundErrConsole(Color color)

Method allowing to set background color of the error console.

Parameters:

color - color used for output error console.

setForeGroundErrConsole

public void setForeGroundErrConsole(Color color)

Method allowing to set ForeGround color of the error console.

Parameters:

color - color used for output error console.

getMenuBar

public GMenuBar getMenuBar()

Method to return the menu bar to be called by the main static method.

Returns:

menu bar

addMenuBar

public void addMenuBar(GMenu menu,
                       int idx)

Method to add a menu to the menu bar

Parameters:

menu - menu to be added to the menubar

idx - index where the menu will be added

addMenuBar

public void addMenuBar(JMenu menu,
                       int idx)

Method to add a menu to the menu bar

Parameters:

menu - menu to be added to the menubar

idx - index where the menu will be added

moveMenuBar

public void moveMenuBar(GMenu menu,
                        int idx)

Method to move an item in the menu bar to the selected index

Parameters:

menu - menu that will be moved

idx - index where the menu will be moved

moveMenuBar

public void moveMenuBar(JMenu menu,
                        int idx)

Method to move an item in the menu bar to the selected index

Parameters:

menu - menu that will be moved

idx - index where the menu will be moved

moveMenuBar

public void moveMenuBar(String menu,
                        int idx)

Method to move an item in the menu bar to the selected index

Parameters:

menu - menu that will be moved

idx - index where the menu will be moved

deleteMenuBar

public void deleteMenuBar(GMenu menu)

Method to delete an item from the menu bar

Parameters:

menu - menu that will be deleted

deleteMenuBar

public void deleteMenuBar(JMenu menu)

Method to delete an item from the menu bar

Parameters:

menu - menu that will be deleted

deleteMenuBar

public void deleteMenuBar(String menu)

Method to delete an item from the menu bar

Parameters:

menu - menu that will be deleted

getGMenu

public GMenu getGMenu(String menu)

Method to get a menu from the menubar

Parameters:

menu - menu to be recuperated

Returns:

GMenu the chosen menu

saveFilesManagement

protected abstract void saveFilesManagement()
                                     throws GException

Abstract method where setting mechanism for result (and context) files saving.

Throws:

GException - GENIUS exception

customPreProcessManagement

protected abstract void customPreProcessManagement()
                                            throws GFileManipulatorException

Abstract method where setting customized pre process management.

Throws:

GFileManipulatorException - exception when error after reading context files.

customPostProcessManagement

protected abstract void customPostProcessManagement()

Abstract method where setting customized post process management.

isDebugMode

public static boolean isDebugMode()

Method to get debug mode.

Returns:

the debug mode.

setDebugMode

public static void setDebugMode(boolean mode)

Method to configure in debug mode or not.

Parameters:

mode - debug mode if true

resetContextFileName

public static void resetContextFileName(String newName)

Reset the name of the context file (if null, text set to "no context")

Parameters:

newName - new context name