fr.cnes.genius.lowLevel

Class GButton

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GButton

All Implemented Interfaces:

GDisplay, ActionListener, MouseWheelListener, EventListener

Direct Known Subclasses:

GColorChooser, GCommandLauncher.GExecButton, GOpenCloseButton

public class GButton
extends GComponent
implements GDisplay, ActionListener

This class represents a push button, that can be enabled or disabled at will. The push button can contain a label, an image or an image and a label. An action can be linked to he button through the after method or the container class. When the button is pressed, a GEvent event is generated. An example of the button usage can be found in GButtonText_001.java.

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
GButton(ImageIcon ico) Constructor to create a button with an icon on it.
GButton(String text) Constructor to create a button with a string label on it.
GButton(String widgetId, ImageIcon ico) Constructor to create a button with an icon on it.
GButton(String widgetId, String text) Constructor to create a button with a string label on it.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
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.
JButton	getJButton() Get the Swing JButton encapsulated by the class.
void	setIcon(ImageIcon ico) Set the icon to display in the button.
void	setIcon(String path) Set the icon to display in the button by the path of the icon file.
void	setShortcut(int shorcutKey) Set the shortcut key for pushing the GButton.
void	setText(String text) Set the text to display in the button.
void	setToolTipText(String text) Set the tooltip text for the entry's label.

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, 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

GButton

public GButton(String text)

Constructor to create a button with a string label on it. the widgetId is automatically assigned.

Parameters:

text - to display in the buttons label.

GButton

public GButton(ImageIcon ico)

Constructor to create a button with an icon on it. the widgetId is automatically assigned.

Parameters:

ico - icon to display on the button.

GButton

public GButton(String widgetId,
               ImageIcon ico)

Constructor to create a button with an icon on it.

Parameters:

widgetId - Widget identifier.

ico - icon to display on the button.

GButton

public GButton(String widgetId,
               String text)

Constructor to create a button with a string label on it.

Parameters:

widgetId - Widget identifier.

text - to display in the buttons label.

Method Detail

setIcon

public void setIcon(ImageIcon ico)

Set the icon to display in the button.

Parameters:

ico - icon to display in the button.

setText

public void setText(String text)

Set the text to display in the button.

Parameters:

text - text to display in the button.

setIcon

public void setIcon(String path)

Set the icon to display in the button by the path of the icon file.

Parameters:

path - of the icon to display in the button.

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

getJButton

public JButton getJButton()

Get the Swing JButton encapsulated by the class.

Returns:

Swing button 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.

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

setToolTipText

public void setToolTipText(String text)

Set the tooltip text for the entry's label.

Overrides:

setToolTipText in class GComponent

Parameters:

text - the tooltip text for the entry's label.

setShortcut

public void setShortcut(int shorcutKey)

Set the shortcut key for pushing the GButton.

Parameters:

shorcutKey - the shortcut key to be attached to the button.