Package org.eclipse.draw2d
Class ImageFigure
java.lang.Object
org.eclipse.draw2d.Figure
org.eclipse.draw2d.AbstractImageFigure
org.eclipse.draw2d.ImageFigure
- All Implemented Interfaces:
IFigure
,IImageFigure
A Figure that simply contains an Image. Use this Figure, instead of a Label,
when displaying Images without any accompanying text. This figure is not
intended to have a layout mananger or children.
Note that it is the client's responsibility to dispose the given image. There is no "free" resource management in draw2d.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.eclipse.draw2d.Figure
Figure.FigureIterator, Figure.IdentitySearch, Figure.ReverseFigureChildrenIterator
Nested classes/interfaces inherited from interface org.eclipse.draw2d.IFigure
IFigure.NoInsets
Nested classes/interfaces inherited from interface org.eclipse.draw2d.IImageFigure
IImageFigure.ImageChangedListener
-
Field Summary
Fields inherited from class org.eclipse.draw2d.Figure
bgColor, border, bounds, fgColor, flags, font, MAX_FLAG, maxSize, minSize, NO_MANAGER, prefSize, toolTip
Fields inherited from interface org.eclipse.draw2d.IFigure
MAX_DIMENSION, MIN_DIMENSION, NO_INSETS
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor
The default alignment isPositionConstants.CENTER
.ImageFigure
(Image image) Constructor
The default alignment isPositionConstants.CENTER
.ImageFigure
(Image image, int alignment) Constructor -
Method Summary
Modifier and TypeMethodDescriptiongetImage()
Returns the SWT Image contained by the figuregetPreferredSize
(int wHint, int hHint) Calculates the necessary size to display the Image within the figure's client area.protected void
paintFigure
(Graphics graphics) Paints this Figure's primary representation, or background.void
setAlignment
(int flag) Sets the alignment of the Image within this Figure.void
Sets the Image that this ImageFigure displays.Methods inherited from class org.eclipse.draw2d.AbstractImageFigure
addImageChangedListener, notifyImageChanged, removeImageChangedListener
Methods inherited from class org.eclipse.draw2d.Figure
add, add, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findDescendantAtExcluding, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, findMouseEventTargetInDescendantsAt, fireCoordinateSystemChanged, fireFigureMoved, fireMoved, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundColor, getBorder, getBounds, getChildren, getChildrenRevIterable, getClientArea, getClientArea, getClippingStrategy, getCursor, getFlag, getFont, getForegroundColor, getInsets, getLayoutManager, getListeners, getListenersIterable, getLocalBackgroundColor, getLocalFont, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isCoordinateSystem, isEnabled, isFocusTraversable, isMirrored, isMouseEventTarget, isOpaque, isRequestFocusEnabled, isShowing, isValid, isValidationRoot, isVisible, layout, optimizeClip, paint, paintBorder, paintChildren, paintClientArea, primTranslate, remove, removeAll, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setChildrenDirection, setChildrenEnabled, setChildrenOrientation, setClippingStrategy, setConstraint, setCursor, setEnabled, setFlag, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setValid, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, useLocalCoordinates, validate
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.draw2d.IFigure
add, add, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, getBackgroundColor, getBorder, getBounds, getChildren, getClientArea, getClientArea, getClippingStrategy, getCursor, getFont, getForegroundColor, getInsets, getLayoutManager, getLocalBackgroundColor, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isCoordinateSystem, isEnabled, isFocusTraversable, isMirrored, isOpaque, isRequestFocusEnabled, isShowing, isVisible, paint, remove, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setClippingStrategy, setConstraint, setCursor, setEnabled, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, validate
-
Constructor Details
-
ImageFigure
public ImageFigure()Constructor
The default alignment isPositionConstants.CENTER
. -
ImageFigure
Constructor
The default alignment isPositionConstants.CENTER
.- Parameters:
image
- The Image to be displayed
-
ImageFigure
Constructor- Parameters:
image
- The Image to be displayedalignment
- A PositionConstant indicating the alignment- See Also:
-
-
Method Details
-
getImage
Description copied from interface:IImageFigure
Returns the SWT Image contained by the figure- Returns:
- The Image that this Figure displays
-
getPreferredSize
Calculates the necessary size to display the Image within the figure's client area.- Specified by:
getPreferredSize
in interfaceIFigure
- Overrides:
getPreferredSize
in classFigure
- Parameters:
wHint
- a width hinthHint
- a height hint- Returns:
- The preferred size
- See Also:
-
paintFigure
Description copied from class:Figure
Paints this Figure's primary representation, or background. Changes made to the graphics to the graphics current state will not affect the subsequent calls toFigure.paintClientArea(Graphics)
andFigure.paintBorder(Graphics)
. Furthermore, it is safe to callgraphics.restoreState()
within this method, and doing so will restore the graphics to its original state upon entry.- Overrides:
paintFigure
in classFigure
- Parameters:
graphics
- The Graphics used to paint- See Also:
-
setAlignment
public void setAlignment(int flag) Sets the alignment of the Image within this Figure. The alignment comes into play when the ImageFigure is larger than the Image. The alignment could be any valid combination of the following:- PositionConstants.NORTH
- PositionConstants.SOUTH
- PositionConstants.EAST
- PositionConstants.WEST
- PositionConstants.CENTER or PositionConstants.NONE
- Parameters:
flag
- A constant indicating the alignment
-
setImage
Sets the Image that this ImageFigure displays.IMPORTANT: Note that it is the client's responsibility to dispose the given image.
- Parameters:
image
- The Image to be displayed. It can benull
.
-