Class TagCloudViewer

All Implemented Interfaces:
IInputProvider, IInputSelectionProvider, ISelectionProvider

public class TagCloudViewer extends ContentViewer
A model-based adapter for a TagCloud.
  • Constructor Details

    • TagCloudViewer

      public TagCloudViewer(TagCloud cloud)
      Create a new TagCloudViewer for the given TagCloud, which must not be null.
      Parameters:
      cloud -
  • Method Details

    • 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:
      getControl in class Viewer
    • getSelection

      public ISelection getSelection()
      Returns the currently selected elements, as an IStructuredSelection. Returns an empty selection if no elements are selected.
      Specified by:
      getSelection in interface ISelectionProvider
      Specified by:
      getSelection in class Viewer
    • refresh

      public void refresh()
      Specified by:
      refresh in class Viewer
    • setSelection

      public void setSelection(ISelection selection, boolean reveal)
      Specified by:
      setSelection in class Viewer
    • reset

      public void reset(IProgressMonitor monitor, boolean recalc)
      Resets the TagCloud. If recalc is true, the displayed elements will be updated with the values provided by the used ICloudLabelProvider. Otherwise, the cloud will only be re-layouted, keeping fonts, colors and angles untouched.
      Parameters:
      monitor -
      recalc -
    • getCloud

      public TagCloud getCloud()
      Returns the TagCloud managed by this viewer.
      Returns:
      the TagCloud of this viewer
    • setLabelProvider

      public void setLabelProvider(IBaseLabelProvider labelProvider)
      Sets the label provider of this viewer, which must be an ICloudLabelProvider.
      Overrides:
      setLabelProvider in class ContentViewer
    • setContentProvider

      public void setContentProvider(IContentProvider contentProvider)
      Sets the content provider of this viewer, which must be an IStructuredContentProvider.
      Overrides:
      setContentProvider in class ContentViewer
    • inputChanged

      protected void inputChanged(Object input, Object oldInput)
      Overrides:
      inputChanged in class Viewer
    • 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()
      Calls TagCloud.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(Object input, IProgressMonitor progressMonitor)
      Same as ContentViewer.setInput(Object), but with an IProgressMonitor to 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()