Package com.intellij.ide.favoritesTreeView

Class FavoritesManager

java.lang.Object

com.intellij.ide.favoritesTreeView.FavoritesManager

All Implemented Interfaces:

PersistentStateComponent<Element>

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

Constructor Summary

Constructors

Constructor and Description
FavoritesManager(Project project)

Method Summary

Modifier and Type	Method and Description
void	addFavoritesListener(FavoritesListener listener, Disposable parent)
boolean	addRoots(java.lang.String name, java.util.Collection<? extends AbstractTreeNode<?>> nodes)
boolean	addRoots(java.lang.String name, Module moduleContext, java.lang.Object elements)
boolean	canAddRoots(java.lang.String name, java.util.Collection<? extends AbstractTreeNode<?>> nodes)
boolean	canReorder(java.lang.String nameToOrder, java.lang.String anchorName, boolean above)
boolean	contains(java.lang.String name, VirtualFile vFile)
void	createNewList(java.lang.String listName)
static AbstractUrl	createUrlByElement(java.lang.Object element, Project project)
void	fireListeners(java.lang.String listName)
java.util.List<java.lang.String>	getAvailableFavoritesListNames()
java.util.Comparator<FavoriteTreeNodeDescriptor>	getCustomComparator(java.lang.String name)
java.lang.String	getFavoriteListName(java.lang.String currentSubId, VirtualFile vFile)
java.util.List<TreeItem<Pair<AbstractUrl,java.lang.String>>>	getFavoritesListRootUrls(java.lang.String name)
static FavoritesManager	getInstance(Project project)
FavoritesListProvider	getListProvider(java.lang.String name)
Element	getState()
FavoritesViewSettings	getViewSettings()
protected java.util.Collection<VirtualFile>	getVirtualFiles(java.lang.String listName, boolean recursively)
void	loadState(Element element) This method is called when new component state is loaded.
void	removeFavoritesList(java.lang.String name)
boolean	removeRoot(java.lang.String name, java.util.List<? extends AbstractTreeNode<?>> elements)
void	renameList(Project project, java.lang.String listName)
void	setOrder(java.lang.String nameToOrder, java.lang.String anchorName, boolean above)

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

FavoritesManager

public FavoritesManager(Project project)

Method Detail

getInstance

public static FavoritesManager getInstance(Project project)

renameList

public void renameList(Project project,
                       java.lang.String listName)

addFavoritesListener

public void addFavoritesListener(FavoritesListener listener,
                                 Disposable parent)

getAvailableFavoritesListNames

public java.util.List<java.lang.String> getAvailableFavoritesListNames()

createNewList

public void createNewList(java.lang.String listName)

fireListeners

public void fireListeners(java.lang.String listName)

getViewSettings

public FavoritesViewSettings getViewSettings()

removeFavoritesList

public void removeFavoritesList(java.lang.String name)

getFavoritesListRootUrls

public java.util.List<TreeItem<Pair<AbstractUrl,java.lang.String>>> getFavoritesListRootUrls(java.lang.String name)

addRoots

public boolean addRoots(java.lang.String name,
                        Module moduleContext,
                        java.lang.Object elements)

getCustomComparator

public java.util.Comparator<FavoriteTreeNodeDescriptor> getCustomComparator(java.lang.String name)

addRoots

public boolean addRoots(java.lang.String name,
                        java.util.Collection<? extends AbstractTreeNode<?>> nodes)

canAddRoots

public boolean canAddRoots(java.lang.String name,
                           java.util.Collection<? extends AbstractTreeNode<?>> nodes)

removeRoot

public boolean removeRoot(java.lang.String name,
                          java.util.List<? extends AbstractTreeNode<?>> elements)

setOrder

public void setOrder(java.lang.String nameToOrder,
                     java.lang.String anchorName,
                     boolean above)

canReorder

public boolean canReorder(java.lang.String nameToOrder,
                          java.lang.String anchorName,
                          boolean above)

getListProvider

public FavoritesListProvider getListProvider(java.lang.String name)

loadState

public void loadState(Element element)

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:

element - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

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

createUrlByElement

public static AbstractUrl createUrlByElement(java.lang.Object element,
                                             Project project)

getFavoriteListName

public java.lang.String getFavoriteListName(java.lang.String currentSubId,
                                            VirtualFile vFile)

contains

public boolean contains(java.lang.String name,
                        VirtualFile vFile)

getVirtualFiles

protected java.util.Collection<VirtualFile> getVirtualFiles(java.lang.String listName,
                                                            boolean recursively)