com.sun.rave.designtime
Interface IdeProject

All Superinterfaces:

DisplayItem

public interface IdeProject

extends DisplayItem

A IdeProject is a top-level container for DesignContexts at design-time. The IdeProject represents the project in the Creator IDE. Not much can be done with Projects in the Creator Design-Time API, except for accessing other DesignContexts, listening to project-level events, and storing project-level data.

IMPLEMENTED BY CREATOR - This interface is implemented by Creator for use by the component (bean) author.

Version:

1.0

Author:

Joe Nuxoll

See Also:

DesignContext.getProject()

Method Summary

void	addIdeProjectListener(IdeProjectListener listener) Adds a listener to this IdeProject
DesignContext[]	getDesignContexts() Returns all the DesignContexts in this project.
Ide	getIde() Returns the Ide (Creator) that is hosting this IdeProject.
IdeProjectListener[]	getIdeProjectListeners() Returns the array of current listeners to this IdeProject
java.lang.String	getProjectData(java.lang.String key) Retrieves the value for a name-value pair of data on this IdeProject.
void	removeIdeProjectListener(IdeProjectListener listener) Removes a listener from this IdeProject
void	setProjectData(java.lang.String key, java.lang.String data) Sets a name-value pair of data on this IdeProject.

Methods inherited from interface com.sun.rave.designtime.DisplayItem

getDescription, getDisplayName, getHelpKey, getLargeIcon, getSmallIcon

Method Detail

addIdeProjectListener

public void addIdeProjectListener(IdeProjectListener listener)

Adds a listener to this IdeProject

Parameters:

listener - The desired listener to add

getDesignContexts

public DesignContext[] getDesignContexts()

Returns all the DesignContexts in this project. There will be one DesignContext for each designable file in the project. Note that for JSF, this means one DesignContext for each combination of "PageX.java" and "PageX.jsp" file, as well as one for each of the non-page beans, like "SessionBeanX.java", "ApplicationBeanX.java", etc.

Returns:

An array of DesignContext objects - one for each designable file in the project

getIde

public Ide getIde()

Returns the Ide (Creator) that is hosting this IdeProject.

Returns:

the Ide (Creator) that is hosting this IdeProject.

getIdeProjectListeners

public IdeProjectListener[] getIdeProjectListeners()

Returns the array of current listeners to this IdeProject

Returns:

An array of listeners currently listening to this IdeProject

getProjectData

public java.lang.String getProjectData(java.lang.String key)

Retrieves the value for a name-value pair of data on this IdeProject. This name-value pair is stored in the project file, so this data is retrievable in any IDE session once it has been set.

Parameters:

key - The desired String key to retrieve the data for

Returns:

The String data that is currently stored under this key

See Also:

setProjectData(String, String)

removeIdeProjectListener

public void removeIdeProjectListener(IdeProjectListener listener)

Removes a listener from this IdeProject

Parameters:

listener - The desired listener to remove

setProjectData

public void setProjectData(java.lang.String key,
                           java.lang.String data)

Sets a name-value pair of data on this IdeProject. This name-value pair will be stored in the associated project file, so this data is retrievable in a future IDE session.

Parameters:

key - The String key to store the data under

data - The String data to store

See Also:

getProjectData(String)