Package com.intellij.ide.bookmarks

Class BookmarkManager

java.lang.Object

com.intellij.ide.bookmarks.BookmarkManager

All Implemented Interfaces:

PersistentStateComponent<Element>

public final class BookmarkManager
extends java.lang.Object
implements PersistentStateComponent<Element>

Constructor Summary

Constructors

Constructor and Description
BookmarkManager(Project project)

Method Summary

Modifier and Type	Method and Description
void	addEditorBookmark(Editor editor, int lineIndex)
void	addFileBookmark(VirtualFile file, java.lang.String description)
Bookmark	addTextBookmark(VirtualFile file, int lineIndex, java.lang.String description)
void	applyNewStateInTestMode(java.util.List<Bookmark> newList)
void	editDescription(Bookmark bookmark, javax.swing.JComponent popup)
Bookmark	findBookmarkForMnemonic(char m)
Bookmark	findEditorBookmark(Document document, int line)
Bookmark	findFileBookmark(VirtualFile file)
Bookmark	findLineBookmark(Editor editor, boolean isWrapped, boolean next)
static BookmarkManager	getInstance(Project project)
Element	getState()
java.util.List<Bookmark>	getValidBookmarks()
boolean	hasBookmarksWithMnemonics()
void	loadState(Element state) This method is called when new component state is loaded.
void	moveBookmarkDown(Bookmark bookmark) Try to move bookmark one position down in the list
void	moveBookmarkUp(Bookmark bookmark) Try to move bookmark one position up in the list
void	removeBookmark(Bookmark bookmark)
void	setDescription(Bookmark bookmark, java.lang.String description)
void	setMnemonic(Bookmark bookmark, char c)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Constructor Detail

BookmarkManager

public BookmarkManager(Project project)

Method Detail

getInstance

public static BookmarkManager getInstance(Project project)

editDescription

public void editDescription(Bookmark bookmark,
                            javax.swing.JComponent popup)

addEditorBookmark

public void addEditorBookmark(Editor editor,
                              int lineIndex)

addTextBookmark

public Bookmark addTextBookmark(VirtualFile file,
                                int lineIndex,
                                java.lang.String description)

addFileBookmark

public void addFileBookmark(VirtualFile file,
                            java.lang.String description)

getValidBookmarks

public java.util.List<Bookmark> getValidBookmarks()

findEditorBookmark

public Bookmark findEditorBookmark(Document document,
                                   int line)

findFileBookmark

public Bookmark findFileBookmark(VirtualFile file)

findBookmarkForMnemonic

public Bookmark findBookmarkForMnemonic(char m)

hasBookmarksWithMnemonics

public boolean hasBookmarksWithMnemonics()

removeBookmark

public void removeBookmark(Bookmark bookmark)

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

loadState

public void loadState(Element state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<Element>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

applyNewStateInTestMode

public void applyNewStateInTestMode(java.util.List<Bookmark> newList)

moveBookmarkUp

public void moveBookmarkUp(Bookmark bookmark)

Try to move bookmark one position up in the list

moveBookmarkDown

public void moveBookmarkDown(Bookmark bookmark)

Try to move bookmark one position down in the list

findLineBookmark

public Bookmark findLineBookmark(Editor editor,
                                 boolean isWrapped,
                                 boolean next)

setMnemonic

public void setMnemonic(Bookmark bookmark,
                        char c)

setDescription

public void setDescription(Bookmark bookmark,
                           java.lang.String description)