org.agentgui.gui

Interface AwbProjectEditorWindow

All Known Implementing Classes:

ProjectEditor, ProjectWindow

public interface AwbProjectEditorWindow

The Interface ProjectWindow defines the required methods for the editor of a project.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AwbProjectEditorWindow.ProjectCloseUserFeedback The Enumeration ProjectCloseUserFeedback.

Method Summary

Modifier and Type	Method and Description
void	addDefaultTabs() Adds the default tabs.
void	addProjectTab(ProjectWindowTab projectWindowTab) Adds the specified project tab.
void	addProjectTab(ProjectWindowTab projectWindowTab, int indexPosition) Adds a Project-Tab and a new node (child of a specified parent) to the ProjectWindow at the specified index position.
void	dispose() Disposes the AwbProjectEditorWindow.
Project	getProject() Has to return the current project.
ProjectWindowTab	getTabForSubPanels(java.lang.String superPanelName) Returns the specified tab for sub panels.
AwbProjectEditorWindow.ProjectCloseUserFeedback	getUserFeedbackForClosingProject(java.lang.String msgTitle, java.lang.String msgText, java.lang.Object parentVisualizationComponent) Checks, how the user wants to proceed, if unsaved projects has to be closed.
void	moveToFront() Moves the AwbProjectEditorWindow to the front.
void	removeProjectTab(ProjectWindowTab projectWindowTab) Removes the specified project tab.
void	setFocus2Tab(java.lang.String tabName) Has to set the focus to the specified tab.
void	setMaximized() Maximizes the current AwbProjectEditorWindow.
void	setViewForDeveloperOrEndUser() Rebuilds the AwbProjectEditorWindow depending on the selected view that is either Project.VIEW_User, Project.VIEW_Developer or null.
void	showErrorMessage(java.lang.String msgText, java.lang.String msgHead) Has to show an error message.
void	validateStartTab() Has to validates the current start tab settings that could be changed, if the view was changed from developer to end user view.

Method Detail

getProject

Project getProject()

Has to return the current project.

Returns:

the project

getUserFeedbackForClosingProject

AwbProjectEditorWindow.ProjectCloseUserFeedback getUserFeedbackForClosingProject(java.lang.String msgTitle,
                                                                                 java.lang.String msgText,
                                                                                 java.lang.Object parentVisualizationComponent)

Checks, how the user wants to proceed, if unsaved projects has to be closed.

Parameters:

msgTitle - the message title

msgText - the message text

parentVisualizationComponent - the parent visualization component

Returns:

true, if is user allowed to close project

showErrorMessage

void showErrorMessage(java.lang.String msgText,
                      java.lang.String msgHead)

Has to show an error message.

Parameters:

msgText - the message text

msgHead - the message header

addDefaultTabs

void addDefaultTabs()

Adds the default tabs.

addProjectTab

void addProjectTab(ProjectWindowTab projectWindowTab)

Adds the specified project tab.

Parameters:

projectWindowTab - the project window tab

addProjectTab

void addProjectTab(ProjectWindowTab projectWindowTab,
                   int indexPosition)

Adds a Project-Tab and a new node (child of a specified parent) to the ProjectWindow at the specified index position. The index position has to be greater than 1, in order to keep the 'Info'-Tab and the 'Configuration'-Tab at its original position!

Parameters:

projectWindowTab - the project window tab

indexPosition - the index position (greater one)

removeProjectTab

void removeProjectTab(ProjectWindowTab projectWindowTab)

Removes the specified project tab.

Parameters:

projectWindowTab - the project window tab

dispose

void dispose()

Disposes the AwbProjectEditorWindow.

moveToFront

void moveToFront()

Moves the AwbProjectEditorWindow to the front.

setMaximized

void setMaximized()

Maximizes the current AwbProjectEditorWindow.

setFocus2Tab

void setFocus2Tab(java.lang.String tabName)

Has to set the focus to the specified tab.

Parameters:

tabName - the new focus 2 tab

setViewForDeveloperOrEndUser

void setViewForDeveloperOrEndUser()

Rebuilds the AwbProjectEditorWindow depending on the selected view that is either Project.VIEW_User, Project.VIEW_Developer or null.

getTabForSubPanels

ProjectWindowTab getTabForSubPanels(java.lang.String superPanelName)

Returns the specified tab for sub panels.

Parameters:

superPanelName - the super panel name

Returns:

the tab for sub panels

validateStartTab

void validateStartTab()

Has to validates the current start tab settings that could be changed, if the view was changed from developer to end user view.