Class TagCloud
java.lang.Object
org.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
org.eclipse.swt.widgets.Canvas
org.eclipse.gef.cloudio.internal.ui.TagCloud
- All Implemented Interfaces:
Drawable
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addMouseListener
(MouseListener listener) void
addMouseMoveListener
(MouseMoveListener listener) void
addMouseTrackListener
(MouseTrackListener listener) void
addMouseWheelListener
(MouseWheelListener listener) void
addSelectionListener
(SelectionListener listener) protected void
calcExtents
(IProgressMonitor monitor) Calculates the bounds of each word, by determining theRectangle
a path would require to render an element.int
getBoost()
float
protected Rectangle
Returns the maximum cloud area.Returns theImageData
of the text layer image (all rendered elements, unscaled, without highlighted selection).int
int
Returns the set of selected elements.getWords()
double
getZoom()
int
layoutCloud
(IProgressMonitor monitor, boolean recalc) Does a full relayout of all displayed elements.protected int
layoutWords
(Collection<Word> wordsToUse, IProgressMonitor monitor) Generates the layout of the given words.void
void
removeMouseListener
(MouseListener listener) void
removeMouseMoveListener
(MouseMoveListener listener) void
removeMouseTrackListener
(MouseTrackListener listener) void
removeMouseWheelListener
(MouseWheelListener listener) void
removeSelectionListener
(SelectionListener listener) void
setAntiAlias
(boolean enabled) Enable or disable antialiasing.void
setBackground
(Color color) void
setBackgroundMask
(ImageData bgData) Set a background mask to define the drawable area of the cloud.void
setBoost
(int boost) Enable boosting for the firstboost
elements.void
setBoostFactor
(float boostFactor) void
setLayouter
(ILayouter layouter) void
setMaxFontSize
(int maxSize) Sets the maximum font size (which must be a value greater 0).void
setMinFontSize
(int size) Sets the minimum font size.void
setOpacity
(int opacity) Sets the opacity of the words, which must be a value between 0 and 255 (inclusive).void
setSelection
(Set<Word> words) Marks the set of elements as selected.void
setSelectionColor
(Color color) Sets the highlight color of the cloud.int
setWords
(List<Word> values, IProgressMonitor monitor) Sets the given list as input of the tag cloud, replacing any previous content.void
zoomFit()
Resets the zoom such that the generated cloud will fit exactly into the available space (unless the zoom factor is too small or too large).void
zoomIn()
Zooms in, by the factor of 10 percent.void
zoomOut()
Zooms out, by the factor of 10 percent.void
Resets the zoom to 100 % (original size)Methods inherited from class org.eclipse.swt.widgets.Canvas
drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME
Methods inherited from class org.eclipse.swt.widgets.Composite
changed, checkSubclass, computeSize, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, redraw, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList, toString
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar
Methods inherited from class org.eclipse.swt.widgets.Control
addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.swt.graphics.Drawable
isAutoScalable
-
Constructor Details
-
TagCloud
Creates a new Tag cloud on the given parent. When using this constructor, please read the following carefully:
Parameteraccuracy
defines the size of the raster used when placing strings, and must be a value greater than0
. An accuracy of1
will theoretically give best results, as the drawable area is analyzed most detailed, but this will also be very slow.
ParametermaxSize
defines the maximum size of the drawable area and must be a power ofaccuracy
, such thataccuracy^n=maxSize
holds.
To add scroll bars to the cloud, useSWT.HORIZONTAL
andSWT.VERTICAL
.- Parameters:
accuracy
-maxSize
-parent
-style
-
-
TagCloud
Creates a new Tag cloud on the given parent. To add scroll bars to the cloud, useSWT.HORIZONTAL
andSWT.VERTICAL
. This is a shortcut toTagCloud(Composite, int, int, int)
, which sets the accuracy to5
and the maximum size of the drawable area to5120
.- Parameters:
parent
-style
-
-
-
Method Details
-
zoomReset
public void zoomReset()Resets the zoom to 100 % (original size) -
getZoom
public double getZoom() -
zoomFit
public void zoomFit()Resets the zoom such that the generated cloud will fit exactly into the available space (unless the zoom factor is too small or too large). -
zoomIn
public void zoomIn()Zooms in, by the factor of 10 percent. -
zoomOut
public void zoomOut()Zooms out, by the factor of 10 percent. -
getCloudArea
Returns the maximum cloud area.- Returns:
- the maximum cloud area
-
calcExtents
Calculates the bounds of each word, by determining theRectangle
a path would require to render an element.- Parameters:
monitor
-
-
layoutWords
Generates the layout of the given words.- Parameters:
wordsToUse
-monitor
- may benull
.- Returns:
- the number of words which could be placed
-
setWords
Sets the given list as input of the tag cloud, replacing any previous content. By default, available word positions will be determined in-order, starting with the element at position 0.- Parameters:
values
-monitor
-
-
setBackgroundMask
Set a background mask to define the drawable area of the cloud. The image must be a square containing black and white pixels only. It is scaled to the full size of the drawable region. Black pixels are interpreted as used, such that strings will be drawn on white areas only. If parameterbgData
isnull
, the old mask will be removed.- Parameters:
bgData
- a square containing black and white pixels only
-
addMouseListener
- Overrides:
addMouseListener
in classControl
-
addMouseMoveListener
- Overrides:
addMouseMoveListener
in classControl
-
addMouseTrackListener
- Overrides:
addMouseTrackListener
in classControl
-
addMouseWheelListener
- Overrides:
addMouseWheelListener
in classControl
-
addSelectionListener
-
removeMouseListener
- Overrides:
removeMouseListener
in classControl
-
removeMouseMoveListener
- Overrides:
removeMouseMoveListener
in classControl
-
removeMouseTrackListener
- Overrides:
removeMouseTrackListener
in classControl
-
removeMouseWheelListener
- Overrides:
removeMouseWheelListener
in classControl
-
removeSelectionListener
-
setSelection
Marks the set of elements as selected.- Parameters:
words
- must not benull
.
-
redrawTextLayerImage
public void redrawTextLayerImage() -
getSelection
Returns the set of selected elements. Never returnsnull
.- Returns:
- the set of selected words
-
setSelectionColor
Sets the highlight color of the cloud. Default color is red.- Parameters:
color
-
-
setBackground
- Overrides:
setBackground
in classControl
-
layoutCloud
Does a full relayout of all displayed elements.- Parameters:
monitor
-- Returns:
- the number of words that could be placed
-
setMaxFontSize
public void setMaxFontSize(int maxSize) Sets the maximum font size (which must be a value greater 0). Note that strings which are too large to fit into the cloud region will be skipped. By default, this value is 500.- Parameters:
maxSize
-
-
setOpacity
public void setOpacity(int opacity) Sets the opacity of the words, which must be a value between 0 and 255 (inclusive). Currently not very useful...- Parameters:
opacity
-
-
setMinFontSize
public void setMinFontSize(int size) Sets the minimum font size. Should be a reasonable value > 0 (twice ofaccuracy
is recommended). By default, this value is 12.- Parameters:
size
-
-
getImageData
Returns theImageData
of the text layer image (all rendered elements, unscaled, without highlighted selection). Can be used to print or export the cloud.- Returns:
- the image data of the text layer image
-
setBoost
public void setBoost(int boost) Enable boosting for the firstboost
elements. By default, no elements are boosted.- Parameters:
boost
-
-
setAntiAlias
public void setAntiAlias(boolean enabled) Enable or disable antialiasing. Enabled by default.- Parameters:
enabled
-
-
setBoostFactor
public void setBoostFactor(float boostFactor) -
getSelectionColor
-
setLayouter
-
getMaxFontSize
public int getMaxFontSize() -
getMinFontSize
public int getMinFontSize() -
getBoost
public int getBoost() -
getBoostFactor
public float getBoostFactor() -
getWords
-
getLayouter
-