|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.text.hyperlink.DefaultHyperlinkPresenter
public class DefaultHyperlinkPresenter
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.FIRST
or the HyperlinkManager.LONGEST_REGION_FIRST hyperlink strategy.
| Field Summary | |
|---|---|
static String |
HYPERLINK_COLOR
A named preference that holds the color used for hyperlinks. |
static String |
HYPERLINK_COLOR_SYSTEM_DEFAULT
A named preference that holds the preference whether to use the native link color. |
| Constructor Summary | |
|---|---|
DefaultHyperlinkPresenter(Color color)
Creates a new default hyperlink presenter. |
|
DefaultHyperlinkPresenter(IPreferenceStore store)
Creates a new default hyperlink presenter which uses HYPERLINK_COLOR to read the color from the given preference store. |
|
DefaultHyperlinkPresenter(RGB color)
Creates a new default hyperlink presenter. |
|
| Method Summary | |
|---|---|
void |
applyTextPresentation(TextPresentation textPresentation)
This method is called when a text presentation is about to be applied to the text viewer. |
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 |
documentAboutToBeChanged(DocumentEvent event)
The manipulation described by the document event will be performed. |
void |
documentChanged(DocumentEvent event)
The manipulation described by the document event has been performed. |
void |
hideHyperlinks()
Tells this hyperlink presenter to hide the hyperlinks requested to be shown by IHyperlinkPresenter.showHyperlinks(IHyperlink[]). |
void |
inputDocumentAboutToBeChanged(IDocument oldInput,
IDocument newInput)
Called before the input document is replaced. |
void |
inputDocumentChanged(IDocument oldInput,
IDocument newInput)
Called after the input document has been replaced. |
void |
install(ITextViewer textViewer)
Installs this hyperlink presenter on the given text viewer. |
void |
propertyChange(PropertyChangeEvent event)
Notification that a property has changed. |
void |
setColor(Color color)
Sets the hyperlink foreground color. |
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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String HYPERLINK_COLOR
Value is of type String. A RGB color value encoded as a string using class
PreferenceConverter.
StringConverter,
PreferenceConverter,
Constant Field Valuespublic static final String HYPERLINK_COLOR_SYSTEM_DEFAULT
The preference value is of type Boolean.
| Constructor Detail |
|---|
public DefaultHyperlinkPresenter(IPreferenceStore store)
HYPERLINK_COLOR to read the color from the given preference store.
store - the preference storepublic DefaultHyperlinkPresenter(Color color)
color - the hyperlink color or null if the existing text color should be
preserved; to be disposed by the callerpublic DefaultHyperlinkPresenter(RGB color)
color - the hyperlink color or null if the existing text color should be
preserved| Method Detail |
|---|
public boolean canShowMultipleHyperlinks()
IHyperlinkPresenter
canShowMultipleHyperlinks in interface IHyperlinkPresentertrue if this presenter can handle more than one hyperlinkpublic void showHyperlinks(IHyperlink[] hyperlinks)
IHyperlinkPresenter
showHyperlinks in interface IHyperlinkPresenterhyperlinks - the hyperlinks to showpublic boolean canHideHyperlinks()
canHideHyperlinks in interface IHyperlinkPresenterExtensiontrue if the hyperlink manager can hide the current hyperlinkspublic void hideHyperlinks()
IHyperlinkPresenterIHyperlinkPresenter.showHyperlinks(IHyperlink[]).
hideHyperlinks in interface IHyperlinkPresenterpublic void install(ITextViewer textViewer)
IHyperlinkPresenter
install in interface IHyperlinkPresentertextViewer - the text viewerpublic void uninstall()
IHyperlinkPresenter
uninstall in interface IHyperlinkPresenterpublic void setColor(Color color)
color - the hyperlink foreground color or null if the existing text color
should be preservedpublic void applyTextPresentation(TextPresentation textPresentation)
ITextPresentationListener
applyTextPresentation in interface ITextPresentationListenertextPresentation - the current text presentationpublic void documentAboutToBeChanged(DocumentEvent event)
IDocumentListener
documentAboutToBeChanged in interface IDocumentListenerevent - the document event describing the document changepublic void documentChanged(DocumentEvent event)
IDocumentListener
documentChanged in interface IDocumentListenerevent - the document event describing the document change
public void inputDocumentAboutToBeChanged(IDocument oldInput,
IDocument newInput)
ITextInputListener
inputDocumentAboutToBeChanged in interface ITextInputListeneroldInput - the text viewer's previous input documentnewInput - the text viewer's new input document
public void inputDocumentChanged(IDocument oldInput,
IDocument newInput)
ITextInputListener
inputDocumentChanged in interface ITextInputListeneroldInput - the text viewer's previous input documentnewInput - the text viewer's new input documentpublic void propertyChange(PropertyChangeEvent event)
IPropertyChangeListenerThis method gets called when the observed object fires a property change event.
propertyChange in interface IPropertyChangeListenerevent - the property change event object describing which property
changed and how
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.