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<T,org.guvnor.common.services.shared.metadata.model.Metadata>

org.kie.workbench.common.widgets.metadata.client.KieEditor<ProjectDiagramResource>

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

All Implemented Interfaces:

DiagramEditorCore<ProjectMetadata,ProjectDiagram>, KieEditorWrapperView.KieEditorWrapperPresenter

public abstract class AbstractProjectDiagramEditor<R extends org.uberfire.client.workbench.type.ClientResourceType>
extends KieEditor<ProjectDiagramResource>
implements DiagramEditorCore<ProjectMetadata,ProjectDiagram>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractProjectDiagramEditor.ProjectDiagramEditorCore
static interface	AbstractProjectDiagramEditor.View

Field Summary

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

alertsButtonMenuItemBuilder, assetUpdateValidator, copyPopUpPresenter, docks, fileMenuBuilder, kieView, metadata, overviewWidget, perspectiveManager, projectController, renamePopUpPresenter, savePopUpPresenter, workbenchContext

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

baseView, changeTitleNotification, concurrentChangePopup, concurrentDeleteAcceptedEvent, concurrentDeleteIgnoredEvent, concurrentRenameAcceptedEvent, concurrentRenameIgnoredEvent, concurrentUpdateSessionInfo, deletePopUpPresenter, fileNameValidator, isReadOnly, isValidationRunning, makeMenuBarPromise, menuBuilder, menuBuilderManagedInstance, menuItems, menus, metadataOriginalHash, notification, originalHash, place, placeManager, promises, saveAndRenameCommandBuilder, saveWithComments, type, versionRecordManager

Constructor Summary

Constructors

Constructor and Description

AbstractProjectDiagramEditor(AbstractProjectDiagramEditor.View view, org.uberfire.ext.widgets.core.client.editors.texteditor.TextEditorView xmlEditorView, org.jboss.errai.ioc.client.api.ManagedInstance<SessionEditorPresenter<EditorSession>> editorSessionPresenterInstances, org.jboss.errai.ioc.client.api.ManagedInstance<SessionViewerPresenter<ViewerSession>> viewerSessionPresenterInstances, javax.enterprise.event.Event<OnDiagramFocusEvent> onDiagramFocusEvent, javax.enterprise.event.Event<OnDiagramLoseFocusEvent> onDiagramLostFocusEvent, javax.enterprise.event.Event<org.uberfire.workbench.events.NotificationEvent> notificationEvent, org.uberfire.client.workbench.widgets.common.ErrorPopupPresenter errorPopupPresenter, DiagramClientErrorHandler diagramClientErrorHandler, DocumentationView documentationView, R resourceType, AbstractDiagramEditorMenuSessionItems<?> menuSessionItems, ProjectMessagesListener projectMessagesListener, ClientTranslationService translationService, ClientProjectDiagramService projectDiagramServices, org.jboss.errai.common.client.api.Caller<ProjectDiagramResourceService> projectDiagramResourceServiceCaller)

Method Summary

Modifier and Type	Method and Description
void	addDocumentationPage(ProjectDiagram diagram)
protected void	destroySession()
protected void	doClose()
void	doFocus()
void	doLostFocus()
protected void	doOpen()
protected void	doSave(org.uberfire.mvp.Command continueSaveOnceValid)
protected void	doSave(String commitMessage)
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.
CanvasHandler	getCanvasHandler()
protected Supplier<ProjectDiagramResource>	getContentSupplier()
protected Integer	getCurrentContentHash()
int	getCurrentDiagramHash()
protected String	getDiagramParsingErrorMessage(DiagramParsingException e)
Annotation[]	getDockQualifiers()
abstract String	getEditorIdentifier()
AbstractDiagramEditorMenuSessionItems	getMenuSessionItems()
protected org.uberfire.mvp.Command	getSaveAndRename()
protected org.jboss.errai.common.client.api.Caller<? extends org.uberfire.ext.editor.commons.service.support.SupportsSaveAndRename<ProjectDiagramResource,org.guvnor.common.services.shared.metadata.model.Metadata>>	getSaveAndRenameServiceCaller()
org.jboss.errai.common.client.api.RemoteCallback<org.uberfire.backend.vfs.Path>	getSaveSuccessCallback(int newHash)
SessionPresenter<? extends ClientSession,?,Diagram>	getSessionPresenter()
String	getTitleText()
protected ClientTranslationService	getTranslationService()
protected AbstractProjectDiagramEditor.View	getView()
protected boolean	hasUnsavedChanges()
void	hideDocks()
protected void	hideLoadingViews()
void	init()
void	initialiseKieEditorForSession(ProjectDiagram diagram)
protected boolean	isReadOnly()
protected boolean	isSameSession(ClientSession other)
protected void	loadContent()
protected void	log(Level level, String message)
protected void	makeAdditionalStunnerMenus(FileMenuBuilder fileMenuBuilder)
protected AbstractProjectDiagramEditorCore<ProjectMetadata,ProjectDiagram,ProjectDiagramResource,ProjectDiagramEditorProxy<ProjectDiagramResource>>	makeCore(AbstractProjectDiagramEditor.View view, org.uberfire.ext.widgets.core.client.editors.texteditor.TextEditorView xmlEditorView, javax.enterprise.event.Event<org.uberfire.workbench.events.NotificationEvent> notificationEvent, org.jboss.errai.ioc.client.api.ManagedInstance<SessionEditorPresenter<EditorSession>> editorSessionPresenterInstances, org.jboss.errai.ioc.client.api.ManagedInstance<SessionViewerPresenter<ViewerSession>> viewerSessionPresenterInstances, AbstractDiagramEditorMenuSessionItems<?> menuSessionItems, org.uberfire.client.workbench.widgets.common.ErrorPopupPresenter errorPopupPresenter, DiagramClientErrorHandler diagramClientErrorHandler, ClientTranslationService translationService)
protected elemental2.promise.Promise<Void>	makeMenuBar()
SessionEditorPresenter<EditorSession>	newSessionEditorPresenter()
SessionViewerPresenter<ViewerSession>	newSessionViewerPresenter()
protected void	onDiagramLoad()
protected void	onSave()
void	onSaveError(ClientRuntimeError error)
protected void	onSaveSuccess()
protected void	onValidate(org.uberfire.mvp.Command finished)
void	open(ProjectDiagram diagram, Viewer.Callback callback)
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	showDocks()
protected void	showLoadingViews()
protected void	showSavingViews()
protected void	updateTitle(String title)

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

addCommonActions, addCopy, addDelete, addDownloadMenuItem, addImportsTab, addPage, addRename, addSave, addSourcePage, addTabBarWidget, buildMenuBar, createOriginalHash, getCouldNotGenerateSourceErrorCallback, getMetadataSupplier, getNoSuchFileExceptionErrorCallback, getRenameValidator, getSelectedTabIndex, getWidget, init, init, init, init, isEditorTabSelected, isOverviewTabSelected, mayClose, mayClose, onClose, onEditTabSelected, onEditTabUnselected, onHideDocks, onOverviewSelected, onRepositoryRemoved, onShowDiagramEditorDocks, onSourceTabSelected, registerDock, resetEditorPages, resetEditorPagesOnLoadError, resetMetadata, saveAction, selectEditorTab, selectOverviewTab, setOriginalHash, setSelectedTab, showVersions, updateSource, verifyEventIdentifier

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

addDownloadMenuItem, disableMenuItem, downloadMenuItem, enableMenuItem, getBeforeSaveAndRenameCommand, getCopyServiceCaller, getCopyValidator, getDeleteServiceCaller, getMenus, getPathSupplier, getRenameServiceCaller, getSaveAndRenameCommandBuilder, getSaveValidator, getTitle, getValidateCommand, getVersionRecordManager, init, isDirty, isDirtySupplier, onAfterValidate, onBeforeValidate, onRename, onRestore, onSuccess, reload, setMetadataOriginalHash, showConcurrentUpdatePopup

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProjectDiagramEditor

public AbstractProjectDiagramEditor(AbstractProjectDiagramEditor.View view,
                                    org.uberfire.ext.widgets.core.client.editors.texteditor.TextEditorView xmlEditorView,
                                    org.jboss.errai.ioc.client.api.ManagedInstance<SessionEditorPresenter<EditorSession>> editorSessionPresenterInstances,
                                    org.jboss.errai.ioc.client.api.ManagedInstance<SessionViewerPresenter<ViewerSession>> viewerSessionPresenterInstances,
                                    javax.enterprise.event.Event<OnDiagramFocusEvent> onDiagramFocusEvent,
                                    javax.enterprise.event.Event<OnDiagramLoseFocusEvent> onDiagramLostFocusEvent,
                                    javax.enterprise.event.Event<org.uberfire.workbench.events.NotificationEvent> notificationEvent,
                                    org.uberfire.client.workbench.widgets.common.ErrorPopupPresenter errorPopupPresenter,
                                    DiagramClientErrorHandler diagramClientErrorHandler,
                                    DocumentationView documentationView,
                                    R resourceType,
                                    AbstractDiagramEditorMenuSessionItems<?> menuSessionItems,
                                    ProjectMessagesListener projectMessagesListener,
                                    ClientTranslationService translationService,
                                    ClientProjectDiagramService projectDiagramServices,
                                    org.jboss.errai.common.client.api.Caller<ProjectDiagramResourceService> projectDiagramResourceServiceCaller)

Method Detail

getDiagramParsingErrorMessage

protected String getDiagramParsingErrorMessage(DiagramParsingException e)

makeCore

protected AbstractProjectDiagramEditorCore<ProjectMetadata,ProjectDiagram,ProjectDiagramResource,ProjectDiagramEditorProxy<ProjectDiagramResource>> makeCore(AbstractProjectDiagramEditor.View view,
                                                                                                                                                             org.uberfire.ext.widgets.core.client.editors.texteditor.TextEditorView xmlEditorView,
                                                                                                                                                             javax.enterprise.event.Event<org.uberfire.workbench.events.NotificationEvent> notificationEvent,
                                                                                                                                                             org.jboss.errai.ioc.client.api.ManagedInstance<SessionEditorPresenter<EditorSession>> editorSessionPresenterInstances,
                                                                                                                                                             org.jboss.errai.ioc.client.api.ManagedInstance<SessionViewerPresenter<ViewerSession>> viewerSessionPresenterInstances,
                                                                                                                                                             AbstractDiagramEditorMenuSessionItems<?> menuSessionItems,
                                                                                                                                                             org.uberfire.client.workbench.widgets.common.ErrorPopupPresenter errorPopupPresenter,
                                                                                                                                                             DiagramClientErrorHandler diagramClientErrorHandler,
                                                                                                                                                             ClientTranslationService translationService)

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<ProjectDiagramResource,org.guvnor.common.services.shared.metadata.model.Metadata>

isReadOnly

protected boolean isReadOnly()

onValidate

protected void onValidate(org.uberfire.mvp.Command finished)

Overrides:

onValidate in class org.uberfire.ext.editor.commons.client.BaseEditor<ProjectDiagramResource,org.guvnor.common.services.shared.metadata.model.Metadata>

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<ProjectDiagramResource>

doSave

protected void doSave(org.uberfire.mvp.Command continueSaveOnceValid)

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<ProjectDiagramResource>

Parameters:

commitMessage - The commit's message.

doSave

protected void doSave(String commitMessage)

getSaveSuccessCallback

public org.jboss.errai.common.client.api.RemoteCallback<org.uberfire.backend.vfs.Path> getSaveSuccessCallback(int newHash)

Overrides:

getSaveSuccessCallback in class org.uberfire.ext.editor.commons.client.BaseEditor<ProjectDiagramResource,org.guvnor.common.services.shared.metadata.model.Metadata>

hideDocks

public void hideDocks()

Overrides:

hideDocks in class KieEditor<ProjectDiagramResource>

showDocks

public void showDocks()

Overrides:

showDocks in class KieEditor<ProjectDiagramResource>

getEditorIdentifier

public abstract String getEditorIdentifier()

Specified by:

getEditorIdentifier in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

Specified by:

getEditorIdentifier in class KieEditor<ProjectDiagramResource>

makeMenuBar

protected elemental2.promise.Promise<Void> makeMenuBar()

Overrides:

makeMenuBar in class KieEditor<ProjectDiagramResource>

getSaveAndRename

protected org.uberfire.mvp.Command getSaveAndRename()

Overrides:

getSaveAndRename in class org.uberfire.ext.editor.commons.client.BaseEditor<ProjectDiagramResource,org.guvnor.common.services.shared.metadata.model.Metadata>

getSaveAndRenameServiceCaller

protected org.jboss.errai.common.client.api.Caller<? extends org.uberfire.ext.editor.commons.service.support.SupportsSaveAndRename<ProjectDiagramResource,org.guvnor.common.services.shared.metadata.model.Metadata>> getSaveAndRenameServiceCaller()

Overrides:

getSaveAndRenameServiceCaller in class org.uberfire.ext.editor.commons.client.BaseEditor<ProjectDiagramResource,org.guvnor.common.services.shared.metadata.model.Metadata>

getContentSupplier

protected Supplier<ProjectDiagramResource> getContentSupplier()

Overrides:

getContentSupplier in class org.uberfire.ext.editor.commons.client.BaseEditor<ProjectDiagramResource,org.guvnor.common.services.shared.metadata.model.Metadata>

getCurrentContentHash

protected Integer getCurrentContentHash()

Overrides:

getCurrentContentHash in class org.uberfire.ext.editor.commons.client.BaseEditor<ProjectDiagramResource,org.guvnor.common.services.shared.metadata.model.Metadata>

doOpen

protected void doOpen()

doClose

protected void doClose()

showLoadingViews

protected void showLoadingViews()

showSavingViews

protected void showSavingViews()

hideLoadingViews

protected void hideLoadingViews()

isSameSession

protected boolean isSameSession(ClientSession other)

getTitleText

public String getTitleText()

Overrides:

getTitleText in class org.uberfire.ext.editor.commons.client.BaseEditor<ProjectDiagramResource,org.guvnor.common.services.shared.metadata.model.Metadata>

onSave

protected void onSave()

Overrides:

onSave in class KieEditor<ProjectDiagramResource>

updateTitle

protected void updateTitle(String title)

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

getView

protected AbstractProjectDiagramEditor.View getView()

onSaveSuccess

protected void onSaveSuccess()

open

public void open(ProjectDiagram diagram,
                 Viewer.Callback callback)

Specified by:

open in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

getDockQualifiers

public Annotation[] getDockQualifiers()

Specified by:

getDockQualifiers in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

initialiseKieEditorForSession

public void initialiseKieEditorForSession(ProjectDiagram diagram)

Specified by:

initialiseKieEditorForSession in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

destroySession

protected void destroySession()

addDocumentationPage

public void addDocumentationPage(ProjectDiagram diagram)

onDiagramLoad

protected void onDiagramLoad()

newSessionEditorPresenter

public SessionEditorPresenter<EditorSession> newSessionEditorPresenter()

Specified by:

newSessionEditorPresenter in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

newSessionViewerPresenter

public SessionViewerPresenter<ViewerSession> newSessionViewerPresenter()

Specified by:

newSessionViewerPresenter in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

getCurrentDiagramHash

public int getCurrentDiagramHash()

Specified by:

getCurrentDiagramHash in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

getCanvasHandler

public CanvasHandler getCanvasHandler()

Specified by:

getCanvasHandler in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

onSaveError

public void onSaveError(ClientRuntimeError error)

Specified by:

onSaveError in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

getSessionPresenter

public SessionPresenter<? extends ClientSession,?,Diagram> getSessionPresenter()

Specified by:

getSessionPresenter in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

doFocus

public void doFocus()

Specified by:

doFocus in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

doLostFocus

public void doLostFocus()

Specified by:

doLostFocus in interface DiagramEditorCore<ProjectMetadata,ProjectDiagram>

log

protected void log(Level level,
                   String message)

hasUnsavedChanges

protected boolean hasUnsavedChanges()

getTranslationService

protected ClientTranslationService getTranslationService()

makeAdditionalStunnerMenus

protected void makeAdditionalStunnerMenus(FileMenuBuilder fileMenuBuilder)

getMenuSessionItems

public AbstractDiagramEditorMenuSessionItems getMenuSessionItems()