Package edu.umd.cs.findbugs

Interface IGuiCallback

All Known Implementing Classes:

AbstractSwingGuiCallback, CommandLineUiCallback

public interface IGuiCallback

Interface for any kind of GUI attached to the current FindBug analysis

Author:

Andrei

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IGuiCallback.FormItem

Field Summary

Fields

Modifier and Type	Field	Description
static int	CANCEL_OPTION
static int	NO_OPTION
static int	OK_CANCEL_OPTION
static int	YES_NO_CANCEL_OPTION
static int	YES_NO_OPTION
static int	YES_OPTION

Method Summary

Modifier and Type	Method	Description
void	displayNonmodelMessage(java.lang.String title, java.lang.String message)
java.util.concurrent.ExecutorService	getBugUpdateExecutor()	Use this executor to queue bug collection updates without interfering with the GUI.
java.io.InputStream	getProgressMonitorInputStream(java.io.InputStream in, int length, java.lang.String msg)
void	invokeInGUIThread(java.lang.Runnable r)
boolean	isHeadless()	If true, do not open windows or browsers
void	registerCloud(Project project, BugCollection collection, Cloud cloud)	Called as soon as the cloud object is created, before it is initialized.
void	setErrorMessage(java.lang.String errorMsg)
int	showConfirmDialog(java.lang.String message, java.lang.String title, java.lang.String ok, java.lang.String cancel)
boolean	showDocument(java.net.URL u)
java.util.List<java.lang.String>	showForm(java.lang.String message, java.lang.String title, java.util.List<IGuiCallback.FormItem> labels)
void	showMessageDialog(java.lang.String message)
void	showMessageDialogAndWait(java.lang.String message)
java.lang.String	showQuestionDialog(java.lang.String message, java.lang.String title, java.lang.String defaultValue)
void	unregisterCloud(Project project, BugCollection collection, Cloud cloud)

Field Detail

YES_OPTION

static final int YES_OPTION

See Also:

Constant Field Values

NO_OPTION

static final int NO_OPTION

See Also:

Constant Field Values

CANCEL_OPTION

static final int CANCEL_OPTION

See Also:

Constant Field Values

YES_NO_OPTION

static final int YES_NO_OPTION

See Also:

Constant Field Values

YES_NO_CANCEL_OPTION

static final int YES_NO_CANCEL_OPTION

See Also:

Constant Field Values

OK_CANCEL_OPTION

static final int OK_CANCEL_OPTION

See Also:

Constant Field Values

Method Detail

isHeadless

boolean isHeadless()

If true, do not open windows or browsers

showMessageDialog

void showMessageDialog(java.lang.String message)

invokeInGUIThread

void invokeInGUIThread(java.lang.Runnable r)

showConfirmDialog

int showConfirmDialog(java.lang.String message,
                      java.lang.String title,
                      java.lang.String ok,
                      java.lang.String cancel)

showQuestionDialog

java.lang.String showQuestionDialog(java.lang.String message,
                                    java.lang.String title,
                                    java.lang.String defaultValue)

showForm

java.util.List<java.lang.String> showForm(java.lang.String message,
                                          java.lang.String title,
                                          java.util.List<IGuiCallback.FormItem> labels)

getProgressMonitorInputStream

java.io.InputStream getProgressMonitorInputStream(java.io.InputStream in,
                                                  int length,
                                                  java.lang.String msg)

setErrorMessage

void setErrorMessage(java.lang.String errorMsg)

displayNonmodelMessage

void displayNonmodelMessage(java.lang.String title,
                            java.lang.String message)

showDocument

boolean showDocument(java.net.URL u)

registerCloud

void registerCloud(Project project,
                   BugCollection collection,
                   Cloud cloud)

Called as soon as the cloud object is created, before it is initialized. Useful for adding status msg listener.

unregisterCloud

void unregisterCloud(Project project,
                     BugCollection collection,
                     Cloud cloud)

getBugUpdateExecutor

java.util.concurrent.ExecutorService getBugUpdateExecutor()

Use this executor to queue bug collection updates without interfering with the GUI. Runs on the AWT event thread.

showMessageDialogAndWait

void showMessageDialogAndWait(java.lang.String message)
                       throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException