org.gradle.gradleplugin.userinterface.swing.generic

Interface BasicGradleUI

All Known Implementing Classes:

AbstractGradleUIInstance, DualPaneUIInstance, SinglePaneUIInstance

public interface BasicGradleUI

.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BasicGradleUI.CloseInteraction

Method Summary

Methods

Modifier and Type	Method and Description
void	aboutToShow()
void	addGradleTab(int index, GradleTab gradleTab) Call this to add one of your own tabs to this.
boolean	canClose(BasicGradleUI.CloseInteraction closeInteraction)
void	close()
void	executeCommand(String commandLineArguments, String displayName)
JComponent	getComponent()
int	getCurrentGradleTab()
GradlePluginLord	getGradlePluginLord()
int	getGradleTabCount()
int	getGradleTabIndex(String name) Returns the index of the gradle tab with the specified name.
String	getGradleTabName(int index)
OutputUILord	getOutputUILord()
boolean	isBusy() Determines if commands are currently being executed or not.
void	refreshTaskTree() This refreshes the task tree.
void	refreshTaskTree(String additionalCommandLineArguments) This refreshes the task tree.
void	removeGradleTab(GradleTab gradleTab) Call this to remove one of your own tabs from this.
void	setCurrentGradleTab(int index) Makes the specified tab the current tab.
void	setCustomPanelToSetupTab(JComponent component) This adds the specified component to the setup panel.
void	setOutputTextFont(Font font) Sets the font for the output text

Method Detail

getGradlePluginLord

GradlePluginLord getGradlePluginLord()

getComponent

JComponent getComponent()

aboutToShow

void aboutToShow()

canClose

boolean canClose(BasicGradleUI.CloseInteraction closeInteraction)

close

void close()

getGradleTabCount

int getGradleTabCount()

getGradleTabName

String getGradleTabName(int index)

getGradleTabIndex

int getGradleTabIndex(String name)

Returns the index of the gradle tab with the specified name.

Parameters:

name - the name of the tab

Returns:

the index of the tab or -1 if not found

getCurrentGradleTab

int getCurrentGradleTab()

Returns:

the currently selected tab

setCurrentGradleTab

void setCurrentGradleTab(int index)

Makes the specified tab the current tab.

Parameters:

index - the index of the tab.

executeCommand

void executeCommand(String commandLineArguments,
                  String displayName)

refreshTaskTree

void refreshTaskTree()

This refreshes the task tree. Useful if you know you've changed something behind gradle's back or when first displaying this UI.

refreshTaskTree

void refreshTaskTree(String additionalCommandLineArguments)

This refreshes the task tree. Useful if you know you've changed something behind gradle's back or when first displaying this UI.

Parameters:

additionalCommandLineArguments - additional command line arguments to be passed to gradle when refreshing the task tree.

addGradleTab

void addGradleTab(int index,
                GradleTab gradleTab)

Call this to add one of your own tabs to this. You can call this at any time.

Parameters:

index - where to add the tab

gradleTab - the tab to add

removeGradleTab

void removeGradleTab(GradleTab gradleTab)

Call this to remove one of your own tabs from this.

Parameters:

gradleTab - the tab to remove

getOutputUILord

OutputUILord getOutputUILord()

isBusy

boolean isBusy()

Determines if commands are currently being executed or not.

Returns:

true if we're busy, false if not.

setCustomPanelToSetupTab

void setCustomPanelToSetupTab(JComponent component)

This adds the specified component to the setup panel. It is added below the last 'default' item. You must call this after initialize

Parameters:

component - the component to add.

setOutputTextFont

void setOutputTextFont(Font font)

Sets the font for the output text

Parameters:

font - the new font