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

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

  • All Implemented Interfaces:
    org.kie.workbench.common.widgets.metadata.client.KieEditorWrapperView.KieEditorWrapperPresenter
    public abstract class AbstractProjectDiagramEditor<R extends org.uberfire.client.workbench.type.ClientResourceType>
extends org.kie.workbench.common.widgets.metadata.client.KieEditor<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram>

    • 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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addDocumentationPage​(org.kie.workbench.common.stunner.project.diagram.ProjectDiagram diagram)  
      protected void beforeOpen​(org.kie.workbench.common.stunner.project.diagram.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<org.kie.workbench.common.stunner.project.diagram.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<org.kie.workbench.common.stunner.project.diagram.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)  
      org.kie.workbench.common.stunner.client.widgets.editor.StunnerEditor getStunnerEditor()  
      String getTitleText()  
      protected org.kie.workbench.common.stunner.core.client.i18n.ClientTranslationService getTranslationService()  
      protected AbstractProjectDiagramEditor.View getView()  
      protected boolean hasUnsavedChanges()  
      void hideDocks()  
      protected void hideLoadingViews()  
      void init()  
      void initialiseKieEditorForSession​(org.kie.workbench.common.stunner.project.diagram.ProjectDiagram diagram)  
      protected boolean isSameSession​(org.kie.workbench.common.stunner.core.client.session.ClientSession other)  
      boolean isSaveAllowedAfterValidationFailed​(org.kie.workbench.common.stunner.core.validation.Violation.Type maxSeverity)  
      protected void loadContent()  
      protected void makeAdditionalStunnerMenus​(org.kie.workbench.common.widgets.client.menu.FileMenuBuilder fileMenuBuilder)  
      protected elemental2.promise.Promise<Void> makeMenuBar()  
      void onError​(org.kie.workbench.common.stunner.core.client.service.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​(org.kie.workbench.common.stunner.project.diagram.ProjectDiagram diagram)  
      void open​(org.kie.workbench.common.stunner.project.diagram.ProjectDiagram diagram, org.kie.workbench.common.stunner.client.widgets.presenters.session.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

    • Constructor Detail

      • AbstractProjectDiagramEditor

        public AbstractProjectDiagramEditor​(AbstractProjectDiagramEditor.View view,
                                    javax.enterprise.event.Event<OnDiagramFocusEvent> onDiagramFocusEvent,
                                    javax.enterprise.event.Event<OnDiagramLoseFocusEvent> onDiagramLostFocusEvent,
                                    org.kie.workbench.common.stunner.core.documentation.DocumentationView documentationView,
                                    R resourceType,
                                    AbstractDiagramEditorMenuSessionItems<?> menuSessionItems,
                                    ProjectMessagesListener projectMessagesListener,
                                    org.kie.workbench.common.stunner.core.client.i18n.ClientTranslationService translationService,
                                    ClientProjectDiagramService projectDiagramServices,
                                    org.jboss.errai.common.client.api.Caller<org.kie.workbench.common.stunner.project.service.ProjectDiagramResourceService> projectDiagramResourceServiceCaller,
                                    org.kie.workbench.common.stunner.client.widgets.editor.StunnerEditor stunnerEditor)

    • Method Detail

      • 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<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram,​org.guvnor.common.services.shared.metadata.model.Metadata>

      • open

        public void open​(org.kie.workbench.common.stunner.project.diagram.ProjectDiagram diagram)

      • open

        public void open​(org.kie.workbench.common.stunner.project.diagram.ProjectDiagram diagram,
                 org.kie.workbench.common.stunner.client.widgets.presenters.session.SessionPresenter.SessionPresenterCallback callback)

      • beforeOpen

        protected void beforeOpen​(org.kie.workbench.common.stunner.project.diagram.ProjectDiagram diagram)

      • initialiseKieEditorForSession

        public void initialiseKieEditorForSession​(org.kie.workbench.common.stunner.project.diagram.ProjectDiagram diagram)

      • onValidate

        protected void onValidate​(org.uberfire.mvp.Command finished)
        Overrides:
        onValidate in class org.uberfire.ext.editor.commons.client.BaseEditor<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram,​org.guvnor.common.services.shared.metadata.model.Metadata>

      • isSaveAllowedAfterValidationFailed

        public boolean isSaveAllowedAfterValidationFailed​(org.kie.workbench.common.stunner.core.validation.Violation.Type maxSeverity)

      • save

        protected void save​(String commitMessage)
        Overrides:
        save in class org.kie.workbench.common.widgets.metadata.client.KieEditor<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram>

      • onSave

        protected void onSave()
        Overrides:
        onSave in class org.kie.workbench.common.widgets.metadata.client.KieEditor<org.kie.workbench.common.stunner.project.diagram.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<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram,​org.guvnor.common.services.shared.metadata.model.Metadata>

      • hideDocks

        public void hideDocks()
        Overrides:
        hideDocks in class org.kie.workbench.common.widgets.metadata.client.KieEditor<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram>

      • showDocks

        public void showDocks()
        Overrides:
        showDocks in class org.kie.workbench.common.widgets.metadata.client.KieEditor<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram>

      • getDockQualifiers

        protected Annotation[] getDockQualifiers()

      • getEditorIdentifier

        public abstract String getEditorIdentifier()
        Specified by:
        getEditorIdentifier in class org.kie.workbench.common.widgets.metadata.client.KieEditor<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram>

      • makeMenuBar

        protected elemental2.promise.Promise<Void> makeMenuBar()
        Overrides:
        makeMenuBar in class org.kie.workbench.common.widgets.metadata.client.KieEditor<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram>

      • getSaveAndRename

        protected org.uberfire.mvp.Command getSaveAndRename()
        Overrides:
        getSaveAndRename in class org.uberfire.ext.editor.commons.client.BaseEditor<org.kie.workbench.common.stunner.project.diagram.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<org.kie.workbench.common.stunner.project.diagram.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<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram,​org.guvnor.common.services.shared.metadata.model.Metadata>> getSaveAndRenameServiceCaller()
        Overrides:
        getSaveAndRenameServiceCaller in class org.uberfire.ext.editor.commons.client.BaseEditor<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram,​org.guvnor.common.services.shared.metadata.model.Metadata>

      • getContentSupplier

        protected Supplier<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram> getContentSupplier()
        Overrides:
        getContentSupplier in class org.uberfire.ext.editor.commons.client.BaseEditor<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram,​org.guvnor.common.services.shared.metadata.model.Metadata>

      • getCurrentContentHash

        protected Integer getCurrentContentHash()
        Overrides:
        getCurrentContentHash in class org.uberfire.ext.editor.commons.client.BaseEditor<org.kie.workbench.common.stunner.project.diagram.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​(org.kie.workbench.common.stunner.core.client.session.ClientSession other)

      • getTitleText

        public String getTitleText()
        Overrides:
        getTitleText in class org.uberfire.ext.editor.commons.client.BaseEditor<org.kie.workbench.common.stunner.project.diagram.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

      • destroySession

        protected void destroySession()

      • addDocumentationPage

        public void addDocumentationPage​(org.kie.workbench.common.stunner.project.diagram.ProjectDiagram diagram)

      • onError

        public void onError​(org.kie.workbench.common.stunner.core.client.service.ClientRuntimeError error)

      • setOriginalHash

        public void setOriginalHash​(Integer originalHash)
        Overrides:
        setOriginalHash in class org.kie.workbench.common.widgets.metadata.client.KieEditor<org.kie.workbench.common.stunner.project.diagram.ProjectDiagram>

      • hasUnsavedChanges

        protected boolean hasUnsavedChanges()

      • getTranslationService

        protected org.kie.workbench.common.stunner.core.client.i18n.ClientTranslationService getTranslationService()

      • makeAdditionalStunnerMenus

        protected void makeAdditionalStunnerMenus​(org.kie.workbench.common.widgets.client.menu.FileMenuBuilder fileMenuBuilder)

      • getStunnerEditor

        public org.kie.workbench.common.stunner.client.widgets.editor.StunnerEditor getStunnerEditor()