Eclipse Platform
Release 3.4

org.eclipse.jface.text.hyperlink
Class MultipleHyperlinkPresenter

java.lang.Object
  extended byorg.eclipse.jface.text.hyperlink.DefaultHyperlinkPresenter
      extended byorg.eclipse.jface.text.hyperlink.MultipleHyperlinkPresenter
All Implemented Interfaces:
EventListener, IDocumentListener, IHyperlinkPresenter, IHyperlinkPresenterExtension, IPropertyChangeListener, ITextInputListener, ITextPresentationListener

public class MultipleHyperlinkPresenter
extends DefaultHyperlinkPresenter

A hyperlink presenter capable of showing multiple hyperlinks in a hover.

Since:
3.4

Field Summary
 
Fields inherited from class org.eclipse.jface.text.hyperlink.DefaultHyperlinkPresenter
HYPERLINK_COLOR
 
Constructor Summary
MultipleHyperlinkPresenter(IPreferenceStore store)
          Creates a new multiple hyperlink presenter which uses DefaultHyperlinkPresenter.HYPERLINK_COLOR to read the color from the given preference store.
MultipleHyperlinkPresenter(RGB color)
          Creates a new multiple hyperlink presenter.
 
Method Summary
 boolean canHideHyperlinks()
          Tells whether the currently shown hyperlinks can be hidden.
 boolean canShowMultipleHyperlinks()
          Tells whether this presenter is able to handle more than one hyperlink.
 void hideHyperlinks()
          Tells this hyperlink presenter to hide the hyperlinks requested to be shown by showHyperlinks(IHyperlink[]).
 void install(ITextViewer viewer)
          Installs this hyperlink presenter on the given text viewer.
 void showHyperlinks(IHyperlink[] hyperlinks)
          Tells this hyperlink presenter to show the given hyperlinks on the installed text viewer.
 void uninstall()
          Uninstalls this hyperlink presenter.
 
Methods inherited from class org.eclipse.jface.text.hyperlink.DefaultHyperlinkPresenter
applyTextPresentation, documentAboutToBeChanged, documentChanged, inputDocumentAboutToBeChanged, inputDocumentChanged, propertyChange, setColor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultipleHyperlinkPresenter

public MultipleHyperlinkPresenter(IPreferenceStore store)
Creates a new multiple hyperlink presenter which uses DefaultHyperlinkPresenter.HYPERLINK_COLOR to read the color from the given preference store.

Parameters:
store - the preference store

MultipleHyperlinkPresenter

public MultipleHyperlinkPresenter(RGB color)
Creates a new multiple hyperlink presenter.

Parameters:
color - the hyperlink color, to be disposed by the caller
Method Detail

install

public void install(ITextViewer viewer)
Description copied from interface: IHyperlinkPresenter
Installs this hyperlink presenter on the given text viewer.

Specified by:
install in interface IHyperlinkPresenter
Overrides:
install in class DefaultHyperlinkPresenter

uninstall

public void uninstall()
Description copied from interface: IHyperlinkPresenter
Uninstalls this hyperlink presenter.

Specified by:
uninstall in interface IHyperlinkPresenter
Overrides:
uninstall in class DefaultHyperlinkPresenter

canShowMultipleHyperlinks

public boolean canShowMultipleHyperlinks()
Description copied from interface: IHyperlinkPresenter
Tells whether this presenter is able to handle more than one hyperlink.

Specified by:
canShowMultipleHyperlinks in interface IHyperlinkPresenter
Overrides:
canShowMultipleHyperlinks in class DefaultHyperlinkPresenter

canHideHyperlinks

public boolean canHideHyperlinks()
Description copied from class: DefaultHyperlinkPresenter
Tells whether the currently shown hyperlinks can be hidden.

Specified by:
canHideHyperlinks in interface IHyperlinkPresenterExtension
Overrides:
canHideHyperlinks in class DefaultHyperlinkPresenter

hideHyperlinks

public void hideHyperlinks()
Description copied from interface: IHyperlinkPresenter
Tells this hyperlink presenter to hide the hyperlinks requested to be shown by IHyperlinkPresenter.showHyperlinks(IHyperlink[]).

Specified by:
hideHyperlinks in interface IHyperlinkPresenter
Overrides:
hideHyperlinks in class DefaultHyperlinkPresenter

showHyperlinks

public void showHyperlinks(IHyperlink[] hyperlinks)
Description copied from interface: IHyperlinkPresenter
Tells this hyperlink presenter to show the given hyperlinks on the installed text viewer.

Specified by:
showHyperlinks in interface IHyperlinkPresenter
Overrides:
showHyperlinks in class DefaultHyperlinkPresenter

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.