fr.cnes.genius.lowLevel

Class GDialog

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genius.lowLevel.GDialog

All Implemented Interfaces:

GDisplay, MouseWheelListener, WindowListener, EventListener

Direct Known Subclasses:

GAboutDialog, GCalculator, GCalculatorCreateFileInfos, GCalculatorMessage, GCalculatorRef, GDialogPrefix, GOverrideFileDialog, GSaveResults, GStandardDialog, GStandardPanelDialog

public abstract class GDialog
extends GPanel
implements WindowListener

Represents a dialog object. When the dialog object is hidden, it is not destroyed. The class GDialog defines a widget panel with an associated title in order to display the content. The display can be modal or not modal. In both cases, it is displayed with method show(), and hidden with method hide(boolean). This class extends the class GPanel (to display the content). When calling show(), the method GPanel.mainClear() is called before displaying in order to re-initialize the content.

Author:

jjct

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
GDialog(String title) Constructor.
GDialog(String widgetId, String title) Constructor.

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose the dialog.
boolean	getCancelled() Get the flag indicating if the dialog was closed by a cancel operation (cancel button or close window).
JDialog	getJDialog() Get the associated JDialog.
void	hide(boolean isCancelled) Hide the dialog from the screen.
void	setMaximumSize(Dimension d) Set the maximum size of the dialog.
void	setMinimumSize(Dimension d) Set the minimum size of the dialog.
void	setPreferredSize(Dimension d) Set the preferred size of the dialog.
void	show() Show the dialog on the screen.
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.lowLevel.GPanel

clearConstraint, generic, getClassConstraint, getComponent, getHorizontalScroll, getInnerDescendantClassConstraint, getJPanel, getJScrollPane, getLayoutConstraints, getStringClassConstraint, getVerticalScroll, mainClear, mainDisplay, processMouseWheelEvent, put, setClassConstraint, setColumnConstraints, setConstraint, setDefaultConstraints, 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

Methods inherited from interface fr.cnes.genius.main.GDisplay

display

Constructor Detail

GDialog

public GDialog(String title)

Constructor. The widget identifier is automatically assigned.

Parameters:

title - to be displayed in the frame.

GDialog

public GDialog(String widgetId,
               String title)

Constructor.

Parameters:

widgetId - widget identifier.

title - to be displayed in the frame.

Method Detail

getJDialog

public JDialog getJDialog()

Get the associated JDialog.

Returns:

the associated JDialog.

show

public void show()
          throws GException

Show the dialog on the screen.

Throws:

GException - in case of problem clearing the dialog.

dispose

public void dispose()

Dispose the dialog.

hide

public void hide(boolean isCancelled)

Hide the dialog from the screen.

Parameters:

isCancelled - Indicates if the dialog is hidden because it is cancelled or by another cause.

getCancelled

public boolean getCancelled()

Get the flag indicating if the dialog was closed by a cancel operation (cancel button or close window).

Returns:

true if the dialog was closed by a cancel operation (cancel button or close window), false otherwise.

setMinimumSize

public void setMinimumSize(Dimension d)

Set the minimum size of the dialog.

Parameters:

d - minimum size dimension.

setPreferredSize

public void setPreferredSize(Dimension d)

Set the preferred size of the dialog.

Parameters:

d - preferred size dimension.

setMaximumSize

public void setMaximumSize(Dimension d)

Set the maximum size of the dialog.

Parameters:

d - maximum size dimension.

windowClosing

public void windowClosing(WindowEvent e)

Specified by:

windowClosing in interface WindowListener

windowOpened

public void windowOpened(WindowEvent e)

Specified by:

windowOpened 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