Package com.intellij.ide.bookmarks

Class Bookmark

java.lang.Object

com.intellij.ide.bookmarks.Bookmark

All Implemented Interfaces:

Navigatable, java.lang.Comparable<Bookmark>

public final class Bookmark
extends java.lang.Object
implements Navigatable, java.lang.Comparable<Bookmark>

Constructor Summary

Constructors

Constructor and Description
Bookmark(java.lang.String url, int line, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
boolean	canNavigate() Indicates whether this instance supports navigation of any kind.
boolean	canNavigateToSource() Indicates whether this instance supports navigation to source (that means some kind of editor).
int	compareTo(Bookmark o)
RangeHighlighter	createHighlighter(MarkupModelEx markup)
static java.awt.Font	getBookmarkFont()
java.lang.String	getDescription()
Document	getDocument() Deprecated.
VirtualFile	getFile()
javax.swing.Icon	getIcon()
int	getLine()
char	getMnemonic()
java.lang.String	getQualifiedName()
boolean	isValid()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
void	release()
void	setDescription(java.lang.String description)
void	setMnemonic(char mnemonic)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Bookmark

public Bookmark(java.lang.String url,
                int line,
                java.lang.String description)

Method Detail

getBookmarkFont

public static java.awt.Font getBookmarkFont()

compareTo

public int compareTo(Bookmark o)

Specified by:

compareTo in interface java.lang.Comparable<Bookmark>

createHighlighter

public RangeHighlighter createHighlighter(MarkupModelEx markup)

getDocument

@Deprecated
public Document getDocument()

Deprecated.

release

public void release()

getIcon

public javax.swing.Icon getIcon()

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getMnemonic

public char getMnemonic()

setMnemonic

public void setMnemonic(char mnemonic)

getFile

public VirtualFile getFile()

isValid

public boolean isValid()

canNavigate

public boolean canNavigate()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation of any kind. Usually this method is called to ensure that navigation is possible. Note that it is not called if navigation to source is supported, i.e. Navigatable.canNavigateToSource() returns true. We assume that this method should return true in such case, so implement this method respectively.

Specified by:

canNavigate in interface Navigatable

Returns:

false if navigation is not possible for any reason.

canNavigateToSource

public boolean canNavigateToSource()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation to source (that means some kind of editor). Note that navigation can be supported even if this method returns false. In such cases it is not recommended to do batch navigation for all navigatables available via CommonDataKeys.NAVIGATABLE_ARRAY, because it may lead to opening several modal dialogs. Use OpenSourceUtil.navigate(com.intellij.pom.Navigatable...) to process such arrays correctly.

Specified by:

canNavigateToSource in interface Navigatable

Returns:

false if navigation to source is not possible for any reason.

navigate

public void navigate(boolean requestFocus)

Description copied from interface: Navigatable

Open editor and select/navigate to the object there if possible. Just do nothing if navigation is not possible like in case of a package

Specified by:

navigate in interface Navigatable

Parameters:

requestFocus - true if focus requesting is necessary

getLine

public int getLine()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getQualifiedName

public java.lang.String getQualifiedName()