Package com.intellij.ide.projectView.impl

Class AbstractProjectViewPane

java.lang.Object

com.intellij.ide.projectView.impl.AbstractProjectViewPane

All Implemented Interfaces:

DataProvider, Disposable

Direct Known Subclasses:

AbstractProjectViewPSIPane, ScopeViewPane

public abstract class AbstractProjectViewPane
extends java.lang.Object
implements DataProvider, Disposable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<AbstractProjectViewPane>	EP_NAME
protected Project	myProject
protected DnDAwareTree	myTree
protected AbstractTreeStructure	myTreeStructure

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProjectViewPane(Project project)

Method Summary

Modifier and Type	Method and Description
void	addToolbarActions(DefaultActionGroup actionGroup)
protected void	beforeDnDLeave()
protected void	beforeDnDUpdate()
protected java.util.Comparator<NodeDescriptor<?>>	createComparator()
abstract javax.swing.JComponent	createComponent()
protected ToggleAction	createFlattenModulesAction(java.util.function.BooleanSupplier isApplicable) Deprecated. added in ProjectViewImpl automatically
abstract SelectInTarget	createSelectInTarget()
static TreeVisitor	createVisitor(java.lang.Object object)
static TreeVisitor	createVisitor(PsiElement element)
static TreeVisitor	createVisitor(PsiElement element, VirtualFile file)
static TreeVisitor	createVisitor(VirtualFile file)
void	dispose() Usually not invoked directly, see class javadoc.
protected void	enableDnD()
protected java.lang.Object	exhumeElementFromNode(javax.swing.tree.DefaultMutableTreeNode node) Deprecated. use getValueFromNode(Object)
void	expand(java.lang.Object [] path, boolean requestFocus)
static java.lang.Object	extractValueFromNode(java.lang.Object node)
protected void	fireTreeChangeListener() Deprecated. unused
javax.swing.JComponent	getComponentToFocus()
java.lang.Object	getData(java.lang.String dataId) Returns the object corresponding to the specified data identifier.
java.util.List<PsiElement>	getElementsFromNode(java.lang.Object node)
abstract javax.swing.Icon	getIcon()
abstract java.lang.String	getId()
protected java.lang.String	getManualOrderOptionText()
protected Module	getNodeModule(java.lang.Object element)
javax.swing.Icon	getPresentableSubIdIcon(java.lang.String subId)
java.lang.String	getPresentableSubIdName(java.lang.String subId)
PsiElement	getPSIElementFromNode(javax.swing.tree.TreeNode node) Deprecated. use getElementsFromNode(Object)
ActionCallback	getReady(java.lang.Object requestor)
NodeDescriptor	getSelectedDescriptor()
PsiDirectory []	getSelectedDirectories()
protected PsiDirectory []	getSelectedDirectoriesInAmbiguousCase(java.lang.Object userObject)
java.lang.Object	getSelectedElement()
java.lang.Object []	getSelectedElements()
javax.swing.tree.DefaultMutableTreeNode	getSelectedNode() Deprecated. AbstractProjectViewPane#getSelectedPath
protected <T extends NodeDescriptor<?>> java.util.List<T>	getSelectedNodes(java.lang.Class<T> nodeClass)
javax.swing.tree.TreePath	getSelectedPath()
PsiElement []	getSelectedPSIElements()
javax.swing.tree.TreePath[]	getSelectionPaths()
java.lang.String	getSubId()
java.lang.String []	getSubIds()
abstract java.lang.String	getTitle()
static PsiElement []	getTransferedPsiElements(java.awt.datatransfer.Transferable transferable)
static javax.swing.tree.TreeNode []	getTransferedTreeNodes(java.awt.datatransfer.Transferable transferable)
javax.swing.JTree	getTree()
AbstractTreeBuilder	getTreeBuilder()
AbstractTreeStructure	getTreeStructure()
java.lang.Object	getValueFromNode(java.lang.Object node)
abstract int	getWeight()
void	installComparator()
protected void	installComparator(AbstractTreeBuilder builder, java.util.Comparator<? super NodeDescriptor<?>> comparator)
void	installComparator(java.util.Comparator<? super NodeDescriptor<?>> comparator)
boolean	isAutoScrollEnabledFor(VirtualFile file)
boolean	isDefaultPane(Project project)
boolean	isInitiallyVisible()
boolean	isVisibleAndSelected(java.lang.Object element)
protected void	onSubIdChange()
Promise<javax.swing.tree.TreePath>	promisePathToElement(java.lang.Object element) Deprecated. temporary API
void	readExternal(Element element)
void	restoreExpandedPaths()
protected void	saveExpandedPaths()
abstract void	select(java.lang.Object element, VirtualFile file, boolean requestFocus)
void	selectModule(Module module, boolean requestFocus)
void	selectModuleGroup(ModuleGroup moduleGroup, boolean requestFocus)
void	setSubId(java.lang.String subId)
void	setTreeBuilder(AbstractTreeBuilder treeBuilder)
boolean	supportsAbbreviatePackageNames()
boolean	supportsCompactDirectories()
boolean	supportsFlattenModules()
boolean	supportsFoldersAlwaysOnTop()
boolean	supportsHideEmptyMiddlePackages()
boolean	supportsManualOrder()
boolean	supportsShowExcludedFiles()
boolean	supportsShowLibraryContents()
boolean	supportsShowModules()
boolean	supportsSortByType()
void	updateFrom(java.lang.Object element, boolean forceResort, boolean updateStructure)
abstract ActionCallback	updateFromRoot(boolean restoreExpandedPaths)
void	writeExternal(Element element)

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<AbstractProjectViewPane> EP_NAME

myProject

protected final Project myProject

myTree

protected DnDAwareTree myTree

myTreeStructure

protected AbstractTreeStructure myTreeStructure

Constructor Detail

AbstractProjectViewPane

protected AbstractProjectViewPane(Project project)

Method Detail

fireTreeChangeListener

@Deprecated
protected final void fireTreeChangeListener()

Deprecated. unused

getTitle

public abstract java.lang.String getTitle()

getIcon

public abstract javax.swing.Icon getIcon()

getId

public abstract java.lang.String getId()

isDefaultPane

public boolean isDefaultPane(Project project)

getSubId

public final java.lang.String getSubId()

setSubId

public final void setSubId(java.lang.String subId)

onSubIdChange

protected void onSubIdChange()

isInitiallyVisible

public boolean isInitiallyVisible()

supportsManualOrder

public boolean supportsManualOrder()

getManualOrderOptionText

protected java.lang.String getManualOrderOptionText()

getSubIds

public java.lang.String [] getSubIds()

Returns:

all supported sub views IDs. should return empty array if there is no subViews as in Project/Packages view.

getPresentableSubIdName

public java.lang.String getPresentableSubIdName(java.lang.String subId)

getPresentableSubIdIcon

public javax.swing.Icon getPresentableSubIdIcon(java.lang.String subId)

createComponent

public abstract javax.swing.JComponent createComponent()

getComponentToFocus

public javax.swing.JComponent getComponentToFocus()

expand

public void expand(java.lang.Object [] path,
                   boolean requestFocus)

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

updateFromRoot

public abstract ActionCallback updateFromRoot(boolean restoreExpandedPaths)

updateFrom

public void updateFrom(java.lang.Object element,
                       boolean forceResort,
                       boolean updateStructure)

select

public abstract void select(java.lang.Object element,
                            VirtualFile file,
                            boolean requestFocus)

selectModule

public void selectModule(Module module,
                         boolean requestFocus)

selectModuleGroup

public void selectModuleGroup(ModuleGroup moduleGroup,
                              boolean requestFocus)

getSelectionPaths

public javax.swing.tree.TreePath[] getSelectionPaths()

addToolbarActions

public void addToolbarActions(DefaultActionGroup actionGroup)

createFlattenModulesAction

@Deprecated
protected ToggleAction createFlattenModulesAction(java.util.function.BooleanSupplier isApplicable)

Deprecated. added in ProjectViewImpl automatically

getSelectedNodes

protected <T extends NodeDescriptor<?>> java.util.List<T> getSelectedNodes(java.lang.Class<T> nodeClass)

isAutoScrollEnabledFor

public boolean isAutoScrollEnabledFor(VirtualFile file)

getData

public java.lang.Object getData(java.lang.String dataId)

Description copied from interface: DataProvider

Returns the object corresponding to the specified data identifier. Some of the supported data identifiers are defined in the PlatformDataKeys class.

Specified by:

getData in interface DataProvider

Parameters:

dataId - the data identifier for which the value is requested.

Returns:

the value, or null if no value is available in the current context for this identifier.

getWeight

public abstract int getWeight()

createSelectInTarget

public abstract SelectInTarget createSelectInTarget()

getSelectedPath

public final javax.swing.tree.TreePath getSelectedPath()

getSelectedDescriptor

public final NodeDescriptor getSelectedDescriptor()

getSelectedNode

@Deprecated
public final javax.swing.tree.DefaultMutableTreeNode getSelectedNode()

Deprecated. AbstractProjectViewPane#getSelectedPath

See Also:

TreeUtil.getUserObject(Object)

getSelectedElement

public final java.lang.Object getSelectedElement()

getSelectedPSIElements

public final PsiElement [] getSelectedPSIElements()

getElementsFromNode

public java.util.List<PsiElement> getElementsFromNode(java.lang.Object node)

getPSIElementFromNode

@Deprecated
public PsiElement getPSIElementFromNode(javax.swing.tree.TreeNode node)

Deprecated. use getElementsFromNode(Object)

getNodeModule

protected Module getNodeModule(java.lang.Object element)

getSelectedElements

public final java.lang.Object [] getSelectedElements()

getValueFromNode

public java.lang.Object getValueFromNode(java.lang.Object node)

exhumeElementFromNode

@Deprecated
protected java.lang.Object exhumeElementFromNode(javax.swing.tree.DefaultMutableTreeNode node)

Deprecated. use getValueFromNode(Object)

extractValueFromNode

public static java.lang.Object extractValueFromNode(java.lang.Object node)

getTreeBuilder

public AbstractTreeBuilder getTreeBuilder()

getTreeStructure

public AbstractTreeStructure getTreeStructure()

readExternal

public void readExternal(Element element)

writeExternal

public void writeExternal(Element element)

saveExpandedPaths

protected void saveExpandedPaths()

restoreExpandedPaths

public final void restoreExpandedPaths()

createComparator

protected java.util.Comparator<NodeDescriptor<?>> createComparator()

installComparator

public void installComparator()

installComparator

public void installComparator(java.util.Comparator<? super NodeDescriptor<?>> comparator)

installComparator

protected void installComparator(AbstractTreeBuilder builder,
                                 java.util.Comparator<? super NodeDescriptor<?>> comparator)

getTree

public javax.swing.JTree getTree()

getSelectedDirectories

public PsiDirectory [] getSelectedDirectories()

getSelectedDirectoriesInAmbiguousCase

protected PsiDirectory [] getSelectedDirectoriesInAmbiguousCase(java.lang.Object userObject)

getTransferedPsiElements

public static PsiElement [] getTransferedPsiElements(java.awt.datatransfer.Transferable transferable)

getTransferedTreeNodes

public static javax.swing.tree.TreeNode [] getTransferedTreeNodes(java.awt.datatransfer.Transferable transferable)

enableDnD

protected void enableDnD()

beforeDnDUpdate

protected void beforeDnDUpdate()

beforeDnDLeave

protected void beforeDnDLeave()

setTreeBuilder

public void setTreeBuilder(AbstractTreeBuilder treeBuilder)

supportsAbbreviatePackageNames

public boolean supportsAbbreviatePackageNames()

supportsCompactDirectories

public boolean supportsCompactDirectories()

supportsFlattenModules

public boolean supportsFlattenModules()

supportsFoldersAlwaysOnTop

public boolean supportsFoldersAlwaysOnTop()

supportsHideEmptyMiddlePackages

public boolean supportsHideEmptyMiddlePackages()

supportsShowExcludedFiles

public boolean supportsShowExcludedFiles()

supportsShowLibraryContents

public boolean supportsShowLibraryContents()

supportsShowModules

public boolean supportsShowModules()

supportsSortByType

public boolean supportsSortByType()

getReady

public ActionCallback getReady(java.lang.Object requestor)

promisePathToElement

@Deprecated
public Promise<javax.swing.tree.TreePath> promisePathToElement(java.lang.Object element)

Deprecated. temporary API

isVisibleAndSelected

public boolean isVisibleAndSelected(java.lang.Object element)

createVisitor

public static TreeVisitor createVisitor(java.lang.Object object)

createVisitor

public static TreeVisitor createVisitor(VirtualFile file)

createVisitor

public static TreeVisitor createVisitor(PsiElement element)

createVisitor

public static TreeVisitor createVisitor(PsiElement element,
                                        VirtualFile file)