fr.cnes.genius.lowLevel

Class GPanel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

All Implemented Interfaces:

GDisplay, MouseWheelListener, EventListener

Direct Known Subclasses:

GCalculatorCommand, GCalculatorFormula, GComponentList, GDetachedPanel, GDialog, GGroundPlotPanel, GListSelect, GLogEventTablePanel, GMainFrameAbstract, GMultipleStructureChoice, GPlot, GPlotPanel, GSqliteOutputVarPanel, GTable1D, GTable2D

public abstract class GPanel
extends GComponent
implements GDisplay

Class corresponding to the SWING component JPanel, representing a panel where the different widgets are displayed. This class holds the layout manager to use during the display of classes, the hierarchy of classes is automatically created when calling put() in the display method of the subclasses. It is also in charge of requests to record or read the configuration file. The widgets handled by a panel, may inherit directly from it, or inherit of GContainer objects which themselves inherit from GPanel.

Author:

jjct

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GPanel.Panel Extended class of a JPanel containing a list of components to display.
static class	GPanel.ScrollBarVisibility Enumerate to list the possible visibilities for a scroll bar.

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
GPanel() Default Constructor
GPanel(String widgetId) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearConstraint() Clears the constraint for the component.
abstract void	generic() Abstract generic function that need to be implemented by the descendants.
GConstraint	getClassConstraint(Class<?> className) Get the class constraint for the widgets of a certain class included into this panel.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
GPanel.ScrollBarVisibility	getHorizontalScroll() Gets the horizontal scroll bar policy applying to the panel.
GConstraint	getInnerDescendantClassConstraint(Class<?> ownerClass, Integer... positionArray) Get the class constraint applying to all the subcomponents in a given position of the widgets of a certain class included into this panel.
JPanel	getJPanel() Return the JPanel associated with the GPanel.
JScrollPane	getJScrollPane() Return the JSCrollPane associated with the panel.
Object	getLayoutConstraints() Get the layout constraints.
String	getStringClassConstraint(String defaultConstraint, Class<?> ownerClass, Integer... positionArray) Get the constraint applying to a certain component.
GPanel.ScrollBarVisibility	getVerticalScroll() Gets the vertical scroll bar policy applying to the panel.
void	mainClear() Method to refresh the contents of the GPanel.
void	mainDisplay() Method to refresh the contents of the GPanel.
void	processMouseWheelEvent(MouseWheelEvent e) Process mouse wheel event.
void	put(GComponent component) Depending on the current on-going operation (Display, Read or Write) the component is displayed, or read/written to the configuration file.
void	setClassConstraint(GConstraint constraint, Class<?> className) Set the class constraint for the widgets of a certain class included into this panel.
void	setColumnConstraints(Object object) Set the column constraints.
void	setConstraint(GConstraint constraint) Set the constraint for the component.
protected void	setDefaultConstraints() set the defaults constraints
void	setHorizontalScroll(GPanel.ScrollBarVisibility visibility) Sets an horizontal scroll bar to the panel.
void	setInnerDescendantClassConstraint(GConstraint constraint, Class<?> ownerClass, Integer... positionArray) Set the class constraint for all the given subcomponents of the widgets of a certain class included into this panel.
void	setLayoutConstraints(Object object) Set the layout constraints.
void	setMargins(int top, int left, int bottom, int right) Set margins.
protected void	setPanelConstraints() Set panel constraints.
void	setPreferredSize(int width, int height) Set preferred size for the panel.
void	setRowConstraints(Object object) Set the row constraints.
void	setUnitIncrement() Set unit increment
void	setVerticalScroll(GPanel.ScrollBarVisibility visibility) Sets an vertical scroll bar to the panel.
void	unput(GComponent component) Unput component.

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

GPanel

public GPanel()

Default Constructor

GPanel

public GPanel(String widgetId)

Constructor.

Parameters:

widgetId - widget identifier.

Method Detail

processMouseWheelEvent

public void processMouseWheelEvent(MouseWheelEvent e)

Process mouse wheel event.

Overrides:

processMouseWheelEvent in class GComponent

Parameters:

e - event to process

setUnitIncrement

public final void setUnitIncrement()

Set unit increment

setPanelConstraints

protected final void setPanelConstraints()

Set panel constraints.

setDefaultConstraints

protected void setDefaultConstraints()

set the defaults constraints

Overrides:

setDefaultConstraints in class GComponent

setLayoutConstraints

public void setLayoutConstraints(Object object)

Set the layout constraints.

Parameters:

object - for which the constraints are set

setMargins

public void setMargins(int top,
                       int left,
                       int bottom,
                       int right)

Set margins.

Parameters:

top - top margin

left - left margin

bottom - bottom margin

right - right margin

getLayoutConstraints

public Object getLayoutConstraints()

Get the layout constraints.

Returns:

object the set constraints

setColumnConstraints

public void setColumnConstraints(Object object)

Set the column constraints.

Parameters:

object - for which the constraints are set

setRowConstraints

public void setRowConstraints(Object object)

Set the row constraints.

Parameters:

object - for which the constraints are set

setInnerDescendantClassConstraint

public void setInnerDescendantClassConstraint(GConstraint constraint,
                                              Class<?> ownerClass,
                                              Integer... positionArray)

Set the class constraint for all the given subcomponents of the widgets of a certain class included into this panel.

Parameters:

constraint - constraint to set to the owner class subcomponent.

ownerClass - name of the "owner" class whose subcomponents will be affected by the constraint.

positionArray - array representing the position of the component into the owner class that will receive the constraint.

setClassConstraint

public void setClassConstraint(GConstraint constraint,
                               Class<?> className)

Set the class constraint for the widgets of a certain class included into this panel.

Parameters:

constraint - constraint to set to all instances of the class in the current panel.

className - name of the class whose instances will be affected by the constraint.

getInnerDescendantClassConstraint

public GConstraint getInnerDescendantClassConstraint(Class<?> ownerClass,
                                                     Integer... positionArray)

Get the class constraint applying to all the subcomponents in a given position of the widgets of a certain class included into this panel.

Parameters:

ownerClass - name of the "owner" class whose subcomponents constraint is searched for.

positionArray - array representing the position of the subcomponent into the owner class.

Returns:

constraint assigned to the subcomponent.

getClassConstraint

public GConstraint getClassConstraint(Class<?> className)

Get the class constraint for the widgets of a certain class included into this panel.

Parameters:

className - name of the "owner" class whose instances constraint is searched for.

Returns:

constraint assigned to all instances of the "owner" class in the current panel.

getStringClassConstraint

public String getStringClassConstraint(String defaultConstraint,
                                       Class<?> ownerClass,
                                       Integer... positionArray)

Get the constraint applying to a certain component. If there is a class constraint defined, it will be applied, otherwise the input default constraint will be.

Parameters:

defaultConstraint - applying in case of null class constraint.

ownerClass - the owner class whose constraint is to be searched for.

positionArray - array representing the position into the owner class of the component.

Returns:

the constraint.

unput

public void unput(GComponent component)

Unput component.

Parameters:

component - component

put

public void put(GComponent component)
         throws GException

Depending on the current on-going operation (Display, Read or Write) the component is displayed, or read/written to the configuration file.

Parameters:

component - to display, read or write.

Throws:

GException - In case of problem while reading or writing.

getComponent

public Component getComponent()

Description copied from class: GComponent

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.

getJPanel

public JPanel getJPanel()

Return the JPanel associated with the GPanel.

Returns:

the JPanel associated with the GPanel.

getJScrollPane

public JScrollPane getJScrollPane()

Return the JSCrollPane associated with the panel.

Returns:

the JSCrollPane associated with the panel.

setHorizontalScroll

public void setHorizontalScroll(GPanel.ScrollBarVisibility visibility)

Sets an horizontal scroll bar to the panel.

Parameters:

visibility - for the scroll bar:
GPanel.ScrollBarVisibility.ALLWAYS,
GPanel.ScrollBarVisibility.NEVER,
GPanel.ScrollBarVisibility.AS_NEEDED

getHorizontalScroll

public GPanel.ScrollBarVisibility getHorizontalScroll()

Gets the horizontal scroll bar policy applying to the panel.

Returns:

visibility for the scroll bar:
GPanel.ScrollBarVisibility.ALLWAYS,
GPanel.ScrollBarVisibility.NEVER,
GPanel.ScrollBarVisibility.AS_NEEDED

setVerticalScroll

public void setVerticalScroll(GPanel.ScrollBarVisibility visibility)

Sets an vertical scroll bar to the panel.

Parameters:

visibility - for the scroll bar:
GPanel.ScrollBarVisibility.ALLWAYS,
GPanel.ScrollBarVisibility.NEVER,
GPanel.ScrollBarVisibility.AS_NEEDED

getVerticalScroll

public GPanel.ScrollBarVisibility getVerticalScroll()

Gets the vertical scroll bar policy applying to the panel.

Returns:

visibility for the scroll bar:
GPanel.ScrollBarVisibility.ALLWAYS,
GPanel.ScrollBarVisibility.NEVER,
GPanel.ScrollBarVisibility.AS_NEEDED

setPreferredSize

public void setPreferredSize(int width,
                             int height)

Set preferred size for the panel. If not set it will adapt to its contents, but if they are too big the panel could grow beyond the screen limits.

Parameters:

width - preferred width for the panel.

height - preferred height for the panel.

generic

public abstract void generic()
                      throws GException

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

Throws:

GException - in case of problem.

mainDisplay

public void mainDisplay()
                 throws GException

Method to refresh the contents of the GPanel.

Throws:

GException - if a child component raises an exception.

mainClear

public void mainClear()
               throws GException

Method to refresh the contents of the GPanel.

Throws:

GException - if a child component raises an exception.

clearConstraint

public void clearConstraint()

Clears the constraint for the component.

Overrides:

clearConstraint in class GComponent

setConstraint

public void setConstraint(GConstraint constraint)

Set the constraint for the component.

Overrides:

setConstraint in class GComponent

Parameters:

constraint - constraint to set for the component.