WorkbenchClientEditorActivity (UberFire Workbench Client 7.62.0.Final API)

All Superinterfaces:

Activity, ContextSensitiveActivity, org.uberfire.security.Resource, org.uberfire.security.authz.RuntimeFeatureResource, org.uberfire.security.authz.RuntimeResource, WorkbenchActivity

All Known Implementing Classes:

AbstractWorkbenchClientEditorActivity
```
public interface WorkbenchClientEditorActivity
extends WorkbenchActivity
```
An Editor is an activity that is associated with a VFS path. It is expected that the editor will provide the end user some means of editing and saving the resource represented by the VFS path.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`elemental2.promise.Promise<String>`	`getContent()`	Get the editor content
`elemental2.promise.Promise<String>`	`getPreview()`	Get the editor content preview in SVG format
`default org.uberfire.security.ResourceType`	`getResourceType()`
`boolean`	`isDirty()`
`elemental2.promise.Promise<Void>`	`setContent(String path, String value)`	Set the editor content
`elemental2.promise.Promise<List<org.uberfire.workbench.model.bridge.Notification>>`	`validate()`

Methods inherited from interface org.uberfire.client.mvp.Activity
getName, getPlace, isDefault, isDynamic, onClose, onOpen, onShutdown, onStartup

Methods inherited from interface org.uberfire.security.Resource
getDependencies, getIdentifier, isType

Methods inherited from interface org.uberfire.client.mvp.WorkbenchActivity
contextId, getDefaultPosition, getMenus, getOwningPlace, getTitle, getTitleDecoration, getTitleDecorationElement, getToolBar, getWidget, getWidgetElement, onFocus, onLostFocus, onMayClose, preferredHeight, preferredWidth

Method Detail

setContent

elemental2.promise.Promise<Void> setContent(String path,
                                            String value)

Set the editor content

Parameters:: path - Content Relative Path; value - The editor content

getContent

elemental2.promise.Promise<String> getContent()

Get the editor content

Returns:

getPreview
```
elemental2.promise.Promise<String> getPreview()
```
Get the editor content preview in SVG format

Returns:

validate

elemental2.promise.Promise<List<org.uberfire.workbench.model.bridge.Notification>> validate()

isDirty
```
boolean isDirty()
```

getResourceType
```
default org.uberfire.security.ResourceType getResourceType()
```
Specified by:

getResourceType in interface org.uberfire.security.Resource