Class TagCloudViewer
- java.lang.Object
-
- org.eclipse.jface.viewers.Viewer
-
- org.eclipse.jface.viewers.ContentViewer
-
- org.eclipse.gef.cloudio.internal.ui.TagCloudViewer
-
- All Implemented Interfaces:
IInputProvider,IInputSelectionProvider,ISelectionProvider
public class TagCloudViewer extends ContentViewer
A model-based adapter for aTagCloud.
-
-
Field Summary
-
Fields inherited from class org.eclipse.jface.viewers.Viewer
WIDGET_DATA_KEY
-
-
Constructor Summary
Constructors Constructor Description TagCloudViewer(TagCloud cloud)Create a new TagCloudViewer for the givenTagCloud, which must not benull.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TagCloudgetCloud()Returns theTagCloudmanaged by this viewer.ControlgetControl()ILayoutergetLayouter()intgetMaxWords()Returns the maximum number of elements which will be displayed by the cloud.ISelectiongetSelection()Returns the currently selected elements, as anIStructuredSelection.protected voidinitListeners()Initialize the default tag cloud listeners.protected voidinitMouseWheelListener()Initialize the mouse wheel listener to support zooming in and out.protected voidinitSelectionListener()Initialize default selection behaviour: Words can be selected by mouse click, and selection listeners are notified when the selection changed.protected voidinitToolTipSupport()Initialize tool tip support when the cursor hovers a word.protected voidinputChanged(java.lang.Object input, java.lang.Object oldInput)voidrefresh()voidreset(IProgressMonitor monitor, boolean recalc)Resets theTagCloud.voidsetBoost(int boost)voidsetBoostFactor(float boostFactor)voidsetContentProvider(IContentProvider contentProvider)Sets the content provider of this viewer, which must be anIStructuredContentProvider.voidsetInput(java.lang.Object input, IProgressMonitor progressMonitor)Same asContentViewer.setInput(Object), but with anIProgressMonitorto provide feedback during the layout phase.voidsetLabelProvider(IBaseLabelProvider labelProvider)Sets the label provider of this viewer, which must be anICloudLabelProvider.voidsetLayouter(ILayouter layouter)voidsetMaxWords(int words)Sets the maximum number of elements which will be displayed by the cloud.voidsetSelection(ISelection selection, boolean reveal)voidzoomFit()CallsTagCloud.zoomFit()to scale the cloud such that it fits the current visible area.voidzoomIn()Zooms invoidzoomOut()Zooms outvoidzoomReset()Resets the zoom to 100%-
Methods inherited from class org.eclipse.jface.viewers.ContentViewer
getContentProvider, getInput, getLabelProvider, handleDispose, handleLabelProviderChanged, hookControl, labelProviderChanged, setInput
-
Methods inherited from class org.eclipse.jface.viewers.Viewer
addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, scrollDown, scrollUp, setData, setSelection
-
-
-
-
Method Detail
-
initListeners
protected void initListeners()
Initialize the default tag cloud listeners. Can be overridden to modify the behaviour of the viewer.
-
initToolTipSupport
protected void initToolTipSupport()
Initialize tool tip support when the cursor hovers a word.
-
initMouseWheelListener
protected void initMouseWheelListener()
Initialize the mouse wheel listener to support zooming in and out.
-
initSelectionListener
protected void initSelectionListener()
Initialize default selection behaviour: Words can be selected by mouse click, and selection listeners are notified when the selection changed.
-
getControl
public Control getControl()
- Specified by:
getControlin classViewer
-
getSelection
public ISelection getSelection()
Returns the currently selected elements, as anIStructuredSelection. Returns an empty selection if no elements are selected.- Specified by:
getSelectionin interfaceISelectionProvider- Specified by:
getSelectionin classViewer
-
setSelection
public void setSelection(ISelection selection, boolean reveal)
- Specified by:
setSelectionin classViewer
-
reset
public void reset(IProgressMonitor monitor, boolean recalc)
Resets theTagCloud. Ifrecalcistrue, the displayed elements will be updated with the values provided by the usedICloudLabelProvider. Otherwise, the cloud will only be re-layouted, keeping fonts, colors and angles untouched.- Parameters:
monitor-recalc-
-
getCloud
public TagCloud getCloud()
Returns theTagCloudmanaged by this viewer.- Returns:
- the
TagCloudof this viewer
-
setLabelProvider
public void setLabelProvider(IBaseLabelProvider labelProvider)
Sets the label provider of this viewer, which must be anICloudLabelProvider.- Overrides:
setLabelProviderin classContentViewer
-
setContentProvider
public void setContentProvider(IContentProvider contentProvider)
Sets the content provider of this viewer, which must be anIStructuredContentProvider.- Overrides:
setContentProviderin classContentViewer
-
inputChanged
protected void inputChanged(java.lang.Object input, java.lang.Object oldInput)- Overrides:
inputChangedin classViewer
-
setMaxWords
public void setMaxWords(int words)
Sets the maximum number of elements which will be displayed by the cloud. Note that there is no guarantee that this amount of elements will actually be displayed, as this depends on additional factors.
-
zoomFit
public void zoomFit()
CallsTagCloud.zoomFit()to scale the cloud such that it fits the current visible area.
-
zoomIn
public void zoomIn()
Zooms in
-
zoomOut
public void zoomOut()
Zooms out
-
zoomReset
public void zoomReset()
Resets the zoom to 100%
-
setBoost
public void setBoost(int boost)
-
getMaxWords
public int getMaxWords()
Returns the maximum number of elements which will be displayed by the cloud. Note that there is no guarantee that this amount of elements will actually be displayed, as this depends on additional factors.- Returns:
- the maximum number of words that can be placed
-
setInput
public void setInput(java.lang.Object input, IProgressMonitor progressMonitor)Same asContentViewer.setInput(Object), but with anIProgressMonitorto provide feedback during the layout phase.- Parameters:
input-progressMonitor-
-
setBoostFactor
public void setBoostFactor(float boostFactor)
-
setLayouter
public void setLayouter(ILayouter layouter)
-
getLayouter
public ILayouter getLayouter()
-
-