antsnest.gui
Interface ApplicationTasks

All Known Implementing Classes:

MasterFrame

public interface ApplicationTasks

Interface for MasterFrame that allows it to be passed around as a utility class

Author:

Chris Clohosy

Method Summary

void	addTaskDefinition() Adds a task definition to the Task Extension Model
void	copy() Tells the application to perform a copy
void	createNewProject() Creates a new project in the application
void	cut() Tells the application to perform a cut
void	displayDoc(String taskName) Displays Ant documentation in the information panel
void	displayHTML(URL url) Displays a web page in an external window
AntInfo	getAntInfo() Gets the Ant information object being used
Component	getLastFocused() Gets the last component to have the focus before the menu bars
Component	getMainComponent() Gets a component reference
AntProject	getProject() Gets the project being currently worked on
AntsNestProperties	getProperties() Gets the user's properties
String	getSingleLineString(String title) Gets a single line string from a specialist input window
String	getString(String title, String text) Gets a string from a specialist input window
void	loadBuildFile() Loads a build file into the application
void	needsToBeSaved() Notifies the application that the build file has been edited
void	paste() Tells the application to perform a paste
void	projectChanged(AntProject newProject) Informs the application that the project has changed
void	quickSave() Saves a build file using the current filename
void	redo() Tells the application to perform a redo
void	saveBuildFile() Saves a build file letting the user select a filename
void	shutdown() Responsible for a safe shutdown of the application
void	undo() Tells the application to perform an undo
void	useBean() Uses an Ant Bean

Method Detail

shutdown

void shutdown()

Responsible for a safe shutdown of the application

createNewProject

void createNewProject()

Creates a new project in the application

needsToBeSaved

void needsToBeSaved()

Notifies the application that the build file has been edited

loadBuildFile

void loadBuildFile()

Loads a build file into the application

saveBuildFile

void saveBuildFile()

Saves a build file letting the user select a filename

quickSave

void quickSave()

Saves a build file using the current filename

getProject

AntProject getProject()

Gets the project being currently worked on

Returns:

an AntProject, the project

getAntInfo

AntInfo getAntInfo()

Gets the Ant information object being used

Returns:

an AntInfo, the information object being used

getProperties

AntsNestProperties getProperties()

Gets the user's properties

Returns:

an AntsNestProperties, the user's properties

getString

String getString(String title,
                 String text)

Gets a string from a specialist input window

Parameters:

title - the title of the specialist window

text - the text to display to start with

Returns:

a String, the string

getSingleLineString

String getSingleLineString(String title)

Gets a single line string from a specialist input window

Parameters:

title - the title of the specialist window

Returns:

a String, the string

displayDoc

void displayDoc(String taskName)

Displays Ant documentation in the information panel

Parameters:

taskName - the name of the task to document

projectChanged

void projectChanged(AntProject newProject)

Informs the application that the project has changed

Parameters:

newProject - the changed project

undo

void undo()

Tells the application to perform an undo

redo

void redo()

Tells the application to perform a redo

cut

void cut()

Tells the application to perform a cut

copy

void copy()

Tells the application to perform a copy

paste

void paste()

Tells the application to perform a paste

getLastFocused

Component getLastFocused()

Gets the last component to have the focus before the menu bars

Returns:

a Component, the last focused on component

displayHTML

void displayHTML(URL url)

Displays a web page in an external window

Parameters:

url - the URL of the web page

addTaskDefinition

void addTaskDefinition()

Adds a task definition to the Task Extension Model

getMainComponent

Component getMainComponent()

Gets a component reference

useBean

void useBean()

Uses an Ant Bean