org.gradle.gradleplugin.userinterface.swing.generic

Class AbstractGradleUIInstance

java.lang.Object

org.gradle.gradleplugin.userinterface.swing.generic.AbstractGradleUIInstance

All Implemented Interfaces:

BasicGradleUI

Direct Known Subclasses:

DualPaneUIInstance, SinglePaneUIInstance

public abstract class AbstractGradleUIInstance
extends Object
implements BasicGradleUI

A simple UI for gradle that is meant to be embedded into an IDE. This doesn't have it own output since most IDEs have their own mechanism for that.

Author:

mhunsicker

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.gradleplugin.userinterface.swing.generic.BasicGradleUI

BasicGradleUI.CloseInteraction

Field Summary

Fields

Modifier and Type	Field and Description
protected AlternateUIInteraction	alternateUIInteraction
protected MainGradlePanel	gradlePanel
protected GradlePluginLord	gradlePluginLord
protected JPanel	mainPanel
protected SettingsNode	settings

Constructor Summary

Constructors

Constructor and Description
AbstractGradleUIInstance()

Method Summary

Methods

Modifier and Type	Method and Description
void	aboutToShow() Call this whenever you're about to show this panel.
void	addGradleTab(int index, GradleTab gradleTab) Call this to add one of your own tabs to this.
boolean	canClose(BasicGradleUI.CloseInteraction closeInteraction) Call this to deteremine if you can close this pane.
void	close() Call this before you close the pane.
protected Component	createMainGradlePanel()
void	executeCommand(String commandLineArguments, String displayName)
JComponent	getComponent()
File	getCurrentDirectory()
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)
abstract OutputUILord	getOutputUILord()
void	initialize(SettingsNode settings, AlternateUIInteraction alternateUIInteraction)
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	setCurrentDirectory(File currentDirectory)
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
protected void	setupUI()

Methods inherited from class java.lang.Object

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

Field Detail

gradlePanel

protected MainGradlePanel gradlePanel

gradlePluginLord

protected GradlePluginLord gradlePluginLord

settings

protected SettingsNode settings

alternateUIInteraction

protected AlternateUIInteraction alternateUIInteraction

mainPanel

protected JPanel mainPanel

Constructor Detail

AbstractGradleUIInstance

public AbstractGradleUIInstance()

Method Detail

initialize

public void initialize(SettingsNode settings,
              AlternateUIInteraction alternateUIInteraction)

getComponent

public JComponent getComponent()

Specified by:

getComponent in interface BasicGradleUI

setupUI

protected void setupUI()

createMainGradlePanel

protected Component createMainGradlePanel()

getOutputUILord

public abstract OutputUILord getOutputUILord()

Specified by:

getOutputUILord in interface BasicGradleUI

aboutToShow

public void aboutToShow()

Call this whenever you're about to show this panel. We'll do whatever initialization is necessary.

Specified by:

aboutToShow in interface BasicGradleUI

canClose

public boolean canClose(BasicGradleUI.CloseInteraction closeInteraction)

Call this to deteremine if you can close this pane. if we're busy, we'll ask the user if they want to close.

Specified by:

canClose in interface BasicGradleUI

Parameters:

closeInteraction - allows us to interact with the user

Returns:

true if we can close, false if not.

close

public void close()

Call this before you close the pane. This gives it an opportunity to do cleanup. You probably should call canClose before this. It gives the app a chance to cancel if its busy.

Specified by:

close in interface BasicGradleUI

getCurrentDirectory

public File getCurrentDirectory()

setCurrentDirectory

public void setCurrentDirectory(File currentDirectory)

addGradleTab

public void addGradleTab(int index,
                GradleTab gradleTab)

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

Specified by:

addGradleTab in interface BasicGradleUI

Parameters:

index - where to add the tab

gradleTab - the tab to add

removeGradleTab

public void removeGradleTab(GradleTab gradleTab)

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

Specified by:

removeGradleTab in interface BasicGradleUI

Parameters:

gradleTab - the tab to remove

getGradleTabCount

public int getGradleTabCount()

Specified by:

getGradleTabCount in interface BasicGradleUI

Returns:

the total number of tabs.

getGradleTabName

public String getGradleTabName(int index)

Specified by:

getGradleTabName in interface BasicGradleUI

Parameters:

index - the index of the tab

Returns:

the name of the tab at the specified index.

getGradlePluginLord

public GradlePluginLord getGradlePluginLord()

Specified by:

getGradlePluginLord in interface BasicGradleUI

getGradleTabIndex

public int getGradleTabIndex(String name)

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

Specified by:

getGradleTabIndex in interface BasicGradleUI

Parameters:

name - the name of the tab

Returns:

the index of the tab or -1 if not found

getCurrentGradleTab

public int getCurrentGradleTab()

Specified by:

getCurrentGradleTab in interface BasicGradleUI

Returns:

the currently selected tab

setCurrentGradleTab

public void setCurrentGradleTab(int index)

Makes the specified tab the current tab.

Specified by:

setCurrentGradleTab in interface BasicGradleUI

Parameters:

index - the index of the tab.

executeCommand

public void executeCommand(String commandLineArguments,
                  String displayName)

Specified by:

executeCommand in interface BasicGradleUI

refreshTaskTree

public 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.

Specified by:

refreshTaskTree in interface BasicGradleUI

refreshTaskTree

public 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.

Specified by:

refreshTaskTree in interface BasicGradleUI

Parameters:

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

isBusy

public boolean isBusy()

Determines if commands are currently being executed or not.

Specified by:

isBusy in interface BasicGradleUI

Returns:

true if we're busy, false if not.

setCustomPanelToSetupTab

public void setCustomPanelToSetupTab(JComponent component)

This adds the specified component to the setup panel. It is added below the last 'default' item. You can only add 1 component here, so if you need to add multiple things, you'll have to handle adding that to yourself to the one component.

Specified by:

setCustomPanelToSetupTab in interface BasicGradleUI

Parameters:

component - the component to add.

setOutputTextFont

public void setOutputTextFont(Font font)

Sets the font for the output text

Specified by:

setOutputTextFont in interface BasicGradleUI

Parameters:

font - the new font