Package ru.cg.webbpm.studio.platform.api.file_editor

Interface NativeFileEditor

All Superinterfaces:

FileEditor

All Known Subinterfaces:

Bpmn2Editor, JbpmDesignerEditor, PageEditor

All Known Implementing Classes:

ComponentEditorImpl, JbpmDesignerEditorImpl, OldJbpmDesignerEditorImpl, PageEditorImpl

public interface NativeFileEditor
extends FileEditor

Author:

Ildar

Method Summary

Modifier and Type	Method	Description
default void	deselectNotify()	This method is invoked each time when the editor is deselected.
javafx.scene.Node	getComponent()
Path	getFile()
javafx.beans.property.StringProperty	getFileName()
String	getName()
default javafx.beans.property.Property<Boolean>	isModified()
default javafx.beans.property.Property<Boolean>	isValid()
default void	onClose()	This method is invoked when the editor is closed.
void	refresh()
void	save()	Save changes
default void	selectNotify()	This method is invoked each time when the editor is selected.
void	setFileName(String newName)
void	update(Path newFile)

Method Details

getComponent

javafx.scene.Node getComponent()

Returns:

component which represents editor in the UI. The method should never return null.

getName

String getName()

Returns:

editor's name, a string that identifies editor among other editors. For example, UI form might have two editor: "GUI Designer" and "Text". So "GUI Designer" can be a name of one editor and "Text" can be a name of other editor. The method should never return null.

save

void save()

Save changes

isModified

default javafx.beans.property.Property<Boolean> isModified()

Returns:

whether the editor's content is modified in comparison with its file.

isValid

default javafx.beans.property.Property<Boolean> isValid()

Returns:

whether the editor is valid or not. An editor is valid if the contents displayed in it still exists. For example, an editor displaying the contents of a file stops being valid if the file is deleted.

selectNotify

default void selectNotify()

This method is invoked each time when the editor is selected. This can happen in two cases: editor is selected because the selected file has been changed or editor for the selected file has been changed.

deselectNotify

default void deselectNotify()

This method is invoked each time when the editor is deselected.

onClose

default void onClose()

This method is invoked when the editor is closed.

getFile

Path getFile()

Returns:

the path of the edited file

getFileName

javafx.beans.property.StringProperty getFileName()

setFileName

void setFileName(String newName)

update

void update(Path newFile)

refresh

void refresh()