fr.cnes.genius.lowLevel

Class GTabbedPane

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GTabbedPane

All Implemented Interfaces:

GCondensedIsModifiedInterface, GCondensedStatusInterface, GDisplay, GReadWrite, MouseWheelListener, EventListener, ChangeListener

Direct Known Subclasses:

GDataPanelAbstract

public class GTabbedPane
extends GComponent
implements GDisplay, GReadWrite, ChangeListener, GCondensedStatusInterface, GCondensedIsModifiedInterface

Tabbed pane widget based on the JTabbedPane Swing widget.

Author:

jjct

Default Constraint(s):

Index	Class	Item	Constraint
0	MyPanel	tab0	"newline , pushx , pushy , growx , growy"
1	MyPanel	tab1	"newline , pushx , pushy , growx , growy"
...	...	...	...
i	MyPanel	tabi	"newline , pushx , pushy , growx , growy"

Note:

MyPanel is just a dummy name to represent any class descending de GPanel.

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
GTabbedPane() Constructor by default.
GTabbedPane(String name) Constructor.
GTabbedPane(String widgetId, String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addTab(String title, GPanel panel) Add a GPanel to the widget.
void	addTab(String title, GPanel panel, String tooltip) Add a GPanel to the widget.
void	addTab(String title, GPanel panel, String tooltip, boolean tabPanelStatusFlag) Add a GPanel to the widget.
void	delTab(int tabIndex) Remove a tab by its index.
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	forceIndexesReading(int[] indexes) force tab orders to read
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
JTabbedPane	getJTabbedPane() Return the JTabbedPane associated with the widget.
GComponent	getSubComponent(int position) Gets the subcomponent occupying the position defined by position.
GPanel	getTab(int tabIndex) Get a tab by its index.
int	getTabCount() Get the current number of tabs.
List<GPanel>	getTabList() Get the list of GPanels manager by the GTabbedPane.
boolean	getTabPanelStatusFlag(int tabIndex) Get the status flag of the tab panel.
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.
static void	setErrorColor(Color errorColor) Set the error color.
static void	setErrorIcon(ImageIcon errorIcon) Set the error icon.
void	setTabPanelStatusFlag(int tabIndex, boolean tabPanelStatusFlag) Set the status flag for a the tab panel.
void	setTooltipsList(String[] tooltipsList) Set a tooltip to each tab in the GTabbedPane.
static void	setWarningColor(Color warningColor) Set the warning color.
static void	setWarningIcon(ImageIcon warningIcon) Set the warning icon.
void	stateChanged(ChangeEvent e)
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, processMouseWheelEvent, 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

GTabbedPane

public GTabbedPane()

Constructor by default.

GTabbedPane

public GTabbedPane(String name)

Constructor. The widgetId will be automatically assigned.

Parameters:

name - in the configuration file.

GTabbedPane

public GTabbedPane(String widgetId,
                   String name)

Constructor.

Parameters:

widgetId - identifier of the widget.

name - in the configuration file.

Method Detail

addTab

public void addTab(String title,
                   GPanel panel)
            throws GException

Add a GPanel to the widget.

Parameters:

title - of the tab.

panel - to add.

Throws:

GException - If there is a problem displaying the added panel.

addTab

public void addTab(String title,
                   GPanel panel,
                   String tooltip)
            throws GException

Add a GPanel to the widget.

Parameters:

title - of the tab.

panel - to add.

tooltip - for the tab.

Throws:

GException - If there is a problem displaying the added panel.

addTab

public void addTab(String title,
                   GPanel panel,
                   String tooltip,
                   boolean tabPanelStatusFlag)
            throws GException

Add a GPanel to the widget.

Parameters:

title - of the tab.

panel - to add.

tooltip - for the tab.

tabPanelStatusFlag - true if the status of the tab is updated from the contained GPanel, false otherwise.

Throws:

GException - If there is a problem displaying the added panel.

delTab

public void delTab(int tabIndex)

Remove a tab by its index.

Parameters:

tabIndex - index of the tab to remove.

getTab

public GPanel getTab(int tabIndex)

Get a tab by its index.

Parameters:

tabIndex - index of the tab to get.

Returns:

tab for the index.

getTabCount

public int getTabCount()

Get the current number of tabs.

Returns:

the current number of tabs

setTabPanelStatusFlag

public void setTabPanelStatusFlag(int tabIndex,
                                  boolean tabPanelStatusFlag)

Set the status flag for a the tab panel.

Parameters:

tabIndex - index of the tab panel to set the status flag.

tabPanelStatusFlag - value of the status flag to set.

getTabPanelStatusFlag

public boolean getTabPanelStatusFlag(int tabIndex)

Get the status flag of the tab panel.

Parameters:

tabIndex - index of the tab panel to set the status flag.

Returns:

value of the status flag for the tab panel.

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.

getJTabbedPane

public JTabbedPane getJTabbedPane()

Return the JTabbedPane associated with the widget.

Returns:

the JTabbedPane associated with the widget.

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.

stateChanged

public void stateChanged(ChangeEvent e)

Specified by:

stateChanged in interface ChangeListener

setTooltipsList

public void setTooltipsList(String[] tooltipsList)

Set a tooltip to each tab in the GTabbedPane.

Parameters:

tooltipsList - the list of tooltips for the tabs.

setErrorIcon

public static void setErrorIcon(ImageIcon errorIcon)

Set the error icon.

Parameters:

errorIcon - the icon to set for errors.

setWarningIcon

public static void setWarningIcon(ImageIcon warningIcon)

Set the warning icon.

Parameters:

warningIcon - the icon to set for warnings.

setErrorColor

public static void setErrorColor(Color errorColor)

Set the error color.

Parameters:

errorColor - the color to set for errors in tabs.

setWarningColor

public static void setWarningColor(Color warningColor)

Set the warning color.

Parameters:

warningColor - the color to set for warnings in tabs.

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.

getTabList

public List<GPanel> getTabList()

Get the list of GPanels manager by the GTabbedPane. The returned list is unmodifiable.

Returns:

the unmodifiable list of GPanels manager by the GTabbedPane.

forceIndexesReading

public void forceIndexesReading(int[] indexes)

force tab orders to read

Parameters:

indexes - of the reading