org.agentgui.gui.swt.project

Class ProjectEditor

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.agentgui.gui.swt.project.ProjectEditor

All Implemented Interfaces:

AwbProjectEditorWindow, IAdaptable, IExecutableExtension, IEditorPart, ISaveablePart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation

public class ProjectEditor
extends EditorPart
implements AwbProjectEditorWindow

The ProjectEditor is used as project editor within the SWT environment.

Nested Class Summary

Nested classes/interfaces inherited from interface org.agentgui.gui.AwbProjectEditorWindow

AwbProjectEditorWindow.ProjectCloseUserFeedback

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID

Fields inherited from interface org.eclipse.ui.IEditorPart

PROP_DIRTY, PROP_INPUT

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
ProjectEditor(MPart mPart, Shell shell) Instantiates a new project editor.

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	createPartControl(Composite parent) Create contents of the editor part.
void	doSave(IProgressMonitor monitor)
void	doSaveAs()
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	init(IEditorSite site, IEditorInput input)
boolean	isDirty()
boolean	isSaveAsAllowed()
void	moveToFront() Moves the AwbProjectEditorWindow to the front.
void	removeProjectTab(ProjectWindowTab projectWindowTab) Removes the specified project tab.
void	setFocus()
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.

Methods inherited from class org.eclipse.ui.part.EditorPart

checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, dispose, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.agentgui.gui.AwbProjectEditorWindow

dispose

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, dispose, getSite, getTitle, getTitleImage, removePropertyListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

ProjectEditor

@Inject
public ProjectEditor(MPart mPart,
                             Shell shell)

Instantiates a new project editor.

Parameters:

mPart - the MPart that uses the current ProjectEditor as 'Object'

shell - the current shell

Method Detail

init

public void init(IEditorSite site,
                 IEditorInput input)
          throws PartInitException

Specified by:

init in interface IEditorPart

Specified by:

init in class EditorPart

Throws:

PartInitException

createPartControl

@PostConstruct
public void createPartControl(Composite parent)

Create contents of the editor part.

Specified by:

createPartControl in interface IWorkbenchPart

Specified by:

createPartControl in class WorkbenchPart

Parameters:

parent -

setFocus

public void setFocus()

Specified by:

setFocus in interface IWorkbenchPart

Specified by:

setFocus in class WorkbenchPart

doSave

public void doSave(IProgressMonitor monitor)

Specified by:

doSave in interface ISaveablePart

Specified by:

doSave in class EditorPart

isDirty

public boolean isDirty()

Specified by:

isDirty in interface ISaveablePart

Specified by:

isDirty in class EditorPart

isSaveAsAllowed

public boolean isSaveAsAllowed()

Specified by:

isSaveAsAllowed in interface ISaveablePart

Specified by:

isSaveAsAllowed in class EditorPart

doSaveAs

public void doSaveAs()

Specified by:

doSaveAs in interface ISaveablePart

Specified by:

doSaveAs in class EditorPart

getProject

public Project getProject()

Description copied from interface: AwbProjectEditorWindow

Has to return the current project.

Specified by:

getProject in interface AwbProjectEditorWindow

Returns:

the project

getUserFeedbackForClosingProject

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

Description copied from interface: AwbProjectEditorWindow

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

Specified by:

getUserFeedbackForClosingProject in interface AwbProjectEditorWindow

Parameters:

msgTitle - the message title

msgText - the message text

parentVisualizationComponent - the parent visualization component

Returns:

true, if is user allowed to close project

addDefaultTabs

public void addDefaultTabs()

Description copied from interface: AwbProjectEditorWindow

Adds the default tabs.

Specified by:

addDefaultTabs in interface AwbProjectEditorWindow

moveToFront

public void moveToFront()

Description copied from interface: AwbProjectEditorWindow

Moves the AwbProjectEditorWindow to the front.

Specified by:

moveToFront in interface AwbProjectEditorWindow

setMaximized

public void setMaximized()

Description copied from interface: AwbProjectEditorWindow

Maximizes the current AwbProjectEditorWindow.

Specified by:

setMaximized in interface AwbProjectEditorWindow

setFocus2Tab

public void setFocus2Tab(java.lang.String tabName)

Description copied from interface: AwbProjectEditorWindow

Has to set the focus to the specified tab.

Specified by:

setFocus2Tab in interface AwbProjectEditorWindow

Parameters:

tabName - the new focus 2 tab

setViewForDeveloperOrEndUser

public void setViewForDeveloperOrEndUser()

Description copied from interface: AwbProjectEditorWindow

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

Specified by:

setViewForDeveloperOrEndUser in interface AwbProjectEditorWindow

getTabForSubPanels

public ProjectWindowTab getTabForSubPanels(java.lang.String superPanelName)

Description copied from interface: AwbProjectEditorWindow

Returns the specified tab for sub panels.

Specified by:

getTabForSubPanels in interface AwbProjectEditorWindow

Parameters:

superPanelName - the super panel name

Returns:

the tab for sub panels

validateStartTab

public void validateStartTab()

Description copied from interface: AwbProjectEditorWindow

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

Specified by:

validateStartTab in interface AwbProjectEditorWindow

showErrorMessage

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

Description copied from interface: AwbProjectEditorWindow

Has to show an error message.

Specified by:

showErrorMessage in interface AwbProjectEditorWindow

Parameters:

msgText - the message text

msgHead - the message header

addProjectTab

public void addProjectTab(ProjectWindowTab projectWindowTab)

Description copied from interface: AwbProjectEditorWindow

Adds the specified project tab.

Specified by:

addProjectTab in interface AwbProjectEditorWindow

Parameters:

projectWindowTab - the project window tab

addProjectTab

public void addProjectTab(ProjectWindowTab projectWindowTab,
                          int indexPosition)

Description copied from interface: AwbProjectEditorWindow

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!

Specified by:

addProjectTab in interface AwbProjectEditorWindow

Parameters:

projectWindowTab - the project window tab

indexPosition - the index position (greater one)

removeProjectTab

public void removeProjectTab(ProjectWindowTab projectWindowTab)

Description copied from interface: AwbProjectEditorWindow

Removes the specified project tab.

Specified by:

removeProjectTab in interface AwbProjectEditorWindow

Parameters:

projectWindowTab - the project window tab