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 and Description
protected BaseEditorView	baseView
protected javax.enterprise.event.Event<ChangeTitleWidgetEvent>	changeTitleNotification
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 ObservablePath.OnConcurrentUpdateEvent	concurrentUpdateSessionInfo
protected DefaultFileNameValidator	fileNameValidator
protected boolean	isReadOnly
protected boolean	isValidationRunning
protected BasicFileMenuBuilder	menuBuilder
protected org.jboss.errai.ioc.client.api.ManagedInstance<BasicFileMenuBuilder>	menuBuilderManagedInstance
protected Set<MenuItems>	menuItems
protected Menus	menus
protected Integer	metadataOriginalHash
protected javax.enterprise.event.Event<NotificationEvent>	notification
protected Integer	originalHash
protected PlaceRequest	place
protected PlaceManager	placeManager
protected SaveAndRenameCommandBuilder<T,M>	saveAndRenameCommandBuilder
protected ClientResourceType	type
protected VersionRecordManager	versionRecordManager

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 MenuItem	downloadMenuItem()
void	enableMenuItem(MenuItems menuItem)
protected Supplier<T>	getContentSupplier()
protected org.jboss.errai.common.client.api.Caller<? extends SupportsCopy>	getCopyServiceCaller()
Validator	getCopyValidator()
protected Integer	getCurrentContentHash()
protected org.jboss.errai.common.client.api.Caller<? extends SupportsDelete>	getDeleteServiceCaller()
protected Supplier<M>	getMetadataSupplier()
protected Supplier<Path>	getPathSupplier()
protected org.jboss.errai.common.client.api.Caller<? extends SupportsRename>	getRenameServiceCaller()
Validator	getRenameValidator()
protected Command	getSaveAndRename()
protected SaveAndRenameCommandBuilder<T,M>	getSaveAndRenameCommandBuilder()
protected org.jboss.errai.common.client.api.Caller<? extends SupportsSaveAndRename<T,M>>	getSaveAndRenameServiceCaller()
org.jboss.errai.common.client.api.RemoteCallback<Path>	getSaveSuccessCallback(int newHash)
protected com.google.gwt.user.client.ui.IsWidget	getTitle() Override this method and use @WorkbenchPartTitleDecoration
String	getTitleText()
Command	getValidateCommand()
VersionRecordManager	getVersionRecordManager()
protected void	init(ObservablePath path, PlaceRequest place, ClientResourceType type, boolean addFileChangeListeners, boolean displayShowMoreVersions, Collection<MenuItems> menuItems)
protected void	init(ObservablePath path, PlaceRequest place, ClientResourceType type, boolean addFileChangeListeners, boolean displayShowMoreVersions, MenuItems... menuItems)
protected void	init(ObservablePath path, PlaceRequest place, ClientResourceType type, MenuItems... menuItems)
boolean	isDirty(Integer currentHash)
protected Supplier<Boolean>	isDirtySupplier()
protected abstract void	loadContent()
protected 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(RestoreEvent restore)
protected void	onSave()
protected ParameterizedCommand<Path>	onSuccess()
protected void	onValidate(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 ObservablePath.OnConcurrentUpdateEvent concurrentUpdateSessionInfo

menus

protected Menus menus

placeManager

@Inject
protected PlaceManager placeManager

changeTitleNotification

@Inject
protected javax.enterprise.event.Event<ChangeTitleWidgetEvent> changeTitleNotification

notification

@Inject
protected javax.enterprise.event.Event<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

menuItems

protected Set<MenuItems> menuItems

place

protected PlaceRequest place

type

protected 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(ObservablePath path,
                    PlaceRequest place,
                    ClientResourceType type,
                    MenuItems... menuItems)

init

protected void init(ObservablePath path,
                    PlaceRequest place,
                    ClientResourceType type,
                    boolean addFileChangeListeners,
                    boolean displayShowMoreVersions,
                    MenuItems... menuItems)

init

protected void init(ObservablePath path,
                    PlaceRequest place,
                    ClientResourceType type,
                    boolean addFileChangeListeners,
                    boolean displayShowMoreVersions,
                    Collection<MenuItems> menuItems)

showVersions

protected void showVersions()

makeMenuBar

protected void makeMenuBar()

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

addDownloadMenuItem

protected void addDownloadMenuItem(BasicFileMenuBuilder menuBuilder)

downloadMenuItem

protected MenuItem downloadMenuItem()

getSaveAndRename

protected Command getSaveAndRename()

onSuccess

protected ParameterizedCommand<Path> onSuccess()

getSaveAndRenameCommandBuilder

protected SaveAndRenameCommandBuilder<T,M> getSaveAndRenameCommandBuilder()

getPathSupplier

protected Supplier<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<Path> getSaveSuccessCallback(int newHash)

onRestore

public void onRestore(@Observes
                      RestoreEvent restore)

reload

public void reload()

disableMenuItem

public void disableMenuItem(MenuItems menuItem)

enableMenuItem

public void enableMenuItem(MenuItems menuItem)

getValidateCommand

public Command getValidateCommand()

onBeforeValidate

protected void onBeforeValidate()

onAfterValidate

protected void onAfterValidate()

onValidate

protected void onValidate(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 SupportsDelete> getDeleteServiceCaller()

getRenameServiceCaller

protected org.jboss.errai.common.client.api.Caller<? extends SupportsRename> getRenameServiceCaller()

getSaveAndRenameServiceCaller

protected org.jboss.errai.common.client.api.Caller<? extends SupportsSaveAndRename<T,M>> getSaveAndRenameServiceCaller()

getCopyServiceCaller

protected org.jboss.errai.common.client.api.Caller<? extends SupportsCopy> getCopyServiceCaller()

mayClose

public boolean mayClose(Integer currentHash)

isDirty

public boolean isDirty(Integer currentHash)

getVersionRecordManager

public VersionRecordManager getVersionRecordManager()

setMetadataOriginalHash

public void setMetadataOriginalHash(Integer metadataOriginalHash)