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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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, javax.enterprise.event.Event<OnDiagramFocusEvent> onDiagramFocusEvent, javax.enterprise.event.Event<OnDiagramLoseFocusEvent> onDiagramLostFocusEvent, DocumentationView documentationView, R resourceType, AbstractDiagramEditorMenuSessionItems<?> menuSessionItems, ProjectMessagesListener projectMessagesListener, ClientTranslationService translationService, ClientProjectDiagramService projectDiagramServices, org.jboss.errai.common.client.api.Caller<ProjectDiagramResourceService> projectDiagramResourceServiceCaller, StunnerEditor stunnerEditor)

Method Summary

Modifier and Type	Method and Description
void	addDocumentationPage(ProjectDiagram diagram)
protected void	beforeOpen(ProjectDiagram diagram)
protected void	destroySession()
protected void	doClose()
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 Supplier<ProjectDiagram>	getContentSupplier()
protected Integer	getCurrentContentHash()
protected 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<ProjectDiagram,org.guvnor.common.services.shared.metadata.model.Metadata>>	getSaveAndRenameServiceCaller()
org.jboss.errai.common.client.api.RemoteCallback<org.uberfire.backend.vfs.Path>	getSaveSuccessCallback(int newHash)
StunnerEditor	getStunnerEditor()
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	isSameSession(ClientSession other)
boolean	isSaveAllowedAfterValidationFailed(Violation.Type maxSeverity)
protected void	loadContent()
protected void	makeAdditionalStunnerMenus(FileMenuBuilder fileMenuBuilder)
protected elemental2.promise.Promise<Void>	makeMenuBar()
void	onError(ClientRuntimeError error)
protected void	onSave()
protected void	onSaveSuccess()
protected org.uberfire.mvp.ParameterizedCommand<org.uberfire.backend.vfs.Path>	onSuccess()
protected void	onValidate(org.uberfire.mvp.Command finished)
void	open(ProjectDiagram diagram)
void	open(ProjectDiagram diagram, SessionPresenter.SessionPresenterCallback callback)
protected void	save(String commitMessage)
void	setOriginalHash(Integer originalHash)
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, save, saveAction, selectEditorTab, selectOverviewTab, 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, 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,
                                    javax.enterprise.event.Event<OnDiagramFocusEvent> onDiagramFocusEvent,
                                    javax.enterprise.event.Event<OnDiagramLoseFocusEvent> onDiagramLostFocusEvent,
                                    DocumentationView documentationView,
                                    R resourceType,
                                    AbstractDiagramEditorMenuSessionItems<?> menuSessionItems,
                                    ProjectMessagesListener projectMessagesListener,
                                    ClientTranslationService translationService,
                                    ClientProjectDiagramService projectDiagramServices,
                                    org.jboss.errai.common.client.api.Caller<ProjectDiagramResourceService> projectDiagramResourceServiceCaller,
                                    StunnerEditor stunnerEditor)

Method Detail

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

open

public void open(ProjectDiagram diagram)

open

public void open(ProjectDiagram diagram,
                 SessionPresenter.SessionPresenterCallback callback)

beforeOpen

protected void beforeOpen(ProjectDiagram diagram)

initialiseKieEditorForSession

public void initialiseKieEditorForSession(ProjectDiagram diagram)

onValidate

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

Overrides:

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

isSaveAllowedAfterValidationFailed

public boolean isSaveAllowedAfterValidationFailed(Violation.Type maxSeverity)

save

protected void save(String commitMessage)

Overrides:

save in class KieEditor<ProjectDiagram>

onSave

protected void onSave()

Overrides:

onSave in class KieEditor<ProjectDiagram>

onSaveSuccess

protected void onSaveSuccess()

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

hideDocks

public void hideDocks()

Overrides:

hideDocks in class KieEditor<ProjectDiagram>

showDocks

public void showDocks()

Overrides:

showDocks in class KieEditor<ProjectDiagram>

getDockQualifiers

protected Annotation[] getDockQualifiers()

getEditorIdentifier

public abstract String getEditorIdentifier()

Specified by:

getEditorIdentifier in class KieEditor<ProjectDiagram>

makeMenuBar

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

Overrides:

makeMenuBar in class KieEditor<ProjectDiagram>

getSaveAndRename

protected org.uberfire.mvp.Command getSaveAndRename()

Overrides:

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

onSuccess

protected org.uberfire.mvp.ParameterizedCommand<org.uberfire.backend.vfs.Path> onSuccess()

Overrides:

onSuccess in class org.uberfire.ext.editor.commons.client.BaseEditor<ProjectDiagram,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<ProjectDiagram,org.guvnor.common.services.shared.metadata.model.Metadata>> getSaveAndRenameServiceCaller()

Overrides:

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

getContentSupplier

protected Supplier<ProjectDiagram> getContentSupplier()

Overrides:

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

getCurrentContentHash

protected Integer getCurrentContentHash()

Overrides:

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

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

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

destroySession

protected void destroySession()

addDocumentationPage

public void addDocumentationPage(ProjectDiagram diagram)

onError

public void onError(ClientRuntimeError error)

setOriginalHash

public void setOriginalHash(Integer originalHash)

Overrides:

setOriginalHash in class KieEditor<ProjectDiagram>

hasUnsavedChanges

protected boolean hasUnsavedChanges()

getTranslationService

protected ClientTranslationService getTranslationService()

makeAdditionalStunnerMenus

protected void makeAdditionalStunnerMenus(FileMenuBuilder fileMenuBuilder)

getMenuSessionItems

public AbstractDiagramEditorMenuSessionItems getMenuSessionItems()

getStunnerEditor

public StunnerEditor getStunnerEditor()