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:

KieEditorWrapperView.KieEditorWrapperPresenter

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

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 ProjectDiagramEditorProxy	editorProxy
protected ClientProjectDiagramService	projectDiagramServices

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

alertsButtonMenuItemBuilder, 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, isValidationRunning, menuBuilder, menuBuilderManagedInstance, menuItems, menus, metadataOriginalHash, notification, originalHash, place, placeManager, saveAndRenameCommandBuilder, 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, org.jboss.errai.ioc.client.api.ManagedInstance<SessionEditorPresenter<EditorSession>> editorSessionPresenterInstances, org.jboss.errai.ioc.client.api.ManagedInstance<SessionViewerPresenter<ViewerSession>> viewerSessionPresenterInstances, AbstractProjectEditorMenuSessionItems<?> menuSessionItems, javax.enterprise.event.Event<OnDiagramFocusEvent> onDiagramFocusEvent, javax.enterprise.event.Event<OnDiagramLoseFocusEvent> onDiagramLostFocusEvent, ProjectMessagesListener projectMessagesListener, DiagramClientErrorHandler diagramClientErrorHandler, ClientTranslationService translationService, org.uberfire.ext.widgets.core.client.editors.texteditor.TextEditorView xmlEditorView, org.jboss.errai.common.client.api.Caller<ProjectDiagramResourceService> projectDiagramResourceServiceCaller)

Method Summary

Modifier and Type	Method and Description
protected void	destroySession()
protected void	doClose()
protected void	doFocus()
protected void	doLostFocus()
protected void	doOpen()
protected void	doSave(org.uberfire.mvp.Command continueSaveOnceValid)
protected void	doSave(String commitMessage)
protected void	doShowNoChangesSinceLastSaveMessage(String message)
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 Supplier<ProjectDiagramResource>	getContentSupplier()
protected Integer	getCurrentContentHash()
protected int	getCurrentDiagramHash()
protected ProjectDiagram	getDiagram()
protected abstract String	getEditorIdentifier()
protected ProjectDiagramEditorProxy	getEditorProxy()
protected org.uberfire.workbench.model.menu.Menus	getMenus()
AbstractProjectEditorMenuSessionItems	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	hideDiagramEditorDocks(org.uberfire.client.workbench.events.PlaceHiddenEvent event)
protected void	hideLoadingViews()
void	init()
protected 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 void	makeMenuBar()
protected ProjectDiagramEditorProxy	makeStunnerEditorProxy()
protected ProjectDiagramEditorProxy	makeXmlEditorProxy()
protected SessionEditorPresenter<EditorSession>	newSessionEditorPresenter()
protected SessionViewerPresenter<ViewerSession>	newSessionViewerPresenter()
protected void	onDiagramLoad()
protected void	onLoadError(ClientRuntimeError error)
protected void	onSave()
protected void	onSaveError(ClientRuntimeError error)
protected void	onSaveSuccess()
protected void	onValidate(org.uberfire.mvp.Command finished)
protected void	onValidationFailed(Collection<DiagramElementViolation<RuleViolation>> violations)
void	open(ProjectDiagram diagram)
protected void	openReadOnlySession(ProjectDiagram diagram)
protected void	openSession(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.
protected void	setEditorSessionPresenter(SessionEditorPresenter<EditorSession> presenter)
protected void	setReadOnlySessionPresenter(SessionViewerPresenter<ViewerSession> presenter)
void	showDiagramEditorDocks(org.uberfire.client.workbench.events.PlaceGainFocusEvent event)
protected void	showError(ClientRuntimeError error)
protected void	showError(String message)
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, buildMenuBar, canUpdateProject, createOriginalHash, getCouldNotGenerateSourceErrorCallback, getMetadataSupplier, getNoSuchFileExceptionErrorCallback, getRenameValidator, 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

addDownloadMenuItem, downloadMenuItem, getCopyServiceCaller, getCopyValidator, getDeleteServiceCaller, getPathSupplier, getRenameServiceCaller, getSaveAndRenameCommandBuilder, 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

Field Detail

projectDiagramServices

protected ClientProjectDiagramService projectDiagramServices

editorProxy

protected ProjectDiagramEditorProxy editorProxy

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,
                                            org.jboss.errai.ioc.client.api.ManagedInstance<SessionEditorPresenter<EditorSession>> editorSessionPresenterInstances,
                                            org.jboss.errai.ioc.client.api.ManagedInstance<SessionViewerPresenter<ViewerSession>> viewerSessionPresenterInstances,
                                            AbstractProjectEditorMenuSessionItems<?> menuSessionItems,
                                            javax.enterprise.event.Event<OnDiagramFocusEvent> onDiagramFocusEvent,
                                            javax.enterprise.event.Event<OnDiagramLoseFocusEvent> onDiagramLostFocusEvent,
                                            ProjectMessagesListener projectMessagesListener,
                                            DiagramClientErrorHandler diagramClientErrorHandler,
                                            ClientTranslationService translationService,
                                            org.uberfire.ext.widgets.core.client.editors.texteditor.TextEditorView xmlEditorView,
                                            org.jboss.errai.common.client.api.Caller<ProjectDiagramResourceService> projectDiagramResourceServiceCaller)

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

open

public void open(ProjectDiagram diagram)

makeStunnerEditorProxy

protected ProjectDiagramEditorProxy makeStunnerEditorProxy()

makeXmlEditorProxy

protected ProjectDiagramEditorProxy makeXmlEditorProxy()

isReadOnly

protected boolean isReadOnly()

openSession

protected void openSession(ProjectDiagram diagram)

openReadOnlySession

protected void openReadOnlySession(ProjectDiagram diagram)

initialiseKieEditorForSession

protected void initialiseKieEditorForSession(ProjectDiagram diagram)

onDiagramLoad

protected void onDiagramLoad()

newSessionEditorPresenter

protected SessionEditorPresenter<EditorSession> newSessionEditorPresenter()

newSessionViewerPresenter

protected SessionViewerPresenter<ViewerSession> newSessionViewerPresenter()

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>

hideDiagramEditorDocks

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

showDiagramEditorDocks

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

makeMenuBar

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

getEditorProxy

protected ProjectDiagramEditorProxy getEditorProxy()

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()

doFocus

protected void doFocus()

doLostFocus

protected void doLostFocus()

doClose

protected void doClose()

showLoadingViews

protected void showLoadingViews()

showSavingViews

protected void showSavingViews()

hideLoadingViews

protected void hideLoadingViews()

isSameSession

protected boolean isSameSession(ClientSession other)

getEditorIdentifier

protected abstract String getEditorIdentifier()

getTitleText

public String getTitleText()

Overrides:

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

getMenus

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

onSave

protected void onSave()

Overrides:

onSave in class KieEditor<ProjectDiagramResource>

doShowNoChangesSinceLastSaveMessage

protected void doShowNoChangesSinceLastSaveMessage(String message)

destroySession

protected void destroySession()

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

getCurrentDiagramHash

protected int getCurrentDiagramHash()

getCanvasHandler

protected CanvasHandler getCanvasHandler()

getDiagram

protected ProjectDiagram getDiagram()

getView

protected AbstractProjectDiagramEditor.View getView()

onSaveSuccess

protected void onSaveSuccess()

onSaveError

protected void onSaveError(ClientRuntimeError error)

onValidationFailed

protected void onValidationFailed(Collection<DiagramElementViolation<RuleViolation>> violations)

onLoadError

protected void onLoadError(ClientRuntimeError error)

showError

protected void showError(ClientRuntimeError error)

showError

protected void showError(String message)

log

protected void log(Level level,
                   String message)

hasUnsavedChanges

protected boolean hasUnsavedChanges()

getTranslationService

protected ClientTranslationService getTranslationService()

makeAdditionalStunnerMenus

protected void makeAdditionalStunnerMenus(FileMenuBuilder fileMenuBuilder)

getSessionPresenter

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

getMenuSessionItems

public AbstractProjectEditorMenuSessionItems getMenuSessionItems()

setEditorSessionPresenter

protected void setEditorSessionPresenter(SessionEditorPresenter<EditorSession> presenter)

setReadOnlySessionPresenter

protected void setReadOnlySessionPresenter(SessionViewerPresenter<ViewerSession> presenter)