fr.cnes.genius.lowLevel

Class GSplitPane

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GSplitPane

All Implemented Interfaces:

GClear, GCondensedIsModifiedInterface, GCondensedStatusInterface, GDisplay, GReadWrite, MouseWheelListener, EventListener

public class GSplitPane
extends GComponent
implements GDisplay, GReadWrite, GClear, GCondensedStatusInterface, GCondensedIsModifiedInterface

GSplitPane is used to divide two (and only two) GComponents. The two GComponents are graphically divided based on the look and feel implementation, and the two GComponents can then be interactively resized by the user. The two Components in a split pane can be aligned left to right using JSplitPane.HORIZONTAL_SPLIT, or top to bottom using JSplitPane.VERTICAL_SPLIT.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	MyPanel	leftPanel	"newline , pushx , pushy , growx , growy"
1	MyPanel	rightPanel	"newline , pushx , pushy , growx , growy"

Note:

The example is given for an HORIZONTAL split.

Nested Class Summary

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
GSplitPane() Constructor by default.
GSplitPane(String name, int newOrientation, GPanel leftGPanel, GPanel rightGPanel) Create a new split pane component with 2 panes, the orientation can be horizontal or vertical.
GSplitPane(String widgetId, String name, int newOrientation, GPanel leftGPanel, GPanel rightGPanel) Create a new split pane component with 2 panes, the orientation can be horizontal or vertical.

Method Summary

Modifier and Type	Method and Description
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.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
JSplitPane	getJSplitPane() Get the swing JSplitPane component.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
void	processMouseWheelEvent(MouseWheelEvent e) Process mouse wheel event.
void	read() Implementaion of the routines that allow the component to be loaded from a configuration file.
void	setEnabled(boolean flag) Set the enable status of the component.
void	updateCondensedStatus(GCondensedStatus condensedStatus) Update a condensed status object with the status of one or more components.
void	updateIsModified(GCondensedIsModified condensedIsModified) Update a condensed isModified object with the status of one or more components.
void	write() Implementaion of the routines that allow the component to be saved to a configuration file.

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

GSplitPane

public GSplitPane()

Constructor by default.

GSplitPane

public GSplitPane(String name,
                  int newOrientation,
                  GPanel leftGPanel,
                  GPanel rightGPanel)

Create a new split pane component with 2 panes, the orientation can be horizontal or vertical. The widget identifier is automatically assigned.

Parameters:

name - in the configuration file.

newOrientation - JSplitPane.HORIZONTAL_SPLIT or JSplitPane.VERTICAL_SPLIT

leftGPanel - the GPanel that will appear on the left of a horizontally-split pane, or at the top of a vertically-split pane.

rightGPanel - the GPanel that will appear on the right of a horizontally-split pane, or at the bottom of a vertically-split pane.

GSplitPane

public GSplitPane(String widgetId,
                  String name,
                  int newOrientation,
                  GPanel leftGPanel,
                  GPanel rightGPanel)

Create a new split pane component with 2 panes, the orientation can be horizontal or vertical.

Parameters:

widgetId - widget identifier.

name - in the configuration file.

newOrientation - JSplitPane.HORIZONTAL_SPLIT or JSplitPane.VERTICAL_SPLIT

leftGPanel - the GPanel that will appear on the left of a horizontally-split pane, or at the top of a vertically-split pane.

rightGPanel - the GPanel that will appear on the right of a horizontally-split pane, or at the bottom of a vertically-split pane.

Method Detail

setEnabled

public void setEnabled(boolean flag)

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

flag - new enable status of the component.

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.

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.

getJSplitPane

public JSplitPane getJSplitPane()

Get the swing JSplitPane component.

Returns:

the swing JSplitPane component.

processMouseWheelEvent

public void processMouseWheelEvent(MouseWheelEvent e)

Process mouse wheel event.

Overrides:

processMouseWheelEvent in class GComponent

Parameters:

e - event to process

read

public void read()
          throws GException

Implementaion of the routines that allow the component to be loaded from a configuration file.

Specified by:

read in interface GReadWrite

Throws:

GException - in case of problem while reading the value from file.

write

public void write()
           throws GException

Implementaion of the routines that allow the component to be saved to a configuration file.

Specified by:

write in interface GReadWrite

Throws:

GException - in case of problem while writing the value to file.

updateCondensedStatus

public void updateCondensedStatus(GCondensedStatus condensedStatus)

Update a condensed status object with the status of one or more components. In almost 100% of cases the implementation of this method should just make :

condensedStatus.update(widget1, widget2, etc)

Being widget_i the widgets contained in current component with a status defined. These widgets might be simple components that have redefined the setStatus(GStatus) method or complex components, having other subcomponents and implementing also this interface.

Specified by:

updateCondensedStatus in interface GCondensedStatusInterface

Parameters:

condensedStatus - the condensed status object to be updated.

updateIsModified

public void updateIsModified(GCondensedIsModified condensedIsModified)

Update a condensed isModified object with the status of one or more components. In almost 100% of cases the implementation of this method should just make :

condensedIsModified.update(widget1, widget2, etc)

Being widget_i the widgets contained in current component with a status defined. These widgets might be simple components that have redefined the setStatus(GStatus) method or complex components, having other subcomponents and implementing also this interface.

Specified by:

updateIsModified in interface GCondensedIsModifiedInterface

Parameters:

condensedIsModified - the condensed isModified object to be updated.

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.

clear

public void clear()
           throws GException

Description copied from interface: GClear

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.