fr.cnes.genius.lowLevel

Class GFrame

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GFrame

All Implemented Interfaces:

MouseWheelListener, WindowListener, EventListener

Direct Known Subclasses:

GPanTest

public class GFrame
extends GComponent
implements WindowListener

The class GFrame defines a high-level window including a title and a menu bar. The window can be displayed with method display(), and its minimum size can be fixed with method setMinimumSize(Dimension). By default, the windows dimensions are modifiable. *

Author:

jjct

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GFrame.CloseAction Enumerated listing the possible behaviors of the GFrame when the window is closed by the window manager: DoNothingOnClose: Don't do anything; require the program to handle the operation in the before or after methods.

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
GFrame(String title, GPanel panel) Constructor.
GFrame(String title, GPanel panel, GMenuBar menuBar) Constructor.
GFrame(String widgetId, String title, GPanel panel) Constructor.
GFrame(String widgetId, String title, GPanel panel, GMenuBar menuBar) Constructor.

Method Summary

Modifier and Type	Method and Description
void	display() Display the frame in the screen.
void	dispose() Close the frame.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
JFrame	getJFrame() Return the JFrame associated with the GFrame.
void	setDefaultCloseOperation(GFrame.CloseAction action) Set the default action for the close operation.
void	setGMenuBar(GMenuBar menuBar) Set the menuBar to the frame.
void	setGPanel(GPanel panel) Set the panel in the container area.
void	setMaximumSize(Dimension d) Set the maximum size of the frame.
void	setMinimumSize(Dimension d) Set the minimum size of the frame.
void	setPreferredSize(Dimension d) Set the preferred size of the frame.
void	windowActivated(WindowEvent e)
void	windowClosed(WindowEvent e)
void	windowClosing(WindowEvent e)
void	windowDeactivated(WindowEvent e)
void	windowDeiconified(WindowEvent e)
void	windowIconified(WindowEvent e)
void	windowOpened(WindowEvent 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, setEnabled, setForcedStatus, 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

GFrame

public GFrame(String title,
              GPanel panel)

Constructor. No menu bar is displayed. The widget identifier is automatically assigned.

Parameters:

title - to be displayed in the frame.

panel - to be displayed in the container area.

GFrame

public GFrame(String title,
              GPanel panel,
              GMenuBar menuBar)

Constructor. The widget identifier is automatically assigned.

Parameters:

title - to be displayed in the frame.

panel - to be displayed in the container area.

menuBar - to be displayed in the frame.

GFrame

public GFrame(String widgetId,
              String title,
              GPanel panel)

Constructor. No menu bar is displayed.

Parameters:

widgetId - widget identifier.

title - to be displayed in the frame.

panel - to be displayed in the container area.

GFrame

public GFrame(String widgetId,
              String title,
              GPanel panel,
              GMenuBar menuBar)

Constructor.

Parameters:

widgetId - widget identifier.

title - to be displayed in the frame.

panel - to be displayed in the container area.

menuBar - to be displayed in the frame.

Method Detail

setGPanel

public final void setGPanel(GPanel panel)

Set the panel in the container area.

Overrides:

setGPanel in class GComponent

Parameters:

panel - to be displayed in the container area.

setGMenuBar

public final void setGMenuBar(GMenuBar menuBar)

Set the menuBar to the frame.

Parameters:

menuBar - to be displayed in the frame.

setDefaultCloseOperation

public final void setDefaultCloseOperation(GFrame.CloseAction action)

Set the default action for the close operation.

Parameters:

action - the default action for the close operation.

dispose

public void dispose()

Close the frame.

display

public void display()

Display the frame in the screen.

setMinimumSize

public void setMinimumSize(Dimension d)

Set the minimum size of the frame.

Parameters:

d - minimum size dimension.

setPreferredSize

public void setPreferredSize(Dimension d)

Set the preferred size of the frame.

Parameters:

d - preferred size dimension.

setMaximumSize

public void setMaximumSize(Dimension d)

Set the maximum size of the frame.

Parameters:

d - maximum size dimension.

getJFrame

public JFrame getJFrame()

Return the JFrame associated with the GFrame.

Returns:

the JFrame associated with the GFrame.

getComponent

public Component getComponent()

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.

windowOpened

public void windowOpened(WindowEvent e)

Specified by:

windowOpened in interface WindowListener

windowClosing

public void windowClosing(WindowEvent e)

Specified by:

windowClosing in interface WindowListener

windowClosed

public void windowClosed(WindowEvent e)

Specified by:

windowClosed in interface WindowListener

windowIconified

public void windowIconified(WindowEvent e)

Specified by:

windowIconified in interface WindowListener

windowDeiconified

public void windowDeiconified(WindowEvent e)

Specified by:

windowDeiconified in interface WindowListener

windowActivated

public void windowActivated(WindowEvent e)

Specified by:

windowActivated in interface WindowListener

windowDeactivated

public void windowDeactivated(WindowEvent e)

Specified by:

windowDeactivated in interface WindowListener