edu.utep.cs.utjml.canica
Interface Mainable

All Known Implementing Classes:

Main

public interface Mainable

An interface to the main tool. This interface provides APIs to access the tool's frame, file browser, editor, output pane, toolable, and status bar.

Author:

Yoonsik Cheon and Angelica B. Perez

Method Summary

JMLEditorable	editor() Returns the editor of this GUI.
FileBrowserable	fileBrowser() Returns the explorer of this GUI.
JFrame	frame() Returns the frame of this GUI.
String	getCLASSPATH() Returns the CLASSPATH specified in the global IDE preferences for Canica
String	getHomeDirectory() Returns the home directory specified in the global IDE preferences for Canica
int	getIndentationSize() Returns the indentation size specified in the editor preferences
String	getJavaCompilerHomePath() Returns the Java Compiler Home path specified in the global IDE preferences for Canica
String	getJavaDocPath() Returns the path specified to the Javadoc tool in the global IDE preferences for Canica
String	getJMLDocPath() Returns the path specified to the JMLdoc tool in the global IDE preferences for Canica
int	getMaxFilesOpen() Returns the maximum number of files that can be opened in the JML editor
String	getOptionsToJavaC() Returns the option values specified to the Java compiler in the global IDE preferences for Canica
String	getOptionsToJMLC() Returns the option values specified to the JML compiler tool in the global IDE preferences for Canica
boolean	getPrefToSearchAndReplace() Returns the preference to the search and replace functionalities located in the JML Editor Subsystem.
String	getSyntaxHighlightPath() Returns the syntax highlighting file path specified in the editor preferences
String	getWorkingDirectory() Returns the working directory assigned by default for Canica
OutputPaneable	outputPane() Returns the output pane of this GUI.
void	putValueToRedoAction(String actionName, Object redoPresentationName) Puts a new value to the Redo action in the Edit Menu
void	putValueToUndoAction(String actionName, Object undoPresentationName) Puts a new value to the Undo action in the Edit Menu
void	resetMenu() Reset the Menu to original state
void	setEnabledToMenuItems(MenuOptions menuOptions) Sets the "setEnabled" properties to the menu items of the main menu
void	setEnabledToMenuItems(String menuName, boolean[] menuItems) Sets the "setEnabled" properties to the menu items of the main menu, corresponding to the menu name
void	setWorkingDirectory(String workingDir) Sets the actual working directory
StatusBarable	statusBar() Returns the status bar of this GUI.
Toolable	tool() Returns the tool of this GUI

Method Detail

frame

JFrame frame()

Returns the frame of this GUI.

statusBar

StatusBarable statusBar()

Returns the status bar of this GUI.

outputPane

OutputPaneable outputPane()

Returns the output pane of this GUI.

tool

Toolable tool()

Returns the tool of this GUI

editor

JMLEditorable editor()

Returns the editor of this GUI.

fileBrowser

FileBrowserable fileBrowser()

Returns the explorer of this GUI.

getHomeDirectory

String getHomeDirectory()

Returns the home directory specified in the global IDE preferences for Canica

getWorkingDirectory

String getWorkingDirectory()

Returns the working directory assigned by default for Canica

setWorkingDirectory

void setWorkingDirectory(String workingDir)

Sets the actual working directory

Parameters:

workingDir - Actual directory

getJavaCompilerHomePath

String getJavaCompilerHomePath()

Returns the Java Compiler Home path specified in the global IDE preferences for Canica

getOptionsToJavaC

String getOptionsToJavaC()

Returns the option values specified to the Java compiler in the global IDE preferences for Canica

getCLASSPATH

String getCLASSPATH()

Returns the CLASSPATH specified in the global IDE preferences for Canica

getOptionsToJMLC

String getOptionsToJMLC()

Returns the option values specified to the JML compiler tool in the global IDE preferences for Canica

getJavaDocPath

String getJavaDocPath()

Returns the path specified to the Javadoc tool in the global IDE preferences for Canica

getJMLDocPath

String getJMLDocPath()

Returns the path specified to the JMLdoc tool in the global IDE preferences for Canica

getSyntaxHighlightPath

String getSyntaxHighlightPath()

Returns the syntax highlighting file path specified in the editor preferences

getIndentationSize

int getIndentationSize()

Returns the indentation size specified in the editor preferences

getMaxFilesOpen

int getMaxFilesOpen()

Returns the maximum number of files that can be opened in the JML editor

getPrefToSearchAndReplace

boolean getPrefToSearchAndReplace()

Returns the preference to the search and replace functionalities located in the JML Editor Subsystem. The preference should be true by default, this means, the search and replace should be to the current file only; and false if the search and replace should be to all files opened.

setEnabledToMenuItems

void setEnabledToMenuItems(String menuName,
                           boolean[] menuItems)

Sets the "setEnabled" properties to the menu items of the main menu, corresponding to the menu name

Parameters:

menuName - The menu name

menuItems - The boolean array containing the values to the menu items set enabled property.

setEnabledToMenuItems

void setEnabledToMenuItems(MenuOptions menuOptions)

Sets the "setEnabled" properties to the menu items of the main menu

resetMenu

void resetMenu()

Reset the Menu to original state

putValueToUndoAction

void putValueToUndoAction(String actionName,
                          Object undoPresentationName)

Puts a new value to the Undo action in the Edit Menu

putValueToRedoAction

void putValueToRedoAction(String actionName,
                          Object redoPresentationName)

Puts a new value to the Redo action in the Edit Menu