fr.cnes.genius.lowLevel

Class GStandardPanelDialog

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genius.lowLevel.GDialog

fr.cnes.genius.lowLevel.GStandardPanelDialog

All Implemented Interfaces:

GClear, GDisplay, MouseWheelListener, WindowListener, EventListener

public class GStandardPanelDialog
extends GDialog
implements GClear

Class used to created dialogs with standard buttons. This class can be used to derive other dialogs with standard buttons.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	MyPanel	panel	"newline"
1	ButtonPanel	buttonBox	"dock South" (see table below)

Default Constraint(s) for buttonBox:

Index	Class	Item	Constraint
1, 0	GButton	m_yesButton	"split 2 , alignx Left"
1, 1	GButton	m_noButton	"alignx Left"
1, 2	GButton	m_cancelButton	"alignx Right"

Note:

MyPanel is just a dummy name to represent the any class descending from GPanel. The example is given for a "Yes / No / Cancel" standard dialog type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GStandardPanelDialog.TypeOfDialog Enumerate defining the possible configurations of the dialog buttons.

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
GStandardPanelDialog(String title, GPanel mainPanel, GStandardPanelDialog.TypeOfDialog typeDialog) Constructor.
GStandardPanelDialog(String widgetId, String title, GPanel mainPanel, GStandardPanelDialog.TypeOfDialog typeDialog) Constructor.

Method Summary

Modifier and Type	Method and Description
void	beforeClickingButtons() Actions to be performed before clicking any button.
void	clear() Called when the element is to be cleared, so it can perform the actions required to return to the last saved/loaded values.
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	generic() Abstract generic function that need to be implemented by the descendants.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
void	onButtonOne() Actions to be performed when clicking in OK or YES buttons.
void	onButtonTwo() Actions to be performed when clicking in CANCEL or NO buttons.
protected void	setDefaultConstraints() set the defaults constraints
void	setGPanel(GPanel mainPanel) Set the main panel.
void	show() Show the dialog on the screen.

Methods inherited from class fr.cnes.genius.lowLevel.GDialog

dispose, getCancelled, getJDialog, hide, setMaximumSize, setMinimumSize, setPreferredSize, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

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

GStandardPanelDialog

public GStandardPanelDialog(String title,
                            GPanel mainPanel,
                            GStandardPanelDialog.TypeOfDialog typeDialog)

Constructor. The widget identifier is assigned automatically.

Parameters:

title - of the dialog.

mainPanel - GPanel to be included in the dialog.

typeDialog - type of the dialog, that defines the buttons that will be displayed in the dialog.

GStandardPanelDialog

public GStandardPanelDialog(String widgetId,
                            String title,
                            GPanel mainPanel,
                            GStandardPanelDialog.TypeOfDialog typeDialog)

Constructor.

Parameters:

widgetId - widget identifier.

title - of the dialog.

mainPanel - GPanel to be included in the dialog.

typeDialog - type of the dialog, that defines the buttons that will be displayed in the dialog.

Method Detail

setDefaultConstraints

protected final void setDefaultConstraints()

Description copied from class: GPanel

set the defaults constraints

Overrides:

setDefaultConstraints in class GPanel

setGPanel

public void setGPanel(GPanel mainPanel)

Set the main panel.

Overrides:

setGPanel in class GComponent

Parameters:

mainPanel - the new main panel.

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.

clear

public void clear()
           throws GException

Called when the element is to be cleared, so it can perform the actions required to return to the last saved/loaded values.

Specified by:

clear in interface GClear

Throws:

GException - in case of problem while clearing the values.

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.

show

public void show()

Show the dialog on the screen.

Overrides:

show in class GDialog

onButtonOne

public void onButtonOne()

Actions to be performed when clicking in OK or YES buttons.

onButtonTwo

public void onButtonTwo()

Actions to be performed when clicking in CANCEL or NO buttons.

beforeClickingButtons

public void beforeClickingButtons()

Actions to be performed before clicking any button.

getSubComponent

public GComponent getSubComponent(int position)
                           throws GComponentException

Gets the subcomponent occupying the position defined by position.

Overrides:

getSubComponent in class GComponent

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.