oracle.ide.model

Class ContentSetProviderReference

java.lang.Object

oracle.ide.model.ContentSetProviderReference

public class ContentSetProviderReference
extends java.lang.Object

Wrapper for a ContentSetProvider. This wrapper is necessary to have a uniform list of content set providers that have been registered programmatically and content set providers that have been registered declaratively through the context-set-providers-hook hook.

Constructor Summary

Constructors

Constructor and Description
ContentSetProviderReference(ContentSetProvider provider) Deprecated.
ContentSetProviderReference(java.lang.String label, java.lang.String navigableLabel, java.lang.String key, boolean isDefaultContentSet, boolean showInDefaultProject, boolean applicationLevelContent, boolean displayFoldersAsPackages, boolean canContainJavaSources, boolean flatLevelEnabled, boolean alwaysShowEmptyFolders, MetaClass<ContentSetProvider> type, java.lang.String defaultSourceFolder, PatternFilters patternFilters) Creates a new ContentSetProviderReference.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	alwaysShowEmptyFolders() Controls when the content set provider shows its empty folders.
boolean	applicationLevelContent() Indicates whether the content set provider represents content associated with the application workspace rather than with projects within the workspace.
boolean	canContainJavaSources() Indicates whether the content set provider may point to Java sources.
ContentSetProvider	contentSetProvider() Returns the instance of the referenced content set provider.
boolean	displayFoldersAsPackages() Indicates whether the content set provider wants its folders to be rendered in the UI as if they are Java packages.
java.lang.String	extensionId()
void	extensionId(java.lang.String extensionId)
boolean	hasNavigable() Indicates whether this content set provider has a Navigable.
void	initContentSet(ContentSet contentSet, java.net.URL projectDir, Context context)
boolean	isAlreadyInitialized()
boolean	isDefaultContentSet() Indicates whether the Navigable for this content set is shown in the Project Properties dialog when "Project Source Paths" is selected, or whether it is added as a child of that root node.
boolean	isFlatLevelEnabled() Indicates whether the flat level feature of the navigator should be enabled for this content set provider.
boolean	isShowInDefaultProject() Indicates whether the Navigable for this content set is shown in the Project Properties dialog when Default Project Properties is selected from the menu.
java.lang.String	key() Returns the key of the content set provider.
java.lang.String	label() Returns the label of this content set provider.
java.lang.String	navigableLabel() Returns the navigableLabel of the Navigable of the content set provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentSetProviderReference

public ContentSetProviderReference(ContentSetProvider provider)

Deprecated.

Creates a new ContentSetProviderReference.

Parameters:

provider - the ContentSetProvider that has been registered programmatically.

See Also:

ProjectContent.registerContentSetProvider(ContentSetProvider)

ContentSetProviderReference

public ContentSetProviderReference(java.lang.String label,
                           java.lang.String navigableLabel,
                           java.lang.String key,
                           boolean isDefaultContentSet,
                           boolean showInDefaultProject,
                           boolean applicationLevelContent,
                           boolean displayFoldersAsPackages,
                           boolean canContainJavaSources,
                           boolean flatLevelEnabled,
                           boolean alwaysShowEmptyFolders,
                           MetaClass<ContentSetProvider> type,
                           java.lang.String defaultSourceFolder,
                           PatternFilters patternFilters)

Creates a new ContentSetProviderReference. This constructor is called to create a "meta"-reference to a content set provider registered declaratively through the content-set-provider-hook.

Parameters:

label - the label of the content set provider.

navigableLabel - the label of the navigable of the content set provider.

key - the key of the content set provider.

isDefaultContentSet - indicates whether the content set is the default to be shown as the root level node in Project Properties

applicationLevelContent - indicates whether the content set provider represents content associated with the application workspace rather than project level content.

displayFoldersAsPackages - indicates whether the content set provider wants its folders to be rendered in the UI as if they are Java packages.

canContainJavaSources - indicates whether the content set provider may point to Java sources.

flatLevelEnabled - indicates whether the flat level feature of the navigator should be enabled for this content set provider.

type - the MetaClass used to lazily instantiate the content set provider.

Method Detail

label

public java.lang.String label()

Returns the label of this content set provider.

Returns:

the label of this content set provider.

navigableLabel

public java.lang.String navigableLabel()

Returns the navigableLabel of the Navigable of the content set provider. It may return null or an empty string if the content set provider does not provide a Navigable.

Returns:

the navigableLabel of the Navigable of the content set provider, or null or an empty string if the content set provider does not provide a Navigable.

hasNavigable

public boolean hasNavigable()

Indicates whether this content set provider has a Navigable.

Returns:

true if this content set provider has a Navigable; false otherwise.

key

public java.lang.String key()

Returns the key of the content set provider.

Returns:

the key of the content set provider.

applicationLevelContent

public boolean applicationLevelContent()

Indicates whether the content set provider represents content associated with the application workspace rather than with projects within the workspace.

Returns:

true if the content set provider represents application workspace level content; false means the content set provider represents project content.

isDefaultContentSet

public boolean isDefaultContentSet()

Indicates whether the Navigable for this content set is shown in the Project Properties dialog when "Project Source Paths" is selected, or whether it is added as a child of that root node. There can only be one default content set, so an error will print on the console if the default is reset.

Note that this will only return true if hasNavigable() also returns true.

Returns:

true if the provider's content should be shown at the root, false otherwise.

isShowInDefaultProject

public boolean isShowInDefaultProject()

Indicates whether the Navigable for this content set is shown in the Project Properties dialog when Default Project Properties is selected from the menu. true.

Returns:

true if the provider's content should be shown in the default project properties, false otherwise.

displayFoldersAsPackages

public boolean displayFoldersAsPackages()

Indicates whether the content set provider wants its folders to be rendered in the UI as if they are Java packages.

Returns:

true if the content set provider wants its folders to be rendered in the UI as if they are Java packages; false otherwise.

alwaysShowEmptyFolders

public boolean alwaysShowEmptyFolders()

Controls when the content set provider 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

contentSetProvider

public ContentSetProvider contentSetProvider()

Returns the instance of the referenced content set provider. If the content set provider was registered declaratively, this method will use the MetaClass especified in the content-set-providers-hook hook to create a content set provider lazily.

Returns:

the instance of the referenced content set provider.

isAlreadyInitialized

public boolean isAlreadyInitialized()

canContainJavaSources

public boolean canContainJavaSources()

Indicates whether the content set provider may point to Java sources.

Returns:

true if the content set provider may point to Java sources; false otherwise.

isFlatLevelEnabled

public boolean isFlatLevelEnabled()

Indicates whether the flat level feature of the navigator should be enabled for this content set provider.

Returns:

true if the flat level feature of the navigator should be enabled for this content set provider; false otherwise.

extensionId

public void extensionId(java.lang.String extensionId)

extensionId

public java.lang.String extensionId()

initContentSet

public void initContentSet(ContentSet contentSet,
                  java.net.URL projectDir,
                  Context context)