Interface com.symantec.itools.vcafe.openapi.ProjectListener
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.symantec.itools.vcafe.openapi.ProjectListener

public interface ProjectListener
The listener interface for receiving notification when a change has occurred to a VisualProject. To be notified of changes, a plug-in implements this interface then calls VisualProject.addProjectListener to place itself on the notification list. When the VisualProject changes, the appropriate method of this interface is called. If you are only interested in a subset of the notification methods, you can extend the ProjectAdapter class rather than implement all the methods yourself.

Version:
1.0
Author:
Symantec Internet Tools Division
Since:
VCafe 3.0
See Also:
addProjectListener, ProjectAdapter

Method Index

 o aboutToChangeProjectEntries(VisualProject)
This method is called before changes occur to the data of ProjectFiles.
 o aboutToRunProject(VisualProject)
This method is called before the project is run
 o aboutToSaveAll(VisualProject)
This method is called before a save all is performed on the project
 o aboutToSaveProject(VisualProject)
This method is called before the project is saved.
 o doneChangingProjectEntries(VisualProject)
This method is called after changes occur to the data of ProjectFiles.
 o doneRunningProject(VisualProject)
This method is called when the project is no longer running
 o doneSavingAll(VisualProject)
This method is called after a save all is performed on the project
 o doneSavingProject(VisualProject)
This method is called after the project is saved
 o projectClosed(VisualProject)
This method is called when the project is closed.
 o projectFileAdded(VisualProject, ProjectFile, int)
This method is called when a file is added to the project
 o projectFileRemoved(VisualProject, ProjectFile, int)
This method is called before a file is removed from the project
 o projectFileRenamed(VisualProject, ProjectFile, String, String)
This method is called when a file in the project is renamed
 o projectMoved(VisualProject, String, String)
This method is called when the project is moved on disk.
 o projectOptionSetChanged(VisualProject)
This method is called after the user changes the current option set from Debug to Final, or vice versa.
 o projectOptionsChanged(VisualProject)
This method is called after the user changes the project's options

Methods

 o aboutToChangeProjectEntries
public abstract void aboutToChangeProjectEntries(VisualProject visualProject)
This method is called before changes occur to the data of ProjectFiles. For example, before a build or a reparse of the browser information.

Parameters:
visualProject - the project whose ProjectFiles are changing
 o aboutToRunProject
public abstract void aboutToRunProject(VisualProject visualProject)
This method is called before the project is run

Parameters:
visualProject - the project that is to be run
 o aboutToSaveAll
public abstract void aboutToSaveAll(VisualProject visualProject)
This method is called before a save all is performed on the project

Parameters:
visualProject - the project that is to be saved
 o aboutToSaveProject
public abstract boolean aboutToSaveProject(VisualProject visualProject)
This method is called before the project is saved.

Parameters:
visualProject - the project that is to be saved.
Returns:
true if the project save continue.
 o doneChangingProjectEntries
public abstract void doneChangingProjectEntries(VisualProject visualProject)
This method is called after changes occur to the data of ProjectFiles. For example, after a build or a reparse of the browser information.

Parameters:
visualProject - the project whose ProjectFiles have changed
 o doneRunningProject
public abstract void doneRunningProject(VisualProject visualProject)
This method is called when the project is no longer running

Parameters:
visualProject - the project that was running
 o doneSavingAll
public abstract void doneSavingAll(VisualProject visualProject)
This method is called after a save all is performed on the project

Parameters:
visualProject - the project that was saved
 o doneSavingProject
public abstract void doneSavingProject(VisualProject visualProject)
This method is called after the project is saved

Parameters:
visualProject - the project that was saved
 o projectClosed
public abstract void projectClosed(VisualProject visualProject)
This method is called when the project is closed. After this method is called, this listener is removed from the project.

Parameters:
visualProject - the project that is being closed.
 o projectFileAdded
public abstract void projectFileAdded(VisualProject visualProject,
                                      ProjectFile projectFile,
                                      int addedBy)
This method is called when a file is added to the project

Parameters:
visualProject - the project that contains the ProjectFile
projectFile - the ProjectFile object that was added
addedBy - who added the file
See Also:
getFileAddedBy
 o projectFileRemoved
public abstract void projectFileRemoved(VisualProject visualProject,
                                        ProjectFile projectFile,
                                        int removedBy)
This method is called before a file is removed from the project

Parameters:
visualProject - the project that contained the ProjectFile
projectFile - the ProjectFile object that was removed
removedBy - who removed the file
 o projectFileRenamed
public abstract void projectFileRenamed(VisualProject visualProject,
                                        ProjectFile projectFile,
                                        String oldName,
                                        String newName)
This method is called when a file in the project is renamed

Parameters:
visualProject - the project that contains the ProjectFile
projectFile - the ProjectFile object that will be/was renamed
oldName - the previous name of the ProjectFile
newName - the current name of the ProjectFile
 o projectMoved
public abstract void projectMoved(VisualProject visualProject,
                                  String oldLocation,
                                  String newLocation)
This method is called when the project is moved on disk.

Parameters:
visualProject - the project that has moved.
oldLocation - the previous location of the project.
newLocation - the current location of the project.
 o projectOptionSetChanged
public abstract void projectOptionSetChanged(VisualProject visualProject)
This method is called after the user changes the current option set from Debug to Final, or vice versa.

Parameters:
visualProject - the project whose option set changed
 o projectOptionsChanged
public abstract void projectOptionsChanged(VisualProject visualProject)
This method is called after the user changes the project's options

Parameters:
visualProject - the project whose options changed

All Packages  Class Hierarchy  This Package  Previous  Next  Index