BasicGradleUIVersion1 (Gradle API 1.0)

All Known Subinterfaces:

DualPaneUIVersion1, SinglePaneUIVersion1

All Known Implementing Classes:

DualPaneUIWrapper, SinglePaneUIWrapper
```
public interface BasicGradleUIVersion1
```
This represents a basic gradle UI 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.

Author:

mhunsicker

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface BasicGradleUIVersion1.CloseInteraction

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`BasicGradleUIVersion1.CloseInteraction`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`aboutToShow()` Call this whenever you're about to show this panel.
`void`	`addCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListenerVersion1 listener)` This allows you to add a listener that can add additional command line arguments whenever gradle is executed.
`void`	`addOutputObserver(OutputObserverVersion1 outputObserverVersion1)`
`void`	`addTab(int index, GradleTabVersion1 gradleTabVersion1)` Call this to add an additional tab to the gradle UI.
`boolean`	`canClose(BasicGradleUIVersion1.CloseInteraction closeInteraction)` Call this to determine if you can close this pane.
`void`	`close()` Call this before you close the pane.
`void`	`executeCommand(String commandLineArguments, String displayName)` Call this to execute the given gradle command.
`File`	`getCurrentDirectory()`
`int`	`getCurrentGradleTab()`
`File`	`getCustomGradleExecutable()` This is called to get a custom gradle executable file.
`FavoritesEditorVersion1`	`getFavoritesEditor()` Returns a FavoritesEditor.
`File`	`getGradleHomeDirectory()`
`GradleInterfaceVersion1`	`getGradleInterfaceVersion1()` This returns an object that works with lower level gradle and contains the current projects and tasks.
`int`	`getGradleTabCount()`
`int`	`getGradleTabIndex(String name)` Returns the index of the gradle tab with the specified name.
`String`	`getGradleTabName(int index)`
`boolean`	`getOnlyShowOutputOnErrors()` Determines whether output is shown only when errors occur or always
`OutputUILordVersion1`	`getOutputLord()`
`boolean`	`isBusy()` Determines if commands are currently being executed or not.
`void`	`refreshTaskTree()` This refreshes the task tree.
`void`	`removeCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListenerVersion1 listener)`
`void`	`removeOutputObserver(OutputObserverVersion1 outputObserverVersion1)`
`void`	`removeTab(GradleTabVersion1 gradleTabVersion1)` 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.

- Method Detail
  - aboutToShow
```
void aboutToShow()
```
    Call this whenever you're about to show this panel. We'll do whatever initialization is necessary.
  - canClose
```
boolean canClose(BasicGradleUIVersion1.CloseInteraction closeInteraction)
```
    Call this to determine if you can close this pane. if we're busy, we'll ask the user if they want to close.
    
    Parameters:
    closeInteraction - allows us to interact with the user
    
    Returns:
    true if we can close, false if not.
  - close
```
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.
  - getCurrentDirectory
```
File getCurrentDirectory()
```
    Returns:
    the root directory of your gradle project.
  - setCurrentDirectory
```
void setCurrentDirectory(File currentDirectory)
```
    Parameters:
    currentDirectory - the new root directory of your gradle project.
  - getGradleHomeDirectory
```
File getGradleHomeDirectory()
```
    Returns:
    the gradle home directory. Where gradle is installed.
  - getCustomGradleExecutable
```
File getCustomGradleExecutable()
```
    This is called to get a custom gradle executable file. If you don't run gradle.bat or gradle shell script to run gradle, use this to specify what you do run. Note: we're going to pass it the arguments that we would pass to gradle so if you don't like that, see alterCommandLineArguments. Normally, this should return null.
    
    Returns:
    the Executable to run gradle command or null to use the default
  - addTab
```
void addTab(int index,
          GradleTabVersion1 gradleTabVersion1)
```
    Call this to add an additional tab to the gradle UI. You can call this at any time.
    
    Parameters:
    index - the index of where to add the tab.
    gradleTabVersion1 - the tab to add.
  - removeTab
```
void removeTab(GradleTabVersion1 gradleTabVersion1)
```
    Call this to remove one of your own tabs from this.
    
    Parameters:
    gradleTabVersion1 - the tab to remove
  - getGradleTabCount
```
int getGradleTabCount()
```
    Returns:
    the total number of tabs.
  - getGradleTabName
```
String getGradleTabName(int index)
```
    Parameters:
    index - the index of the tab
    
    Returns:
    the name of the tab at the specified 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.
  - addCommandLineArgumentAlteringListener
```
void addCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListenerVersion1 listener)
```
    This allows you to add a listener that can add additional command line arguments whenever gradle is executed. This is useful if you've customized your gradle build and need to specify, for example, an init script.
    
    Parameters:
    listener - the listener that modifies the command line arguments.
  - removeCommandLineArgumentAlteringListener
```
void removeCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListenerVersion1 listener)
```
  - executeCommand
```
void executeCommand(String commandLineArguments,
                  String displayName)
```
    Call this to execute the given gradle command.
    
    Parameters:
    commandLineArguments - the command line arguments to pass to gradle.
    displayName - the name displayed in the UI for this command
  - 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.
  - getOutputLord
```
OutputUILordVersion1 getOutputLord()
```
    Returns:
    the output lord which shows the live output of all commands being executed. You can add observers to this as well as alter how it finds file links.
  - addOutputObserver
```
void addOutputObserver(OutputObserverVersion1 outputObserverVersion1)
```
  - removeOutputObserver
```
void removeOutputObserver(OutputObserverVersion1 outputObserverVersion1)
```
  - isBusy
```
boolean isBusy()
```
    Determines if commands are currently being executed or not.
    
    Returns:
    true if we're busy, false if not.
  - getOnlyShowOutputOnErrors
```
boolean getOnlyShowOutputOnErrors()
```
    Determines whether output is shown only when errors occur or always
    
    Returns:
    true to only show output if errors occur, false to show it always.
  - setCustomPanelToSetupTab
```
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.
    
    Parameters:
    component - the component to add.
  - getGradleInterfaceVersion1
```
GradleInterfaceVersion1 getGradleInterfaceVersion1()
```
    This returns an object that works with lower level gradle and contains the current projects and tasks. You can also execute tasks from it and perform certain setup.
    
    Returns:
    a GradleInterfaceVersion1 object. It may also be GradleInterfaceVersion2 or a future version. You can check its type and then cast it as appropriate. This allows the caller to be backward compatible.
  - getFavoritesEditor
```
FavoritesEditorVersion1 getFavoritesEditor()
```
    Returns a FavoritesEditor. This is useful for getting a list of all favorites or modifying them.
    
    Returns:
    a FavoritesEditorVersion1. Use this to interact with the favorites.

Interface BasicGradleUIVersion1

Nested Class Summary

Method Summary

Method Detail

aboutToShow

canClose

close

getCurrentDirectory

setCurrentDirectory

getGradleHomeDirectory

getCustomGradleExecutable

addTab

removeTab

getGradleTabCount

getGradleTabName

getGradleTabIndex

getCurrentGradleTab

setCurrentGradleTab

addCommandLineArgumentAlteringListener

removeCommandLineArgumentAlteringListener

executeCommand

refreshTaskTree

getOutputLord

addOutputObserver

removeOutputObserver

isBusy

getOnlyShowOutputOnErrors

setCustomPanelToSetupTab

getGradleInterfaceVersion1

getFavoritesEditor