public abstract class ContentSetProvider
extends java.lang.Object
Project
with a ContentSet
.Constructor and Description |
---|
ContentSetProvider(java.lang.String key, java.lang.String shortLabel) |
Modifier and Type | Method and Description |
---|---|
boolean |
alwaysShowEmptyFolders()
Controls when the ContentSetProvider shows its empty folders.
|
boolean |
applicationLevelContent()
Returns
true if the ContentSetProvider represents content associated with the application workspace rather than with projects within the workspace. |
boolean |
canContainJavaSources()
Returns
true if the ContentSetProvider may point to Java sources. |
boolean |
canExtendURLPath(Project project)
Returns
true if the ContentSetProvider allows a URL to be added to the ContentSet's URLPath in the given Project context. |
boolean |
displayFoldersAsPackages()
Returns
true if the ContentSetProvider wants its folders to be rendered in the UI as if they are Java packages. |
ContentSetHelper |
getContentSetHelper()
Returns a
ContentSetHelper , which is used to validate content before it is added to the content set, and to handle adding new content to the content set. |
java.lang.String |
getKey()
Returns the HashStructure key that points to a sub-HashStructure instance within the Project.
|
abstract Navigable |
getNavigable()
Implement this method to return a Navigable that represents the UI for this provider's ContentSet in the Project Properties dialog.
|
java.lang.String |
getShortLabel()
Returns a user-displayable (and thus translatable) string representing this ContentSetProvider.
|
void |
initContentSet(ContentSet contentSet, java.net.URL projectDir, Context context)
Deprecated.
No replacement. This method was designed to allow content set providers to setup the default paths for their content; that data is now defined declaratively.
|
boolean |
isFlatLevelEnabled()
Returns
true if the flat level feature of the navigator should be abled for this ContentSetProvider. |
java.lang.String |
toString()
Override of toString to provide a label to display for the
ContentSetProvider when used in the UI. |
public ContentSetProvider(java.lang.String key, java.lang.String shortLabel)
key
- The key of the content set within the project file.shortLabel
- The short label used to identify the content set to the user. This is a translatable string.public final java.lang.String getKey()
ContentSet
.public final java.lang.String getShortLabel()
public boolean applicationLevelContent()
true
if the ContentSetProvider represents content associated with the application workspace rather than with projects within the workspace.public boolean displayFoldersAsPackages()
true
if the ContentSetProvider wants its folders to be rendered in the UI as if they are Java packages. This method only affects how folders are displayed in the UI and does not affect the Java root directories of a project in the same way that canContainJavaSources()
does.public boolean alwaysShowEmptyFolders()
true
if empty folders must always be shown, false
otherwisepublic boolean canContainJavaSources()
true
if the ContentSetProvider may point to Java sources. Returns false
otherwise. The default return value is false
. When the provider returns true
, this affects how the Java root directories for a Project
are determined by the ProjectContent.getJavaRootDirs()
method. Typically, when a provider returns true
from this method, it will also return true
from displayFoldersAsPackages()
.public boolean canExtendURLPath(Project project)
true
if the ContentSetProvider allows a URL to be added to the ContentSet's URLPath in the given Project context. Returns false
otherwise.public ContentSetHelper getContentSetHelper()
ContentSetHelper
, which is used to validate content before it is added to the content set, and to handle adding new content to the content set.ContentSetHelper
.public boolean isFlatLevelEnabled()
true
if the flat level feature of the navigator should be abled for this ContentSetProvider. The default return value is the same as canContainJavaSources()
, so that the flat level support is automatically enabled if the ContentSetProvider represents Java sources.@Deprecated public void initContentSet(ContentSet contentSet, java.net.URL projectDir, Context context)
public abstract Navigable getNavigable()
public java.lang.String toString()
ContentSetProvider
when used in the UI.toString
in class java.lang.Object