Package org.eclipse.jface.text.hyperlink
Class DefaultHyperlinkPresenter
- java.lang.Object
-
- org.eclipse.jface.text.hyperlink.DefaultHyperlinkPresenter
-
- All Implemented Interfaces:
EventListener,IHyperlinkPresenter,IHyperlinkPresenterExtension,IDocumentListener,ITextInputListener,ITextPresentationListener,IPropertyChangeListener
- Direct Known Subclasses:
MultipleHyperlinkPresenter
public class DefaultHyperlinkPresenter extends Object implements IHyperlinkPresenter, IHyperlinkPresenterExtension, ITextPresentationListener, ITextInputListener, IDocumentListener, IPropertyChangeListener
The default hyperlink presenter underlines the link and colors the line and the text with the given color.It can only be used together with the
HyperlinkManager.FIRSTor theHyperlinkManager.LONGEST_REGION_FIRSThyperlink strategy.- Since:
- 3.1
-
-
Field Summary
Fields Modifier and Type Field Description static StringHYPERLINK_COLORA named preference that holds the color used for hyperlinks.static StringHYPERLINK_COLOR_SYSTEM_DEFAULTA named preference that holds the preference whether to use the native link color.
-
Constructor Summary
Constructors Constructor Description DefaultHyperlinkPresenter(IPreferenceStore store)Creates a new default hyperlink presenter which usesHYPERLINK_COLORto read the color from the given preference store.DefaultHyperlinkPresenter(Color color)Creates a new default hyperlink presenter.DefaultHyperlinkPresenter(RGB color)Creates a new default hyperlink presenter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidapplyTextPresentation(TextPresentation textPresentation)This method is called when a text presentation is about to be applied to the text viewer.booleancanHideHyperlinks()Tells whether the currently shown hyperlinks can be hidden.booleancanShowMultipleHyperlinks()Tells whether this presenter is able to handle more than one hyperlink.voiddocumentAboutToBeChanged(DocumentEvent event)The manipulation described by the document event will be performed.voiddocumentChanged(DocumentEvent event)The manipulation described by the document event has been performed.voidhideHyperlinks()Tells this hyperlink presenter to hide the hyperlinks requested to be shown byIHyperlinkPresenter.showHyperlinks(IHyperlink[]).voidinputDocumentAboutToBeChanged(IDocument oldInput, IDocument newInput)Called before the input document is replaced.voidinputDocumentChanged(IDocument oldInput, IDocument newInput)Called after the input document has been replaced.voidinstall(ITextViewer textViewer)Installs this hyperlink presenter on the given text viewer.voidpropertyChange(PropertyChangeEvent event)Notification that a property has changed.voidsetColor(Color color)Sets the hyperlink foreground color.voidshowHyperlinks(IHyperlink[] hyperlinks)Tells this hyperlink presenter to show the given hyperlinks on the installed text viewer.voiduninstall()Uninstalls this hyperlink presenter.
-
-
-
Field Detail
-
HYPERLINK_COLOR
public static final String HYPERLINK_COLOR
A named preference that holds the color used for hyperlinks.Value is of type
String. A RGB color value encoded as a string using classPreferenceConverter.- See Also:
StringConverter,PreferenceConverter, Constant Field Values
-
HYPERLINK_COLOR_SYSTEM_DEFAULT
public static final String HYPERLINK_COLOR_SYSTEM_DEFAULT
A named preference that holds the preference whether to use the native link color.The preference value is of type
Boolean.- Since:
- 3.5
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DefaultHyperlinkPresenter
public DefaultHyperlinkPresenter(IPreferenceStore store)
Creates a new default hyperlink presenter which usesHYPERLINK_COLORto read the color from the given preference store.- Parameters:
store- the preference store
-
DefaultHyperlinkPresenter
public DefaultHyperlinkPresenter(Color color)
Creates a new default hyperlink presenter.- Parameters:
color- the hyperlink color ornullif the existing text color should be preserved; to be disposed by the caller
-
DefaultHyperlinkPresenter
public DefaultHyperlinkPresenter(RGB color)
Creates a new default hyperlink presenter.- Parameters:
color- the hyperlink color ornullif the existing text color should be preserved
-
-
Method Detail
-
canShowMultipleHyperlinks
public boolean canShowMultipleHyperlinks()
Description copied from interface:IHyperlinkPresenterTells whether this presenter is able to handle more than one hyperlink.- Specified by:
canShowMultipleHyperlinksin interfaceIHyperlinkPresenter- Returns:
trueif this presenter can handle more than one hyperlink
-
showHyperlinks
public void showHyperlinks(IHyperlink[] hyperlinks)
Description copied from interface:IHyperlinkPresenterTells this hyperlink presenter to show the given hyperlinks on the installed text viewer.- Specified by:
showHyperlinksin interfaceIHyperlinkPresenter- Parameters:
hyperlinks- the hyperlinks to show
-
canHideHyperlinks
public boolean canHideHyperlinks()
Tells whether the currently shown hyperlinks can be hidden.- Specified by:
canHideHyperlinksin interfaceIHyperlinkPresenterExtension- Returns:
trueif the hyperlink manager can hide the current hyperlinks- Since:
- 3.4
-
hideHyperlinks
public void hideHyperlinks()
Description copied from interface:IHyperlinkPresenterTells this hyperlink presenter to hide the hyperlinks requested to be shown byIHyperlinkPresenter.showHyperlinks(IHyperlink[]).- Specified by:
hideHyperlinksin interfaceIHyperlinkPresenter
-
install
public void install(ITextViewer textViewer)
Description copied from interface:IHyperlinkPresenterInstalls this hyperlink presenter on the given text viewer.- Specified by:
installin interfaceIHyperlinkPresenter- Parameters:
textViewer- the text viewer
-
uninstall
public void uninstall()
Description copied from interface:IHyperlinkPresenterUninstalls this hyperlink presenter.- Specified by:
uninstallin interfaceIHyperlinkPresenter
-
setColor
public void setColor(Color color)
Sets the hyperlink foreground color.- Parameters:
color- the hyperlink foreground color ornullif the existing text color should be preserved
-
applyTextPresentation
public void applyTextPresentation(TextPresentation textPresentation)
Description copied from interface:ITextPresentationListenerThis method is called when a text presentation is about to be applied to the text viewer. The receiver is allowed to change the text presentation during that call.- Specified by:
applyTextPresentationin interfaceITextPresentationListener- Parameters:
textPresentation- the current text presentation
-
documentAboutToBeChanged
public void documentAboutToBeChanged(DocumentEvent event)
Description copied from interface:IDocumentListenerThe manipulation described by the document event will be performed.- Specified by:
documentAboutToBeChangedin interfaceIDocumentListener- Parameters:
event- the document event describing the document change
-
documentChanged
public void documentChanged(DocumentEvent event)
Description copied from interface:IDocumentListenerThe manipulation described by the document event has been performed.- Specified by:
documentChangedin interfaceIDocumentListener- Parameters:
event- the document event describing the document change
-
inputDocumentAboutToBeChanged
public void inputDocumentAboutToBeChanged(IDocument oldInput, IDocument newInput)
Description copied from interface:ITextInputListenerCalled before the input document is replaced.- Specified by:
inputDocumentAboutToBeChangedin interfaceITextInputListener- Parameters:
oldInput- the text viewer's previous input documentnewInput- the text viewer's new input document
-
inputDocumentChanged
public void inputDocumentChanged(IDocument oldInput, IDocument newInput)
Description copied from interface:ITextInputListenerCalled after the input document has been replaced.- Specified by:
inputDocumentChangedin interfaceITextInputListener- Parameters:
oldInput- the text viewer's previous input documentnewInput- the text viewer's new input document
-
propertyChange
public void propertyChange(PropertyChangeEvent event)
Description copied from interface:IPropertyChangeListenerNotification that a property has changed.This method gets called when the observed object fires a property change event.
- Specified by:
propertyChangein interfaceIPropertyChangeListener- Parameters:
event- the property change event object describing which property changed and how
-
-