edu.utep.cs.utjml.gui
Interface Editorable

All Known Implementing Classes:

JmlEditor

public interface Editorable

An interface to the editor of the GUI. This interface provides APIs for creating a new document, opening a file, saving the editing buffer to a file, and checking if the editor has unsaved edits.

Author:

Yoonsik Cheon

Method Summary

void	highlight(String file, int line) Highlights the specified line of the given file.
void	highlight(String file, int line, int column) Highlights the specified line and column of the given file.
boolean	isDirty() Returns true if there exist unsaved edits for the document of this editor.
boolean	newDocument() Creates a new empty document for this editor.
boolean	openFile(File file) Opens the given file file for editing by this editor.
boolean	saveFile(File file) Saves the document of this editor to the given file file.

Method Detail

newDocument

boolean newDocument()

Creates a new empty document for this editor.

openFile

boolean openFile(File file)

Opens the given file file for editing by this editor. The contents of the file are read into the document of this editor.

saveFile

boolean saveFile(File file)

Saves the document of this editor to the given file file.

isDirty

boolean isDirty()

Returns true if there exist unsaved edits for the document of this editor.

highlight

void highlight(String file,
               int line,
               int column)

Highlights the specified line and column of the given file.

highlight

void highlight(String file,
               int line)

Highlights the specified line of the given file.