org.kie.workbench.common.stunner.project.client.editor

Class AbstractProjectDiagramEditor<R extends org.uberfire.client.workbench.type.ClientResourceType>

java.lang.Object

org.uberfire.ext.editor.commons.client.BaseEditor

org.kie.workbench.common.widgets.metadata.client.KieEditor

org.kie.workbench.common.stunner.project.client.editor.AbstractProjectDiagramEditor<R>

All Implemented Interfaces:

KieEditorWrapperView.KieEditorWrapperPresenter

public abstract class AbstractProjectDiagramEditor<R extends org.uberfire.client.workbench.type.ClientResourceType>
extends KieEditor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractProjectDiagramEditor.View

Field Summary

Fields

Modifier and Type	Field and Description
protected SessionPresenter<AbstractClientFullSession,?,Diagram>	presenter

Fields inherited from class org.kie.workbench.common.widgets.metadata.client.KieEditor

assetUpdateValidator, copyPopUpPresenter, deletePopUpPresenter, fileMenuBuilder, kieView, metadata, overviewWidget, projectController, renamePopUpPresenter, savePopUpPresenter, workbenchContext

Fields inherited from class org.uberfire.ext.editor.commons.client.BaseEditor

baseView, changeTitleNotification, concurrentDeleteAcceptedEvent, concurrentDeleteIgnoredEvent, concurrentRenameAcceptedEvent, concurrentRenameIgnoredEvent, concurrentUpdateSessionInfo, fileNameValidator, isReadOnly, menuBuilder, menuItems, menus, notification, originalHash, place, type, versionRecordManager

Constructor Summary

Constructors

Constructor and Description

AbstractProjectDiagramEditor(AbstractProjectDiagramEditor.View view, org.uberfire.client.mvp.PlaceManager placeManager, org.uberfire.client.workbench.widgets.common.ErrorPopupPresenter errorPopupPresenter, javax.enterprise.event.Event<org.uberfire.client.workbench.events.ChangeTitleWidgetEvent> changeTitleNotificationEvent, org.uberfire.ext.editor.commons.client.file.popups.SavePopUpPresenter savePopUpPresenter, R resourceType, ClientProjectDiagramService projectDiagramServices, SessionManager sessionManager, SessionPresenterFactory<Diagram,AbstractClientReadOnlySession,AbstractClientFullSession> sessionPresenterFactory, SessionCommandFactory sessionCommandFactory, ProjectDiagramEditorMenuItemsBuilder menuItemsBuilder, javax.enterprise.event.Event<OnDiagramFocusEvent> onDiagramFocusEvent, javax.enterprise.event.Event<OnDiagramLoseFocusEvent> onDiagramLostFocusEvent, ProjectMessagesListener projectMessagesListener, DiagramClientErrorHandler diagramClientErrorHandler)

Method Summary

Modifier and Type	Method and Description
protected boolean	_onMayClose()
protected void	doClose()
protected void	doFocus()
protected void	doLostFocus()
protected void	doOpen()
protected void	doStartUp(org.uberfire.backend.vfs.ObservablePath path, org.uberfire.mvp.PlaceRequest place)
protected String	formatTitle(String title) Format the Diagram title to be displayed on the Editor.
protected CanvasHandler	getCanvasHandler()
protected abstract int	getCanvasHeight()
protected abstract int	getCanvasWidth()
protected int	getCurrentDiagramHash()
protected ProjectDiagram	getDiagram()
protected abstract String	getEditorIdentifier()
protected org.uberfire.workbench.model.menu.Menus	getMenus()
String	getTitleText()
protected AbstractProjectDiagramEditor.View	getView()
protected boolean	hasUnsavedChanges()
void	hideDiagramEditorDocks(org.uberfire.client.workbench.events.PlaceHiddenEvent event)
protected void	hideLoadingViews()
void	init()
protected void	loadContent()
protected void	makeMenuBar()
protected void	onSave()
protected org.uberfire.mvp.Command	onValidate()
protected void	open(ProjectDiagram diagram)
protected void	save() This method is called just once clicking on save.
protected void	save(String commitMessage) Considering the diagram valid at this point , it delegates the save operation to the diagram services bean.
void	showDiagramEditorDocks(org.uberfire.client.workbench.events.PlaceGainFocusEvent event)
protected void	showLoadingViews()

Methods inherited from class org.kie.workbench.common.widgets.metadata.client.KieEditor

addImportsTab, addPage, addSourcePage, buildMenuBar, canUpdateProject, createOriginalHash, getCouldNotGenerateSourceErrorCallback, getNoSuchFileExceptionErrorCallback, getSelectedTabIndex, getWidget, init, init, init, init, isEditorTabSelected, isOverviewTabSelected, mayClose, mayClose, OnClose, onEditTabSelected, onEditTabUnselected, onOverviewSelected, onRepositoryRemoved, onSourceTabSelected, resetEditorPages, saveAction, selectEditorTab, selectOverviewTab, setOriginalHash, setSelectedTab, showVersions, updateSource

Methods inherited from class org.uberfire.ext.editor.commons.client.BaseEditor

getCopyServiceCaller, getCopyValidator, getDeleteServiceCaller, getRenameServiceCaller, getRenameValidator, getSaveSuccessCallback, getTitle, getVersionRecordManager, init, isDirty, onRename, onRestore, reload, showConcurrentUpdatePopup

Methods inherited from class java.lang.Object

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

Field Detail

presenter

protected SessionPresenter<AbstractClientFullSession,?,Diagram> presenter

Constructor Detail

AbstractProjectDiagramEditor

@Inject
public AbstractProjectDiagramEditor(AbstractProjectDiagramEditor.View view,
                                            org.uberfire.client.mvp.PlaceManager placeManager,
                                            org.uberfire.client.workbench.widgets.common.ErrorPopupPresenter errorPopupPresenter,
                                            javax.enterprise.event.Event<org.uberfire.client.workbench.events.ChangeTitleWidgetEvent> changeTitleNotificationEvent,
                                            org.uberfire.ext.editor.commons.client.file.popups.SavePopUpPresenter savePopUpPresenter,
                                            R resourceType,
                                            ClientProjectDiagramService projectDiagramServices,
                                            SessionManager sessionManager,
                                            SessionPresenterFactory<Diagram,AbstractClientReadOnlySession,AbstractClientFullSession> sessionPresenterFactory,
                                            SessionCommandFactory sessionCommandFactory,
                                            ProjectDiagramEditorMenuItemsBuilder menuItemsBuilder,
                                            javax.enterprise.event.Event<OnDiagramFocusEvent> onDiagramFocusEvent,
                                            javax.enterprise.event.Event<OnDiagramLoseFocusEvent> onDiagramLostFocusEvent,
                                            ProjectMessagesListener projectMessagesListener,
                                            DiagramClientErrorHandler diagramClientErrorHandler)

Method Detail

getCanvasWidth

protected abstract int getCanvasWidth()

getCanvasHeight

protected abstract int getCanvasHeight()

init

@PostConstruct
public void init()

doStartUp

protected void doStartUp(org.uberfire.backend.vfs.ObservablePath path,
                         org.uberfire.mvp.PlaceRequest place)

loadContent

protected void loadContent()

Specified by:

loadContent in class org.uberfire.ext.editor.commons.client.BaseEditor

open

protected void open(ProjectDiagram diagram)

onValidate

protected org.uberfire.mvp.Command onValidate()

Overrides:

onValidate in class org.uberfire.ext.editor.commons.client.BaseEditor

save

protected void save()

This method is called just once clicking on save. Before starting the save process, let's perform a diagram validation to check all it's valid. It's allowed to continue with the save process event if warnings found, but cannot save if any error is present in order to guarantee the diagram's consistency.

Overrides:

save in class KieEditor

save

protected void save(String commitMessage)

Considering the diagram valid at this point , it delegates the save operation to the diagram services bean.

Overrides:

save in class KieEditor

Parameters:

commitMessage - The commit's message.

makeMenuBar

protected void makeMenuBar()

Overrides:

makeMenuBar in class KieEditor

doOpen

protected void doOpen()

showLoadingViews

protected void showLoadingViews()

hideLoadingViews

protected void hideLoadingViews()

doClose

protected void doClose()

doFocus

protected void doFocus()

doLostFocus

protected void doLostFocus()

getEditorIdentifier

protected abstract String getEditorIdentifier()

getTitleText

public String getTitleText()

Overrides:

getTitleText in class org.uberfire.ext.editor.commons.client.BaseEditor

getMenus

protected org.uberfire.workbench.model.menu.Menus getMenus()

_onMayClose

protected boolean _onMayClose()

onSave

protected void onSave()

Overrides:

onSave in class KieEditor

formatTitle

protected String formatTitle(String title)

Format the Diagram title to be displayed on the Editor. This method can be override to customization and the default implementation just return the title from the diagram metadata.

Parameters:

title - diagram metadata title

Returns:

formatted title

getCurrentDiagramHash

protected int getCurrentDiagramHash()

getCanvasHandler

protected CanvasHandler getCanvasHandler()

getDiagram

protected ProjectDiagram getDiagram()

getView

protected AbstractProjectDiagramEditor.View getView()

hasUnsavedChanges

protected boolean hasUnsavedChanges()

hideDiagramEditorDocks

public void hideDiagramEditorDocks(@Observes
                                   org.uberfire.client.workbench.events.PlaceHiddenEvent event)

showDiagramEditorDocks

public void showDiagramEditorDocks(@Observes
                                   org.uberfire.client.workbench.events.PlaceGainFocusEvent event)