Package org.eclipse.draw2d.parts
Class Thumbnail
java.lang.Object
org.eclipse.draw2d.Figure
org.eclipse.draw2d.parts.Thumbnail
- All Implemented Interfaces:
IFigure
,UpdateListener
- Direct Known Subclasses:
ScrollableThumbnail
A Thumbnail is a Figure that displays an image of its source Figure at a
smaller size. The Thumbnail will maintain the aspect ratio of the source
Figure.
-
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.UpdateListener
UpdateListener.Stub
-
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Deactivates this Thumbnail.getPreferredSize
(int wHint, int hHint) Returns the preferred size of this Thumbnail.protected float
Returns the scale factor on the X-axis.protected float
Returns the scale factor on the Y-axis.protected IFigure
Returns the source figure being used to generate a thumbnail.protected Rectangle
Returns the rectangular region relative to the source figure which will be the basis of the thumbnail.protected Dimension
Returns the target size of the thumbnail.protected Image
Returns the scaled Image of the source Figure.protected boolean
isDirty()
Returnstrue
if the source figure has changed.void
notifyPainting
(Rectangle damage, Map<IFigure, Rectangle> dirtyRegions) Notifies the listener that the listened to object is painting.void
Notifies the listener that the listened to object is validating.protected void
paintFigure
(Graphics graphics) Paints this Figure's primary representation, or background.void
setDirty
(boolean value) Sets the dirty flag.protected void
setScales
(float x, float y) Sets the X and Y scales for the Thumbnail.void
Sets the source Figure.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
-
Constructor Details
-
Thumbnail
public Thumbnail()Creates a new Thumbnail. The source Figure must be set separately if you use this constructor. -
Thumbnail
Creates a new Thumbnail with the given IFigure as its source figure.- Parameters:
fig
- The source figure
-
-
Method Details
-
deactivate
public void deactivate()Deactivates this Thumbnail. -
getPreferredSize
Returns the preferred size of this Thumbnail. The preferred size will be calculated in a way that maintains the source Figure's aspect ratio.- Specified by:
getPreferredSize
in interfaceIFigure
- Overrides:
getPreferredSize
in classFigure
- Parameters:
wHint
- The width hinthHint
- The height hint- Returns:
- The preferred size
- See Also:
-
getScaleX
protected float getScaleX()Returns the scale factor on the X-axis.- Returns:
- X scale
-
getScaleY
protected float getScaleY()Returns the scale factor on the Y-axis.- Returns:
- Y scale
-
getSource
Returns the source figure being used to generate a thumbnail.- Returns:
- the source figure
-
getSourceRectangle
Returns the rectangular region relative to the source figure which will be the basis of the thumbnail. The value may be returned by reference and should not be modified by the caller.- Returns:
- the region of the source figure being used for the thumbnail
- Since:
- 3.1
-
getThumbnailImage
Returns the scaled Image of the source Figure. If the Image needs to be updated, the ThumbnailUpdater will notified.- Returns:
- The thumbnail image
-
isDirty
protected boolean isDirty()Returnstrue
if the source figure has changed.- Returns:
true
if the source figure has changed
-
notifyPainting
Description copied from interface:UpdateListener
Notifies the listener that the listened to object is painting. The damage rectangle may be null or empty. This indicates the dirty regions were clipped or not visible. But for objects such as theThumbnail
, notification still needs to occur. The map of dirty regions is passed to allow the listener to determine if it needs to update, for instance when a particular figure is painting.- Specified by:
notifyPainting
in interfaceUpdateListener
- Parameters:
damage
- The area being painteddirtyRegions
- a Map of figures to their dirty regions- See Also:
-
notifyValidating
public void notifyValidating()Description copied from interface:UpdateListener
Notifies the listener that the listened to object is validating.- Specified by:
notifyValidating
in interfaceUpdateListener
- 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:
-
setDirty
public void setDirty(boolean value) Sets the dirty flag.- Parameters:
value
- The dirty value
-
setScales
protected void setScales(float x, float y) Sets the X and Y scales for the Thumbnail. These scales represent the ratio between the source figure and the Thumbnail.- Parameters:
x
- The X scaley
- The Y scale
-
setSource
Sets the source Figure. Also sets the scales and creates the necessary update manager.- Parameters:
fig
- The source figure
-
getTargetSize
Returns the target size of the thumbnail.- Returns:
- the target size
- Since:
- 3.14
-