|
JavaScript Development Tools Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.wst.jsdt.ui.StandardJavaScriptElementContentProvider
public class StandardJavaScriptElementContentProvider
A base content provider for JavaScriptelements. It provides access to the JavaScriptelement hierarchy without listening to changes in the JavaScriptmodel. If updating the presentation on JavaScript model change is required than clients have to subclass, listen to JavaScript model changes and have to update the UI using corresponding methods provided by the JFace viewers or their own UI presentation.
The following JavaScript element hierarchy is surfaced by this content provider:
JavaScript model (IJavaScriptModel
) JavaScript project (IJavaScriptProject
) package fragment root (IPackageFragmentRoot
) package fragment (IPackageFragment
) compilation unit (IJavaScriptUnit
) binary class file (IClassFile
)
Note that when the entire JavaScript project is declared to be package fragment root, the corresponding package fragment root element that normally appears between the JavaScript project and the package fragments is automatically filtered out.
Field Summary | |
---|---|
protected boolean |
fProvideMembers
|
protected boolean |
fProvideWorkingCopy
|
protected static Object[] |
NO_CHILDREN
|
Constructor Summary | |
---|---|
StandardJavaScriptElementContentProvider()
Creates a new content provider. |
|
StandardJavaScriptElementContentProvider(boolean provideMembers)
Creates a new StandardJavaScriptElementContentProvider . |
Method Summary | |
---|---|
protected static Object[] |
concatenate(Object[] a1,
Object[] a2)
Note: This method is for internal use only. |
void |
dispose()
|
protected boolean |
exists(Object element)
Note: This method is for internal use only. |
protected IJavaScriptElement[] |
filter(IJavaScriptElement[] children)
|
Object[] |
getChildren(Object element)
|
Object[] |
getElements(Object parent)
|
protected Object[] |
getFolderContent(IFolder folder)
Evaluates all children of a given IFolder . |
protected Object[] |
getJavaProjects(IJavaScriptModel jm)
Note: This method is for internal use only. |
protected Object[] |
getPackageContent(IPackageFragment fragment)
Evaluates all children of a given IPackageFragment . |
protected Object[] |
getPackageFragmentRootContent(IPackageFragmentRoot root)
Evaluates all children of a given IPackageFragmentRoot . |
protected Object[] |
getPackageFragmentRoots(IJavaScriptProject project)
Evaluates all children of a given IJavaScriptProject . |
Object |
getParent(Object element)
|
boolean |
getProvideMembers()
Returns whether members are provided when asking for a compilation units or class file for its children. |
boolean |
getProvideWorkingCopy()
Deprecated. Since 3.0 compilation unit children are always provided as working copies. The JavaScript model does not support the 'original' mode anymore. |
boolean |
hasChildren(Object element)
|
void |
inputChanged(Viewer viewer,
Object oldInput,
Object newInput)
|
protected Object |
internalGetParent(Object element)
Note: This method is for internal use only. |
protected boolean |
isClassPathChange(IJavaScriptElementDelta delta)
Note: This method is for internal use only. |
protected boolean |
isPackageFragmentEmpty(IJavaScriptElement element)
Note: This method is for internal use only. |
protected boolean |
isProjectPackageFragmentRoot(IPackageFragmentRoot root)
Note: This method is for internal use only. |
protected boolean |
matches(IJavaScriptElement element)
|
boolean |
providesWorkingCopies()
Returns true if the content provider returns working
copy elements; otherwise false is returned. |
void |
setProvideMembers(boolean b)
Sets whether the content provider is supposed to return members when asking a compilation unit or class file for its children. |
protected Object |
skipProjectPackageFragmentRoot(IPackageFragmentRoot root)
Note: This method is for internal use only. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final Object[] NO_CHILDREN
protected boolean fProvideMembers
protected boolean fProvideWorkingCopy
Constructor Detail |
---|
public StandardJavaScriptElementContentProvider()
public StandardJavaScriptElementContentProvider(boolean provideMembers)
StandardJavaScriptElementContentProvider
.
provideMembers
- if true
members below compilation units
and class files are provided.Method Detail |
---|
public boolean getProvideMembers()
true
if the content provider provides members;
otherwise false
is returnedpublic void setProvideMembers(boolean b)
b
- if true
then members are provided.
If false
compilation units and class files are the
leaves provided by this content provider.public boolean getProvideWorkingCopy()
public boolean providesWorkingCopies()
IWorkingCopyProvider
true
if the content provider returns working
copy elements; otherwise false
is returned.
providesWorkingCopies
in interface IWorkingCopyProvider
public Object[] getElements(Object parent)
public void inputChanged(Viewer viewer, Object oldInput, Object newInput)
public void dispose()
public Object[] getChildren(Object element)
protected boolean matches(IJavaScriptElement element)
protected IJavaScriptElement[] filter(IJavaScriptElement[] children)
public boolean hasChildren(Object element)
public Object getParent(Object element)
protected Object[] getPackageFragmentRootContent(IPackageFragmentRoot root) throws JavaScriptModelException
IPackageFragmentRoot
. Clients can override this method.
root
- The root to evaluate the children for.
JavaScriptModelException
- if the package fragment root does not exist or if an
exception occurs while accessing its corresponding resourceprotected Object[] getPackageFragmentRoots(IJavaScriptProject project) throws JavaScriptModelException
IJavaScriptProject
. Clients can override this method.
project
- The JavaScript project to evaluate the children for.
JavaScriptModelException
- if the JavaScript project does not exist or if an
exception occurs while accessing its corresponding resourceprotected Object[] getJavaProjects(IJavaScriptModel jm) throws JavaScriptModelException
JavaScriptModelException
protected Object[] getPackageContent(IPackageFragment fragment) throws JavaScriptModelException
IPackageFragment
. Clients can override this method.
fragment
- The fragment to evaluate the children for.
JavaScriptModelException
- if the package fragment does not exist or if an
exception occurs while accessing its corresponding resourceprotected Object[] getFolderContent(IFolder folder) throws CoreException
IFolder
. Clients can override this method.
folder
- The folder to evaluate the children for.
CoreException
- if the folder does not exist.protected boolean isClassPathChange(IJavaScriptElementDelta delta)
protected Object skipProjectPackageFragmentRoot(IPackageFragmentRoot root)
protected boolean isPackageFragmentEmpty(IJavaScriptElement element) throws JavaScriptModelException
JavaScriptModelException
protected boolean isProjectPackageFragmentRoot(IPackageFragmentRoot root)
protected boolean exists(Object element)
protected Object internalGetParent(Object element)
protected static Object[] concatenate(Object[] a1, Object[] a2)
|
JavaScript Development Tools Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |