oracle.ide.model

Class ContentSetProvider

java.lang.Object

oracle.ide.model.ContentSetProvider

Direct Known Subclasses:

JavaContentSetProvider, ResourcesContentSetProvider

public abstract class ContentSetProvider
extends java.lang.Object

Callback class used to configure a Project with a ContentSet.

Constructor Summary

Constructors

Constructor and Description
ContentSetProvider(java.lang.String key, java.lang.String shortLabel)

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentSetProvider

public ContentSetProvider(java.lang.String key,
                          java.lang.String shortLabel)

Parameters:

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.

Method Detail

getKey

public final java.lang.String getKey()

Returns the HashStructure key that points to a sub-HashStructure instance within the Project. The sub-HashStructure is then wrapped by ContentSet.

getShortLabel

public final java.lang.String getShortLabel()

Returns a user-displayable (and thus translatable) string representing this ContentSetProvider.

applicationLevelContent

public boolean applicationLevelContent()

Returns true if the ContentSetProvider represents content associated with the application workspace rather than with projects within the workspace.

displayFoldersAsPackages

public boolean displayFoldersAsPackages()

Returns 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.

alwaysShowEmptyFolders

public boolean alwaysShowEmptyFolders()

Controls when the ContentSetProvider shows its empty folders. Non-empty folders are always shown, but empty folders may be shown or hidden depending on the user's preference. This option overrides the user selection and ensure that empty folders are always shown.

Returns:

true if empty folders must always be shown, false otherwise

canContainJavaSources

public boolean canContainJavaSources()

Returns 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().

canExtendURLPath

public 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. Returns false otherwise.

getContentSetHelper

public 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.

Returns:

a ContentSetHelper.

isFlatLevelEnabled

public boolean isFlatLevelEnabled()

Returns 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.

initContentSet

@Deprecated
public 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.

getNavigable

public abstract Navigable getNavigable()

Implement this method to return a Navigable that represents the UI for this provider's ContentSet in the Project Properties dialog.

toString

public java.lang.String toString()

Override of toString to provide a label to display for the ContentSetProvider when used in the UI.

Overrides:

toString in class java.lang.Object

Returns:

user-friendly string for the ContentSetProvider