com.adobe.flexbuilder.codemodel.project
Interface IRegistrar

public interface IRegistrar

Proxy for registering files and projects with the code model

Method Summary

boolean	isProjectRegistered(org.eclipse.core.resources.IProject eclipseProject) Determine whether or not this project has been registered with the code model.
void	registerExternalFile(org.eclipse.jface.text.IDocument doc, org.eclipse.core.runtime.IPath file, IProjectLoadListener progressListener) Register a file that's active within an editor.
void	registerFile(org.eclipse.jface.text.IDocument doc, org.eclipse.core.resources.IFile file, IProjectLoadListener progressListener) Register a file that's active within an editor.
void	registerProject(org.eclipse.core.resources.IProject eclipseProject, IProjectLoadListener progressListener) Register a project with the code model.
void	unregisterExternalFile(org.eclipse.jface.text.IDocument doc, org.eclipse.core.runtime.IPath path) Unregister a file that was active within an editor.
void	unregisterFile(org.eclipse.jface.text.IDocument doc, org.eclipse.core.resources.IFile file) Unregister a file that was active within an editor.

Method Detail

registerFile

public void registerFile(org.eclipse.jface.text.IDocument doc,
                         org.eclipse.core.resources.IFile file,
                         IProjectLoadListener progressListener)

Register a file that's active within an editor. Register any containing projects (who have the file in their source folder or a linked folder), if they haven't already been registered. Parse the file so that its tree is up to date.

Parameters:

doc - open document

file - associated file

progressListener - listener to listen to the project loading (if project loading is done) and display a status bar; can be null

registerExternalFile

public void registerExternalFile(org.eclipse.jface.text.IDocument doc,
                                 org.eclipse.core.runtime.IPath file,
                                 IProjectLoadListener progressListener)

Register a file that's active within an editor. Does not register with any projects explicitly

Parameters:

doc - open document

file - associated file

progressListener - listener to listen to the project loading (if project loading is done) and display a status bar; can be null

unregisterFile

public void unregisterFile(org.eclipse.jface.text.IDocument doc,
                           org.eclipse.core.resources.IFile file)

Unregister a file that was active within an editor. This decimates the file so that it takes up less memory.

Parameters:

doc - The document

file - The file

unregisterExternalFile

public void unregisterExternalFile(org.eclipse.jface.text.IDocument doc,
                                   org.eclipse.core.runtime.IPath path)

Unregister a file that was active within an editor. This decimates the file so that it takes up less memory.

Parameters:

doc - The document

path - The path

isProjectRegistered

public boolean isProjectRegistered(org.eclipse.core.resources.IProject eclipseProject)

Determine whether or not this project has been registered with the code model.

Parameters:

eclipseProject - Eclipse project

registerProject

public void registerProject(org.eclipse.core.resources.IProject eclipseProject,
                            IProjectLoadListener progressListener)

Register a project with the code model. Add the project and preload all of the files from the project and its class paths. If the project has already been registered (and not subsequently closed), this won't do any work.

Parameters:

eclipseProject - Eclipse project

progressListener - listener to listen to the project loading and display a status bar; can be null