org.gradle.gradleplugin.userinterface

Interface AlternateUIInteraction

All Known Implementing Classes:

AlternateUIInteractionVersionWrapper, Application

public interface AlternateUIInteraction

This allows this plugin to interact with alternative UIs. Specifically, this has callbacks for IDE's so tell it to edit a project file or the like. This is the 'alternate' UI interaction because it interacts with other UIs (other than the built-in UI).

Author:

mhunsicker

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doesSupportEditingOpeningFiles() Determines if we can call editFile or openFile.
void	editFile(File file, int line)
void	openFile(File file, int line) Notification that you should open the specified file and go to the specified line.

Method Detail

openFile

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.

Parameters:

file - the file to opened

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

editFile

void editFile(File file,
            int line)

doesSupportEditingOpeningFiles

boolean doesSupportEditingOpeningFiles()

Determines if we can call editFile or openFile. 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.

Returns:

true if support editing files, false otherwise.