fr.cnes.genius.lowLevel

Class GProgressBar

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GProgressBar

All Implemented Interfaces:

GDisplay, MouseWheelListener, EventListener

public class GProgressBar
extends GComponent
implements GDisplay

This class represents a progress bar basically to be used for representing the progress of the GCommandLauncher processes.

Author:

jjct

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
GProgressBar(int value) Constructor to create a progress bar with an initial value on it.
GProgressBar(String widgetId, int orientation, int value) Constructor to create a progress bar with an initial value on it.

Method Summary

Modifier and Type	Method and Description
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.
JProgressBar	getJProgressBar() Get the Swing JProgressBar encapsulated by the class.
void	setIndeterminate(boolean flag) Set the progressBar to the indeterminate representation.
void	setProgressValue(Integer value) Launches an event to the main GUI thread queue to update the progress bar percentage with a given value.
void	setStringPainted(boolean flag) Sets if the string shall be painted or not.
void	setValue(int value) Set the value for the progress bar.

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

Constructor Detail

GProgressBar

public GProgressBar(int value)

Constructor to create a progress bar with an initial value on it. the widgetId is automatically assigned.

Parameters:

value - of the progress.

GProgressBar

public GProgressBar(String widgetId,
                    int orientation,
                    int value)

Constructor to create a progress bar with an initial value on it.

Parameters:

widgetId - Widget identifier.

orientation - of the progressBar.

value - of the progress.

Method Detail

setValue

public void setValue(int value)

Set the value for the progress bar. Do not call this method from a thread different to the main GUI one (method setProgressValue(Integer) can be used in this case).

Parameters:

value - of the progress.

setProgressValue

public void setProgressValue(Integer value)

Launches an event to the main GUI thread queue to update the progress bar percentage with a given value. This function is thread safe and might be called from a thread different from the main GUI one.

Parameters:

value - to set to the progress bar, if -1 the progress bar is set to indertermined mode.

setIndeterminate

public void setIndeterminate(boolean flag)

Set the progressBar to the indeterminate representation.

Parameters:

flag - true if the representation is indeterminate, false otherwise.

setStringPainted

public void setStringPainted(boolean flag)

Sets if the string shall be painted or not.

Parameters:

flag - true if the string shall be painted, false otherwise.

display

public 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.

Specified by:

display in interface GDisplay

getJProgressBar

public JProgressBar getJProgressBar()

Get the Swing JProgressBar encapsulated by the class.

Returns:

Swing JProgressBar encapsulated by the class.

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.