agentgui.core.project

Class ProjectsLoaded

java.lang.Object

agentgui.core.project.ProjectsLoaded

public class ProjectsLoaded
extends java.lang.Object

This class holds the list of the projects, that are currently open within Agent.GUI and offers methods to deal with them.

Constructor Summary

Constructors

Constructor and Description
ProjectsLoaded()

Method Summary

Modifier and Type	Method and Description
Project	add(boolean addNew) Adding (Creating or Opening) a new Project to the Application.
Project	add(boolean addNew, java.lang.String selectedProjectFolder, MApplication mApplication, EPartService ePartService, EModelService eModelService) Adding (Creating or Opening) a new Project to the Application.
Project	add(java.lang.String selectedProjectFolder) Open a project corresponding to specified project folder.
boolean	closeAll() This method will try to close all open projects.
boolean	closeAll(java.awt.Component parentComponent) This method will try to close all open projects.
boolean	closeAll(java.awt.Component parentComponent, boolean isSkipSaving) This method will try to close all open projects.
int	count() Counts the actual open projects
Project	get(int indexOfProject) Returns the Project-instance given by its index
Project	get(java.lang.String projectName) Returns the Project-instance given by its project name
int	getIndexByFolderName(java.lang.String projectFolderName) Identifies a Project by its Root-Folder-Name and returns the Array-/Window-Index
int	getIndexByName(java.lang.String projectName) Identifies a Project by its name and returns the Array-/Window-Index
java.util.ArrayList<Project>	getProjectsOpen() Returns the list of currently open projects.
void	projectDelete() Can be used in order to delete a project.
void	projectDelete(java.io.File projectSubDirectory) Deletes the specified project sub directory
void	projectDelete(java.lang.String projectSubDirectory) Deletes the specified project sub directory (the last element in the path is enough).
void	projectExport() Exports a project to a file
void	projectExportToRepository() Exports the currently focused Project to the local repository.
void	projectImport() Imports a project, which is packed in Agent.GUI project file (*.agui)
void	remove(Project project2Remove) Removes a single Project
void	removeAll() Removes all Projects from the (Array) ProjectList
void	setProjectView() Configures the appearance of the application, depending on the current project configuration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProjectsLoaded

public ProjectsLoaded()

Method Detail

getProjectsOpen

public java.util.ArrayList<Project> getProjectsOpen()

Returns the list of currently open projects.

Returns:

the projects open

add

public Project add(boolean addNew)

Adding (Creating or Opening) a new Project to the Application.

Parameters:

addNew - the add new. If set false, the user dialog for selecting a project to open will be shown

Returns:

The Project-instance that was added or null.

add

public Project add(java.lang.String selectedProjectFolder)

Open a project corresponding to specified project folder.

Parameters:

selectedProjectFolder - the selected project folder from the projects directory

Returns:

the Project-instance that was added here

add

public Project add(boolean addNew,
                   java.lang.String selectedProjectFolder,
                   MApplication mApplication,
                   EPartService ePartService,
                   EModelService eModelService)

Adding (Creating or Opening) a new Project to the Application.

Parameters:

addNew - the add new

selectedProjectFolder - the selected project folder

mApplication - the eclipse MApplication

ePartService - the eclipse EPpartService

eModelService - the eclipse EMmodelService

Returns:

The Project-instance that was added here

closeAll

public boolean closeAll()

This method will try to close all open projects.

Parameters:

parentComponent - the parent component

Returns:

Returns true on success

closeAll

public boolean closeAll(java.awt.Component parentComponent)

This method will try to close all open projects.

Parameters:

parentComponent - the parent component (for messages by using the JOptionPane)

Returns:

Returns true on success

closeAll

public boolean closeAll(java.awt.Component parentComponent,
                        boolean isSkipSaving)

This method will try to close all open projects.

Parameters:

parentComponent - the parent component (for messages by using the JOptionPane)

isSkipSaving - set true, if you want to skip user interactions for saving a project

Returns:

Returns true on success

get

public Project get(java.lang.String projectName)

Returns the Project-instance given by its project name

Parameters:

projectName -

Returns:

A Project instance

get

public Project get(int indexOfProject)

Returns the Project-instance given by its index

Parameters:

indexOfProject -

Returns:

A Project instance

remove

public void remove(Project project2Remove)

Removes a single Project

Parameters:

project2Remove -

removeAll

public void removeAll()

Removes all Projects from the (Array) ProjectList

getIndexByName

public int getIndexByName(java.lang.String projectName)

Identifies a Project by its name and returns the Array-/Window-Index

Parameters:

projectName -

Returns:

The index position of a project

getIndexByFolderName

public int getIndexByFolderName(java.lang.String projectFolderName)

Identifies a Project by its Root-Folder-Name and returns the Array-/Window-Index

Parameters:

projectFolderName -

Returns:

The index position of a project

count

public int count()

Counts the actual open projects

setProjectView

public void setProjectView()

Configures the appearance of the application, depending on the current project configuration

projectImport

public void projectImport()

Imports a project, which is packed in Agent.GUI project file (*.agui)

projectExport

public void projectExport()

Exports a project to a file

projectExportToRepository

public void projectExportToRepository()

Exports the currently focused Project to the local repository.

projectDelete

public void projectDelete()

Can be used in order to delete a project.

projectDelete

public void projectDelete(java.lang.String projectSubDirectory)

Deletes the specified project sub directory (the last element in the path is enough).

Parameters:

projectSubDirectory - the project sub directory

projectDelete

public void projectDelete(java.io.File projectSubDirectory)

Deletes the specified project sub directory

Parameters:

projectSubDirectory - the project sub directory