com.adobe.flexbuilder.codemodel.project
Interface IProject

public interface IProject

There are code model projects for each open Flex or ActionScript project. This is the central point of contact for all information about the types and components defined in that project or its class and library paths.

Method Summary

void	addDefinitionListener(IDefinitionListener dependent) Adds a definition listener to the project
void	addFileListener(IFileListener dependent) Adds a file listener to the project.
void	addIndexableFileListener(IIndexableFileListener listener) Adds an IIndexableFileListener to this project
IFileNode	findFileNodeInProject(org.eclipse.core.runtime.IPath path) Returns the file base node.
IASNode	getApplicationRoot() Get the root application class for this project
IIndex	getIndex(java.lang.String indexID) Returns an index from the specified ID.
IProjectSpecification	getSpecification() Returns the project specification.
IProjectRootNode	getTreeBaseNode() Returns the project base node.
void	removeDefinitionListener(IDefinitionListener dependent) Removes a definition listener from the project
void	removeFileListener(IFileListener dependent) Removes a file listener from the project.
void	removeIndexableFileListener(IIndexableFileListener listener) Removes an IIndexableFileListener to this project
java.util.List	resolveUsingManifests(java.lang.String className) Look up a fully qualified class name in the server's manifest files and figure out which tags (XML namespace + short name) it could match
java.lang.String	resolveUsingManifests(XMLName tagName) Look up a TagName (XML namespace+short name) in the server's manifest files and try to get the fully qualified class name.

Method Detail

getSpecification

public IProjectSpecification getSpecification()

Returns the project specification.

Returns:

The project specification.

addFileListener

public void addFileListener(IFileListener dependent)

Adds a file listener to the project.

Parameters:

dependent - file listener.

removeFileListener

public void removeFileListener(IFileListener dependent)

Removes a file listener from the project.

Parameters:

dependent - file listener.

addIndexableFileListener

public void addIndexableFileListener(IIndexableFileListener listener)

Adds an IIndexableFileListener to this project

Parameters:

listener - an IIndexableFileListener

removeIndexableFileListener

public void removeIndexableFileListener(IIndexableFileListener listener)

Removes an IIndexableFileListener to this project

Parameters:

listener - an IIndexableFileListener

addDefinitionListener

public void addDefinitionListener(IDefinitionListener dependent)

Adds a definition listener to the project

Parameters:

dependent - definition listener

removeDefinitionListener

public void removeDefinitionListener(IDefinitionListener dependent)

Removes a definition listener from the project

Parameters:

dependent - definition listener

getTreeBaseNode

public IProjectRootNode getTreeBaseNode()

Returns the project base node. This base node contains the files as they appear on disk. If you want a tree for something that's still in memory, use getBaseNodeForFile().

Returns:

The project base node.

findFileNodeInProject

public IFileNode findFileNodeInProject(org.eclipse.core.runtime.IPath path)

Returns the file base node. This tree will be in sync with whatever is in memory (even if the file hasn't yet been saved.

Parameters:

path - path to the file

Returns:

FileNode for that file

getIndex

public IIndex getIndex(java.lang.String indexID)

Returns an index from the specified ID. Each index provides a view of the code model data. For example, the tag information index, available with getIndex(ITagInformationIndex.ID), provides access to all component tags that are implied by the MXML files and ActionScript classes defined in the project and its class and library paths.

Parameters:

indexID - The index ID.

Returns:

The index.

getApplicationRoot

public IASNode getApplicationRoot()

Get the root application class for this project

Returns:

the root application class

resolveUsingManifests

public java.lang.String resolveUsingManifests(XMLName tagName)

Look up a TagName (XML namespace+short name) in the server's manifest files and try to get the fully qualified class name.

Parameters:

tagName - the tag to search for (with XML namespace and short name)

Returns:

the fully qualified class name (or null, if the tag isn't described in the server's manifest files

resolveUsingManifests

public java.util.List resolveUsingManifests(java.lang.String className)

Look up a fully qualified class name in the server's manifest files and figure out which tags (XML namespace + short name) it could match

Parameters:

className - the fully qualified class name

Returns:

a List of possible TagName matches