Package com.intellij.framework.library

Class DownloadableLibraryType

java.lang.Object

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

com.intellij.openapi.roots.libraries.LibraryType<LibraryVersionProperties>

com.intellij.framework.library.DownloadableLibraryType

Direct Known Subclasses:

DownloadableLibraryTypeBase

public abstract class DownloadableLibraryType
extends LibraryType<LibraryVersionProperties>

Field Summary

Fields inherited from class com.intellij.openapi.roots.libraries.LibraryType

DEFAULT_EXTERNAL_ROOT_TYPES, EP_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
	DownloadableLibraryType(java.lang.String libraryCategoryName, java.lang.String libraryTypeId, java.lang.String groupId, javax.swing.Icon icon, java.net.URL... localUrls) Deprecated. use DownloadableLibraryType(String, String, String, URL...) instead and override getLibraryTypeIcon()
protected	DownloadableLibraryType(java.lang.String libraryCategoryName, java.lang.String libraryTypeId, java.lang.String groupId, java.net.URL... localUrls) Creates instance of library type.

Method Summary

Modifier and Type	Method and Description
NewLibraryConfiguration	createNewLibrary(javax.swing.JComponent parentComponent, VirtualFile contextDirectory, Project project) Called when a new library of this type is created in Project Structure dialog
LibraryPropertiesEditor	createPropertiesEditor(LibraryEditorComponent<LibraryVersionProperties> editorComponent)
LibraryVersionProperties	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	getCreateActionName()
java.lang.String	getDescription(LibraryVersionProperties properties)
protected abstract java.lang.String []	getDetectionClassNames()
javax.swing.Icon	getIcon(LibraryVersionProperties properties)
java.lang.String	getLibraryCategoryName()
DownloadableLibraryDescription	getLibraryDescription()
javax.swing.Icon	getLibraryTypeIcon()

Methods inherited from class com.intellij.openapi.roots.libraries.LibraryType

createLibraryRootsComponentDescriptor, findByKind, getExternalRootTypes, getKind, isSuitableModule

Methods inherited from class com.intellij.openapi.roots.libraries.LibraryPresentationProvider

getIcon

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadableLibraryType

protected DownloadableLibraryType(java.lang.String libraryCategoryName,
                                  java.lang.String libraryTypeId,
                                  java.lang.String groupId,
                                  java.net.URL... localUrls)

Creates instance of library type. You also must override getLibraryTypeIcon() method and return non-null value from it.

Parameters:

libraryCategoryName - presentable description of the library type

libraryTypeId - unique id of the library type, used for serialization

groupId - name of directory on https://frameworks.jetbrains.com site which contains information about available library versions

localUrls - URLs of xml files containing information about the library versions (see /contrib/osmorc/src/org/osmorc/facet/osgi.core.xml for example)

DownloadableLibraryType

@Deprecated
public DownloadableLibraryType(java.lang.String libraryCategoryName,
                               java.lang.String libraryTypeId,
                               java.lang.String groupId,
                               javax.swing.Icon icon,
                               java.net.URL... localUrls)

Deprecated. use DownloadableLibraryType(String, String, String, URL...) instead and override getLibraryTypeIcon()

Method Detail

getCreateActionName

public java.lang.String getCreateActionName()

Specified by:

getCreateActionName in class LibraryType<LibraryVersionProperties>

Returns:

text to show in 'New Library' popup. Return null if the type should not be shown in the 'New Library' popup

createNewLibrary

public NewLibraryConfiguration createNewLibrary(javax.swing.JComponent parentComponent,
                                                VirtualFile contextDirectory,
                                                Project project)

Description copied from class: LibraryType

Called when a new library of this type is created in Project Structure dialog

Specified by:

createNewLibrary in class LibraryType<LibraryVersionProperties>

getLibraryDescription

public DownloadableLibraryDescription getLibraryDescription()

getLibraryCategoryName

public java.lang.String getLibraryCategoryName()

getDescription

public java.lang.String getDescription(LibraryVersionProperties properties)

Overrides:

getDescription in class LibraryPresentationProvider<LibraryVersionProperties>

Returns:

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

createPropertiesEditor

public LibraryPropertiesEditor createPropertiesEditor(LibraryEditorComponent<LibraryVersionProperties> editorComponent)

Specified by:

createPropertiesEditor in class LibraryType<LibraryVersionProperties>

getLibraryTypeIcon

public javax.swing.Icon getLibraryTypeIcon()

getIcon

public javax.swing.Icon getIcon(LibraryVersionProperties properties)

Overrides:

getIcon in class LibraryPresentationProvider<LibraryVersionProperties>

getDetectionClassNames

protected abstract java.lang.String [] getDetectionClassNames()

detect

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

Description copied from class: LibraryPresentationProvider

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

Overrides:

detect in class LibraryType<LibraryVersionProperties>