UTJML

edu.utep.cs.utjml.canica.jmleditor
Interface JMLEditorable

All Known Implementing Classes:
JMLEditorMDI

public interface JMLEditorable

An interface to access the functionality of the JML editor.

Author:
Angelica B. Perez, Apr 25, 2006

Field Summary
static String[] ERROR_MESSAGES
          this is the array containing the error messages definitions
static int NO_MESSAGE
          It is returned when there are no error messages.
 
Method Summary
 File getActiveEditingFile()
          It returns the active editing file (the current file being edited in the JML editor)
 BasicEditorable getBasicEditorable()
          It returns the interface that will handle the basic editing (copy, paste, undo, redo, select all, delete, delete line, etc) in the JML editor.
 int getEditorSize()
          It returns the size (number of files opened) of the JML Editor.
 JPanel getEditorView()
          It returns the JML Editor view (see JMLEditorMDIView class) as a JPanel object.
 FileAccessable getFileAccessable()
          It returns the interface that will handle the access to files (open, new, save, save all, close , close all, save as, etc) in the JML editor.
 SearchInsertAndHighlightable getSearchInsertAndHighlightable()
          It returns the interface that will handle the search, insert and highlight functionalities in the JML editor.
 StatusBarable getStatusBarable()
          It returns the interface that will handle the status bar in the JML Editor.
 boolean isModified()
          Verifies if the active editing file has being modified.
 boolean setActiveEditingfile(File file)
          Sets to the JML editor this file active.
 boolean setActiveEditingfile(String fileName)
          Sets to the JML editor the first file containing this file name.
 

Field Detail

NO_MESSAGE

static final int NO_MESSAGE
It is returned when there are no error messages.

See Also:
Constant Field Values

ERROR_MESSAGES

static final String[] ERROR_MESSAGES
this is the array containing the error messages definitions

Method Detail

getEditorView

JPanel getEditorView()
It returns the JML Editor view (see JMLEditorMDIView class) as a JPanel object.

Returns:
JML Editor view

getEditorSize

int getEditorSize()
It returns the size (number of files opened) of the JML Editor.

Returns:
Editor size.

setActiveEditingfile

boolean setActiveEditingfile(File file)
Sets to the JML editor this file active.

Parameters:
file - The file to be active.

setActiveEditingfile

boolean setActiveEditingfile(String fileName)
Sets to the JML editor the first file containing this file name.

Parameters:
file - File name
Returns:
True if the file name was set active, false if not.

getActiveEditingFile

File getActiveEditingFile()
It returns the active editing file (the current file being edited in the JML editor)

Returns:
Active editing file.

isModified

boolean isModified()
Verifies if the active editing file has being modified.

Returns:
True if the actual editing file has being modified or false if it hasn't.

getStatusBarable

StatusBarable getStatusBarable()
It returns the interface that will handle the status bar in the JML Editor.

Returns:
StatusBarable interface.

getFileAccessable

FileAccessable getFileAccessable()
It returns the interface that will handle the access to files (open, new, save, save all, close , close all, save as, etc) in the JML editor.

Returns:
FileAccessable interface

getBasicEditorable

BasicEditorable getBasicEditorable()
It returns the interface that will handle the basic editing (copy, paste, undo, redo, select all, delete, delete line, etc) in the JML editor.

Returns:
BasicEditorable interface

getSearchInsertAndHighlightable

SearchInsertAndHighlightable getSearchInsertAndHighlightable()
It returns the interface that will handle the search, insert and highlight functionalities in the JML editor.

Returns:
SearchInsertAndHighlightable interface

UTJML

UTJML is Copyright (C) 2004-2006 by University of Texas at El Paso and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This release depends on code from the JML project.