org.gradle.gradleplugin.userinterface.swing.standalone

Class Application

java.lang.Object

org.gradle.gradleplugin.userinterface.swing.standalone.Application

All Implemented Interfaces:

AlternateUIInteraction

public class Application
extends Object
implements AlternateUIInteraction

The main entry point for a stand-alone application for Gradle. The real work is not done here. This is just a UI containing components that are meant to be reuseable in other UIs (say an IDE plugin). Those other components do the real work. Most of the work is wrapped inside SinglePaneUIInstance.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Application.LifecycleListener Interface that allows the caller to do post shutdown processing.

Constructor Summary

Constructors

Constructor and Description
Application(Application.LifecycleListener lifecycleListener)

Method Summary

Methods

Modifier and Type	Method and Description
void	browseFile(File file)
boolean	determineIfSupportsEditingFiles() Determines if we support editing files.
boolean	doesSupportEditingOpeningFiles() Determines if we can call editFiles.
void	editFile(File file, int line) This is called when we should edit the specified file.
void	editFileInExternalApplication(File file, boolean attemptToOpen) This edits the application using java.awt.Desktop.
static String	getFileNameExtension(String fileName) Returns the file extension preserving its case.
boolean	invokeDesktopFunction(String name, Class argumentClass, Object argument) This invokes one of the java.awt.Desktop functions.
static void	main(String[] args)
void	openFile(File file, int line) Notification that you should open the specified file and go to the specified line.
void	openFileInExternalApplication(File file)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Application

public Application(Application.LifecycleListener lifecycleListener)

Method Detail

main

public static void main(String[] args)

openFile

public void openFile(File file,
            int line)

Notification that you should open the specified file and go to the specified line. Its up to the application to determine if this file should be opened for editing or simply displayed. The difference comes into play for things like xml or html files where a user may want to open them in a browser vs a source code file where they may want to open it directly in an IDE.

Specified by:

openFile in interface AlternateUIInteraction

Parameters:

file - the file to edit

line - the line to go to. -1 if no line is specified.

browseFile

public void browseFile(File file)

editFile

public void editFile(File file,
            int line)

This is called when we should edit the specified file. Open it in the current IDE or some external editor.

Specified by:

editFile in interface AlternateUIInteraction

editFileInExternalApplication

public void editFileInExternalApplication(File file,
                                 boolean attemptToOpen)

This edits the application using java.awt.Desktop. Since we're compiling with 1.5 and this is a 1.6 feature, this is done using reflection making this much uglier than it needs to be.

Parameters:

file - the file to edit

attemptToOpen - true if we should attempt to just open the file is editing it fails. Often, file associations don't distinguish edit from open and open is the default.

openFileInExternalApplication

public void openFileInExternalApplication(File file)

invokeDesktopFunction

public boolean invokeDesktopFunction(String name,
                            Class argumentClass,
                            Object argument)

This invokes one of the java.awt.Desktop functions. Since we're compiling with 1.5 and this is a 1.6 feature, this is done using reflection making this much uglier than it needs to be. This is for calling one of the 'edit', 'browse', 'open' or even 'mail' functions that always take a single argument.

Parameters:

name - the function to invoke

argumentClass - the class of the argument of the above function.

argument - the argument itself.

Returns:

true if it worked, false if not. It might fail if the platform doesn't support editing/opening the file passed in, for example.

getFileNameExtension

public static String getFileNameExtension(String fileName)

Returns the file extension preserving its case.

Parameters:

fileName - the file name

Returns:

the extension.

doesSupportEditingOpeningFiles

public boolean doesSupportEditingOpeningFiles()

Determines if we can call editFiles. This is not a dynamic answer and should always return either true of false. If you want to change the answer, return true and then handle the files differently in editFiles.

Specified by:

doesSupportEditingOpeningFiles in interface AlternateUIInteraction

Returns:

true if support editing files, false otherwise.

determineIfSupportsEditingFiles

public boolean determineIfSupportsEditingFiles()

Determines if we support editing files. At the time of this writing, we were mooching off of java 1.6's ability to get the OS to do this. If we're running on 1.5, this will fail.

Returns:

true if we support it, false if not.