Package org.uberfire.ext.editor.commons.client

Class BaseEditor<T,M>

java.lang.Object

org.uberfire.ext.editor.commons.client.BaseEditor<T,M>

Direct Known Subclasses:

HtmlEditor

public abstract class BaseEditor<T,M>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseEditorView	baseView
protected javax.enterprise.event.Event<org.uberfire.client.workbench.events.ChangeTitleWidgetEvent>	changeTitleNotification
protected org.uberfire.ext.widgets.common.client.common.ConcurrentChangePopup	concurrentChangePopup
protected javax.enterprise.event.Event<ConcurrentDeleteAcceptedEvent>	concurrentDeleteAcceptedEvent
protected javax.enterprise.event.Event<ConcurrentDeleteIgnoredEvent>	concurrentDeleteIgnoredEvent
protected javax.enterprise.event.Event<ConcurrentRenameAcceptedEvent>	concurrentRenameAcceptedEvent
protected javax.enterprise.event.Event<ConcurrentRenameIgnoredEvent>	concurrentRenameIgnoredEvent
protected org.uberfire.backend.vfs.ObservablePath.OnConcurrentUpdateEvent	concurrentUpdateSessionInfo
protected DeletePopUpPresenter	deletePopUpPresenter
protected DefaultFileNameValidator	fileNameValidator
protected boolean	isReadOnly
protected boolean	isValidationRunning
protected elemental2.promise.Promise<Void>	makeMenuBarPromise
protected BasicFileMenuBuilder	menuBuilder
protected org.jboss.errai.ioc.client.api.ManagedInstance<BasicFileMenuBuilder>	menuBuilderManagedInstance
protected Set<MenuItems>	menuItems
protected org.uberfire.workbench.model.menu.Menus	menus
protected Integer	metadataOriginalHash
protected javax.enterprise.event.Event<org.uberfire.workbench.events.NotificationEvent>	notification
protected Integer	originalHash
protected org.uberfire.mvp.PlaceRequest	place
protected org.uberfire.client.mvp.PlaceManager	placeManager
protected org.uberfire.client.promise.Promises	promises
protected SaveAndRenameCommandBuilder<T,M>	saveAndRenameCommandBuilder
protected boolean	saveWithComments
protected org.uberfire.client.workbench.type.ClientResourceType	type
protected VersionRecordManager	versionRecordManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseEditor()
protected	BaseEditor(BaseEditorView baseView)

Method Summary

Modifier and Type	Method	Description
protected void	addDownloadMenuItem(BasicFileMenuBuilder menuBuilder)
protected void	buildMenuBar()	If you want to customize the menu construction override this method.
void	disableMenuItem(MenuItems menuItem)
protected org.uberfire.workbench.model.menu.MenuItem	downloadMenuItem()
void	enableMenuItem(MenuItems menuItem)
protected org.uberfire.mvp.Command	getBeforeSaveAndRenameCommand()
protected Supplier<T>	getContentSupplier()
protected org.jboss.errai.common.client.api.Caller<? extends org.uberfire.ext.editor.commons.service.support.SupportsCopy>	getCopyServiceCaller()
Validator	getCopyValidator()
protected Integer	getCurrentContentHash()
protected org.jboss.errai.common.client.api.Caller<? extends org.uberfire.ext.editor.commons.service.support.SupportsDelete>	getDeleteServiceCaller()
void	getMenus(Consumer<org.uberfire.workbench.model.menu.Menus> menusConsumer)
protected Supplier<M>	getMetadataSupplier()
protected Supplier<org.uberfire.backend.vfs.Path>	getPathSupplier()
protected org.jboss.errai.common.client.api.Caller<? extends org.uberfire.ext.editor.commons.service.support.SupportsRename>	getRenameServiceCaller()
Validator	getRenameValidator()
protected org.uberfire.mvp.Command	getSaveAndRename()
protected SaveAndRenameCommandBuilder<T,M>	getSaveAndRenameCommandBuilder()
protected org.jboss.errai.common.client.api.Caller<? extends org.uberfire.ext.editor.commons.service.support.SupportsSaveAndRename<T,M>>	getSaveAndRenameServiceCaller()
org.jboss.errai.common.client.api.RemoteCallback<org.uberfire.backend.vfs.Path>	getSaveSuccessCallback(int newHash)
protected Supplier<Boolean>	getSaveValidator()
protected com.google.gwt.user.client.ui.IsWidget	getTitle()	Override this method and use @WorkbenchPartTitleDecoration
String	getTitleText()
org.uberfire.mvp.Command	getValidateCommand()
VersionRecordManager	getVersionRecordManager()
protected void	init(org.uberfire.backend.vfs.ObservablePath path, org.uberfire.mvp.PlaceRequest place, org.uberfire.client.workbench.type.ClientResourceType type, boolean addFileChangeListeners, boolean displayShowMoreVersions, Collection<MenuItems> menuItems)
protected void	init(org.uberfire.backend.vfs.ObservablePath path, org.uberfire.mvp.PlaceRequest place, org.uberfire.client.workbench.type.ClientResourceType type, boolean addFileChangeListeners, boolean displayShowMoreVersions, MenuItems... menuItems)
protected void	init(org.uberfire.backend.vfs.ObservablePath path, org.uberfire.mvp.PlaceRequest place, org.uberfire.client.workbench.type.ClientResourceType type, MenuItems... menuItems)
boolean	isDirty(Integer currentHash)
protected Supplier<Boolean>	isDirtySupplier()
protected abstract void	loadContent()
protected elemental2.promise.Promise<Void>	makeMenuBar()	If you want to customize the menu content override this method.
boolean	mayClose(Integer currentHash)
protected void	onAfterValidate()
protected void	onBeforeValidate()
protected void	onRename()
void	onRestore(org.uberfire.ext.editor.commons.version.events.RestoreEvent restore)
protected void	onSave()
protected org.uberfire.mvp.ParameterizedCommand<org.uberfire.backend.vfs.Path>	onSuccess()
protected void	onValidate(org.uberfire.mvp.Command finished)	If your editor has validation, overwrite this.
void	reload()
protected void	save()	Needs to be overwritten for save to work
void	setMetadataOriginalHash(Integer metadataOriginalHash)
void	setOriginalHash(Integer originalHash)
protected void	showConcurrentUpdatePopup()
protected void	showVersions()

Methods inherited from class java.lang.Object

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

Field Detail

isReadOnly

protected boolean isReadOnly

baseView

protected BaseEditorView baseView

concurrentUpdateSessionInfo

protected org.uberfire.backend.vfs.ObservablePath.OnConcurrentUpdateEvent concurrentUpdateSessionInfo

menus

protected org.uberfire.workbench.model.menu.Menus menus

makeMenuBarPromise

protected elemental2.promise.Promise<Void> makeMenuBarPromise

saveWithComments

protected boolean saveWithComments

placeManager

@Inject
protected org.uberfire.client.mvp.PlaceManager placeManager

changeTitleNotification

@Inject
protected javax.enterprise.event.Event<org.uberfire.client.workbench.events.ChangeTitleWidgetEvent> changeTitleNotification

notification

@Inject
protected javax.enterprise.event.Event<org.uberfire.workbench.events.NotificationEvent> notification

versionRecordManager

@Inject
protected VersionRecordManager versionRecordManager

menuBuilderManagedInstance

@Inject
protected org.jboss.errai.ioc.client.api.ManagedInstance<BasicFileMenuBuilder> menuBuilderManagedInstance

menuBuilder

@Inject
protected BasicFileMenuBuilder menuBuilder

fileNameValidator

@Inject
protected DefaultFileNameValidator fileNameValidator

saveAndRenameCommandBuilder

@Inject
protected SaveAndRenameCommandBuilder<T,M> saveAndRenameCommandBuilder

concurrentDeleteAcceptedEvent

@Inject
protected javax.enterprise.event.Event<ConcurrentDeleteAcceptedEvent> concurrentDeleteAcceptedEvent

concurrentDeleteIgnoredEvent

@Inject
protected javax.enterprise.event.Event<ConcurrentDeleteIgnoredEvent> concurrentDeleteIgnoredEvent

concurrentRenameAcceptedEvent

@Inject
protected javax.enterprise.event.Event<ConcurrentRenameAcceptedEvent> concurrentRenameAcceptedEvent

concurrentRenameIgnoredEvent

@Inject
protected javax.enterprise.event.Event<ConcurrentRenameIgnoredEvent> concurrentRenameIgnoredEvent

promises

@Inject
protected org.uberfire.client.promise.Promises promises

deletePopUpPresenter

@Inject
protected DeletePopUpPresenter deletePopUpPresenter

concurrentChangePopup

protected org.uberfire.ext.widgets.common.client.common.ConcurrentChangePopup concurrentChangePopup

menuItems

protected Set<MenuItems> menuItems

place

protected org.uberfire.mvp.PlaceRequest place

type

protected org.uberfire.client.workbench.type.ClientResourceType type

originalHash

protected Integer originalHash

metadataOriginalHash

protected Integer metadataOriginalHash

isValidationRunning

protected boolean isValidationRunning

Constructor Detail

BaseEditor

protected BaseEditor()

BaseEditor

protected BaseEditor(BaseEditorView baseView)

Method Detail

init

protected void init(org.uberfire.backend.vfs.ObservablePath path,
                    org.uberfire.mvp.PlaceRequest place,
                    org.uberfire.client.workbench.type.ClientResourceType type,
                    MenuItems... menuItems)

init

protected void init(org.uberfire.backend.vfs.ObservablePath path,
                    org.uberfire.mvp.PlaceRequest place,
                    org.uberfire.client.workbench.type.ClientResourceType type,
                    boolean addFileChangeListeners,
                    boolean displayShowMoreVersions,
                    MenuItems... menuItems)

init

protected void init(org.uberfire.backend.vfs.ObservablePath path,
                    org.uberfire.mvp.PlaceRequest place,
                    org.uberfire.client.workbench.type.ClientResourceType type,
                    boolean addFileChangeListeners,
                    boolean displayShowMoreVersions,
                    Collection<MenuItems> menuItems)

showVersions

protected void showVersions()

makeMenuBar

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

If you want to customize the menu content override this method.

addDownloadMenuItem

protected void addDownloadMenuItem(BasicFileMenuBuilder menuBuilder)

downloadMenuItem

protected org.uberfire.workbench.model.menu.MenuItem downloadMenuItem()

getSaveAndRename

protected org.uberfire.mvp.Command getSaveAndRename()

getBeforeSaveAndRenameCommand

protected org.uberfire.mvp.Command getBeforeSaveAndRenameCommand()

getSaveValidator

protected Supplier<Boolean> getSaveValidator()

onSuccess

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

getSaveAndRenameCommandBuilder

protected SaveAndRenameCommandBuilder<T,M> getSaveAndRenameCommandBuilder()

getPathSupplier

protected Supplier<org.uberfire.backend.vfs.Path> getPathSupplier()

buildMenuBar

protected void buildMenuBar()

If you want to customize the menu construction override this method. makeMenuBar() should be used to add items to the BasicFileMenuBuilder. This method then instructs BasicFileMenuBuilder.build() to create the Menus

getRenameValidator

public Validator getRenameValidator()

getCopyValidator

public Validator getCopyValidator()

setOriginalHash

public void setOriginalHash(Integer originalHash)

onRename

protected void onRename()

getTitle

protected com.google.gwt.user.client.ui.IsWidget getTitle()

Override this method and use @WorkbenchPartTitleDecoration

Returns:

The widget for the title

getTitleText

public String getTitleText()

onSave

protected void onSave()

showConcurrentUpdatePopup

protected void showConcurrentUpdatePopup()

getSaveSuccessCallback

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

onRestore

public void onRestore(@Observes
                      org.uberfire.ext.editor.commons.version.events.RestoreEvent restore)

reload

public void reload()

disableMenuItem

public void disableMenuItem(MenuItems menuItem)

enableMenuItem

public void enableMenuItem(MenuItems menuItem)

getMenus

public void getMenus(Consumer<org.uberfire.workbench.model.menu.Menus> menusConsumer)

getValidateCommand

public org.uberfire.mvp.Command getValidateCommand()

onBeforeValidate

protected void onBeforeValidate()

onAfterValidate

protected void onAfterValidate()

onValidate

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

If your editor has validation, overwrite this.

Parameters:

finished - Called when validation is finished.

loadContent

protected abstract void loadContent()

getContentSupplier

protected Supplier<T> getContentSupplier()

isDirtySupplier

protected Supplier<Boolean> isDirtySupplier()

getCurrentContentHash

protected Integer getCurrentContentHash()

getMetadataSupplier

protected Supplier<M> getMetadataSupplier()

save

protected void save()

Needs to be overwritten for save to work

getDeleteServiceCaller

protected org.jboss.errai.common.client.api.Caller<? extends org.uberfire.ext.editor.commons.service.support.SupportsDelete> getDeleteServiceCaller()

getRenameServiceCaller

protected org.jboss.errai.common.client.api.Caller<? extends org.uberfire.ext.editor.commons.service.support.SupportsRename> getRenameServiceCaller()

getSaveAndRenameServiceCaller

protected org.jboss.errai.common.client.api.Caller<? extends org.uberfire.ext.editor.commons.service.support.SupportsSaveAndRename<T,M>> getSaveAndRenameServiceCaller()

getCopyServiceCaller

protected org.jboss.errai.common.client.api.Caller<? extends org.uberfire.ext.editor.commons.service.support.SupportsCopy> getCopyServiceCaller()

mayClose

public boolean mayClose(Integer currentHash)

isDirty

public boolean isDirty(Integer currentHash)

getVersionRecordManager

public VersionRecordManager getVersionRecordManager()

setMetadataOriginalHash

public void setMetadataOriginalHash(Integer metadataOriginalHash)