Package com.intellij.openapi.roots.libraries

Class LibraryPresentationProvider<P extends LibraryProperties>

java.lang.Object

com.intellij.openapi.roots.libraries.LibraryPresentationProvider<P>

Direct Known Subclasses:

GroovyLibraryPresentationProviderBase, LibraryType

public abstract class LibraryPresentationProvider<P extends LibraryProperties>
extends java.lang.Object

Implement this extension point to provide a custom icon and description for specific libraries in Project Structure dialog. Belonging to a specific kind is determined automatically by classes roots of a library using detect(List) method, if you need to specify it explicitly use LibraryType extension point instead.
The implementation should be registered in plugin.xml:

 <extensions defaultExtensionNs="com.intellij">
   <library.presentationProvider implementation="qualified-class-name"/>
 </extensions>
 

See Also:

LibraryType

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<LibraryPresentationProvider>	EP_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LibraryPresentationProvider(LibraryKind kind)

Method Summary

Modifier and Type	Method and Description
abstract P	detect(java.util.List<VirtualFile> classesRoots) Returns non-null value if a library with classes roots classesRoots is of a kind described by this provider.
java.lang.String	getDescription(P properties)
javax.swing.Icon	getIcon() Deprecated. override getIcon(LibraryProperties) instead
javax.swing.Icon	getIcon(P properties)
LibraryKind	getKind()

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<LibraryPresentationProvider> EP_NAME

Constructor Detail

LibraryPresentationProvider

protected LibraryPresentationProvider(LibraryKind kind)

Method Detail

getKind

public LibraryKind getKind()

getIcon

@Deprecated
public javax.swing.Icon getIcon()

Deprecated. override getIcon(LibraryProperties) instead

getIcon

public javax.swing.Icon getIcon(P properties)

getDescription

public java.lang.String getDescription(P properties)

Returns:

description of a library to be shown in 'Library Editor' in 'Project Structure' dialog

detect

public abstract P detect(java.util.List<VirtualFile> classesRoots)

Returns non-null value if a library with classes roots classesRoots is of a kind described by this provider.