|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ide.model.ContentSetProvider
public abstract class ContentSetProvider
Callback class used to configure a Project
with a
ContentSet
.
Constructor Summary | |
---|---|
ContentSetProvider(java.lang.String key,
java.lang.String shortLabel)
|
Method Summary | |
---|---|
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[][] |
getNoAutoExpandFilters()
Return filters for files which when newly created will not be autoexpanded in th navigator. |
java.lang.String |
getShortLabel()
Returns a user-displayable (and thus translatable) string representing this ContentSetProvider. |
abstract void |
initContentSet(ContentSet contentSet,
java.net.URL projectDir,
Context context)
This method is called when a project is created or when a project is opened and is missing this provider's ContentSet. |
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 |
---|
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.Method Detail |
---|
public final java.lang.String getKey()
ContentSet
.
public final java.lang.String getShortLabel()
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 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.
public abstract void initContentSet(ContentSet contentSet, java.net.URL projectDir, Context context)
contentSet
- The newly created ContentSet which needs to be
initialized.projectDir
- The directory containing the project being
modified. This is provided as a convenience, since most
ContentSetProviders derive default paths based on the project
directory.context
- The context in which the project creation is
occurring. Calling context.getProject() will retrieve the
Project instance being initialized with the ContentSet.public abstract Navigable getNavigable()
public java.lang.String[][] getNoAutoExpandFilters()
no-autoexpand-filters
in content-set-providers-hook.
- Returns:
- Array of string arrays containing the include and exclude filters. Include filters
on the index 0, exclude filters at index 1.
null
in case no filters should
be applied, which is the default behavior.
public java.lang.String toString()
ContentSetProvider
when used in the UI.
toString
in class java.lang.Object
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |