org.uberfire.ext.editor.commons.client

Class BaseEditor

java.lang.Object

org.uberfire.ext.editor.commons.client.BaseEditor

Direct Known Subclasses:

HtmlEditor

public abstract class BaseEditor
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 BasicFileMenuBuilder	menuBuilder
protected Set<MenuItems>	menuItems
protected Menus	menus
protected javax.enterprise.event.Event<NotificationEvent>	notification
protected Integer	originalHash
protected PlaceRequest	place
protected PlaceManager	placeManager
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 org.jboss.errai.common.client.api.Caller<? extends SupportsCopy>	getCopyServiceCaller()
Validator	getCopyValidator()
protected org.jboss.errai.common.client.api.Caller<? extends SupportsDelete>	getDeleteServiceCaller()
protected org.jboss.errai.common.client.api.Caller<? extends SupportsRename>	getRenameServiceCaller()
Validator	getRenameValidator()
protected 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()
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 abstract void	loadContent()
protected void	makeMenuBar() If you want to customize the menu override this method.
boolean	mayClose(Integer currentHash)
protected void	onRename() Effectively the same as reload() but don't reset concurrentUpdateSessionInfo
void	onRestore(RestoreEvent restore)
protected void	onSave()
protected Command	onValidate() If your editor has validation, overwrite this.
void	reload()
protected void	save() Needs to be overwritten for save to work
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

menuBuilder

@Inject
protected BasicFileMenuBuilder menuBuilder

fileNameValidator

@Inject
protected DefaultFileNameValidator fileNameValidator

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

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 override this method.

getRenameValidator

public Validator getRenameValidator()

getCopyValidator

public Validator getCopyValidator()

setOriginalHash

public void setOriginalHash(Integer originalHash)

onRename

protected void onRename()

Effectively the same as reload() but don't reset concurrentUpdateSessionInfo

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

protected org.jboss.errai.common.client.api.RemoteCallback<Path> getSaveSuccessCallback(int newHash)

onRestore

public void onRestore(@Observes
                      RestoreEvent restore)

reload

public void reload()

onValidate

protected Command onValidate()

If your editor has validation, overwrite this.

Returns:

The validation command

loadContent

protected abstract void loadContent()

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

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