org.gradle.openapi.external.ui

Interface DualPaneUIVersion1

All Superinterfaces:

BasicGradleUIVersion1

All Known Implementing Classes:

DualPaneUIWrapper

public interface DualPaneUIVersion1
extends BasicGradleUIVersion1

This is a gradle UI that is broken into two panels: one contains a tabbed pane of tasks, favorites, command line, etc. The other pane contains the output. This is meant to simplify how an IDE plugin can interact with gradle. Specifically, this allows the 'main' pane to be vertical and the output pane to be horizontal. To use this, you'll want to get an instance of this from Gradle. Then setup your UI and add this to it via getComponent. Then call aboutToShow before you display your UI. Call close before you hide your UI. You'll need to set the current directory (at any time) so gradle knows where your project is located.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.openapi.external.ui.BasicGradleUIVersion1

BasicGradleUIVersion1.CloseInteraction

Method Summary

Methods

Modifier and Type	Method and Description
JComponent	getMainComponent() Returns a component that shows the task tree tab, favorites tab, etc.
int	getNumberOfOpenedOutputTabs() This gets the number of opened output tabs.
Component	getOutputPanel() Returns a component that shows the output of the tasks being executed.

Methods inherited from interface org.gradle.openapi.external.ui.BasicGradleUIVersion1

aboutToShow, addCommandLineArgumentAlteringListener, addOutputObserver, addTab, canClose, close, executeCommand, getCurrentDirectory, getCurrentGradleTab, getCustomGradleExecutable, getFavoritesEditor, getGradleHomeDirectory, getGradleInterfaceVersion1, getGradleTabCount, getGradleTabIndex, getGradleTabName, getOnlyShowOutputOnErrors, getOutputLord, isBusy, refreshTaskTree, removeCommandLineArgumentAlteringListener, removeOutputObserver, removeTab, setCurrentDirectory, setCurrentGradleTab, setCustomPanelToSetupTab

Method Detail

getMainComponent

JComponent getMainComponent()

Returns a component that shows the task tree tab, favorites tab, etc. suitable for inserting in your UI.

Returns:

the main component

getOutputPanel

Component getOutputPanel()

Returns a component that shows the output of the tasks being executed. This is suitable for inserting in your UI.

Returns:

the output component

getNumberOfOpenedOutputTabs

int getNumberOfOpenedOutputTabs()

This gets the number of opened output tabs. This is used by the Idea plugin to determine if it should close the entire output pane when a tab is closed This doesn't determine whether or not the tabs are busy. See GradleInterfaceVersion1.isBusy for that

Returns:

the number of opened output tabs.