fr.cnes.genius.lowLevel

Class GImage

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GImage

All Implemented Interfaces:

GDisplay, MouseWheelListener, EventListener

public class GImage
extends GComponent
implements GDisplay

Widget used to display an image. It is based on a JLabel SWING component. The class defines a label that will be used to contain an image. This image may be specified by an icon or by the image file path

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
GImage(Icon icon) Constructor.
GImage(String iconFileName) Constructor.
GImage(String widgetId, Icon icon) Constructor.
GImage(String widgetId, String iconFileName) Constructor.

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.
Icon	getIcon() Gets the displayed icon.
JLabel	getJLabel() Return the JLabel associated with the widget.
void	setIcon(Icon icon) Sets the icon to be displayed.
void	setIcon(String iconFileName) Sets the icon to be displayed.

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

GImage

public GImage(String iconFileName)

Constructor. The widget identifier is assigned automatically.

Parameters:

iconFileName - filename of the image to be displayed.

GImage

public GImage(Icon icon)

Constructor. The widget identifier is assigned automatically.

Parameters:

icon - to be displayed.

GImage

public GImage(String widgetId,
              Icon icon)

Constructor.

Parameters:

widgetId - identifier of the widget.

icon - to be displayed.

GImage

public GImage(String widgetId,
              String iconFileName)

Constructor.

Parameters:

widgetId - identifier of the widget.

iconFileName - filename of the image to be displayed.

Method Detail

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

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.

getJLabel

public JLabel getJLabel()

Return the JLabel associated with the widget.

Returns:

the JLabel associated with the widget.

setIcon

public void setIcon(Icon icon)

Sets the icon to be displayed.

Parameters:

icon - the new icon to be set.

setIcon

public void setIcon(String iconFileName)

Sets the icon to be displayed.

Parameters:

iconFileName - filename of the new image to be displayed.

getIcon

public Icon getIcon()

Gets the displayed icon.

Returns:

the displayed icon.