org.gradle.openapi.external.ui

Interface AlternateUIInteractionVersion1

public interface AlternateUIInteractionVersion1

This is how the gradle UI panel interacts with the UI that is holding it. This is a mirror of AlternateUIInteraction inside Gradle, but this is meant to aid backward and forward compatibility by shielding you from direct changes within gradle.

Author:

mhunsicker

Method Summary

Methods

Modifier and Type	Method and Description
void	aboutToExecuteCommand(String fullCommandLine) Notification that a command is about to be executed.
boolean	doesSupportEditingOpeningFiles() Determines if we can call editFiles or openFile.
void	editFile(File file, int line) This is called when we should open the specified file for editing.
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 edit

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

editFile

void editFile(File file,
            int line)

This is called when we should open the specified file for editing. This version explicitly wants them edited versus just opened.

Parameters:

file - the file to open

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

doesSupportEditingOpeningFiles

boolean doesSupportEditingOpeningFiles()

Determines if we can call editFiles 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.

aboutToExecuteCommand

void aboutToExecuteCommand(String fullCommandLine)

Notification that a command is about to be executed. This is mostly useful for IDE's that may need to save their files.

Parameters:

fullCommandLine - the command that's about to be executed.