AbstractOpenAPIUIWrapper (Gradle API 1.0)

java.lang.Object
- org.gradle.openapi.wrappers.ui.AbstractOpenAPIUIWrapper<U>

Direct Known Subclasses:

DualPaneUIWrapper, SinglePaneUIWrapper
```
public abstract class AbstractOpenAPIUIWrapper<U extends BasicGradleUI>
extends Object
```
Implementation of BasicGradleUI meant to help shield external users from internal changes. This also provides the basics for the UI regardless of whether the output is in a separate pane or not.

Author:

mhunsicker

Field Summary

Fields
Modifier and Type	Field and Description
`protected AlternateUIInteractionVersionWrapper`	`alternateUIInteractionVersionWrapper`
`protected GradleInterfaceVersion1`	`gradleInterfaceWrapper`
`protected SettingsNodeVersionWrapper`	`settingsVersionWrapper`

Constructor Summary

Constructors
Constructor and Description

AbstractOpenAPIUIWrapper(SettingsNodeVersion1 settings, AlternateUIInteractionVersion1 alternateUIInteraction)

Constructors
Constructor and Description
`AbstractOpenAPIUIWrapper(SettingsNodeVersion1 settings, AlternateUIInteractionVersion1 alternateUIInteraction)`

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 observer)`
`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 deteremine 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()`
`int`	`getGradleTabCount()`
`int`	`getGradleTabIndex(String name)` Returns the index of the gradle tab with the specified name.
`String`	`getGradleTabName(int index)`
`U`	`getGradleUI()`
`boolean`	`getOnlyShowOutputOnErrors()` Determines whether output is shown only when errors occur or always
`OutputUILordVersion1`	`getOutputLord()`
`void`	`initialize(U basicGradleUI)`
`protected GradleInterfaceVersion1`	`instantiateGradleInterfaceWrapper()` This instantiates our GradleInterfaceVersion object.
`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 observer)`
`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.
`void`	`setOutputTextFont(Font font)` Sets the font for the output text

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - settingsVersionWrapper
```
protected SettingsNodeVersionWrapper settingsVersionWrapper
```
  - alternateUIInteractionVersionWrapper
```
protected AlternateUIInteractionVersionWrapper alternateUIInteractionVersionWrapper
```
  - gradleInterfaceWrapper
```
protected GradleInterfaceVersion1 gradleInterfaceWrapper
```
- Constructor Detail
  - AbstractOpenAPIUIWrapper
```
public AbstractOpenAPIUIWrapper(SettingsNodeVersion1 settings,
                        AlternateUIInteractionVersion1 alternateUIInteraction)
```
- Method Detail
  - initialize
```
public void initialize(U basicGradleUI)
```
  - instantiateGradleInterfaceWrapper
```
protected GradleInterfaceVersion1 instantiateGradleInterfaceWrapper()
```
    This instantiates our GradleInterfaceVersion object. Additions have been made to it -- making new versions, so we have a choice of which one to load. We'll try to load the latest one first, if that fails, we'll fall back on older versions. The latest version would fail to load because it depends on classes that are part of the Open API project and it can't find those classes. It might not find them because this is loaded from the Open API and if its an older version, those classes won't exist.
    
    Returns:
    a version of GradleInterfaceVersionX
  - getGradleUI
```
public U getGradleUI()
```
  - aboutToShow
```
public void aboutToShow()
```
    Call this whenever you're about to show this panel. We'll do whatever initialization is necessary.
  - canClose
```
public boolean canClose(BasicGradleUIVersion1.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.
    
    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.
  - getCurrentDirectory
```
public File getCurrentDirectory()
```
    Returns:
    the root directory of your gradle project.
  - setCurrentDirectory
```
public void setCurrentDirectory(File currentDirectory)
```
    Parameters:
    currentDirectory - the new root directory of your gradle project.
  - getGradleHomeDirectory
```
public File getGradleHomeDirectory()
```
    Returns:
    the gradle home directory. Where gradle is installed.
  - getCustomGradleExecutable
```
public 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
```
public 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
```
public void removeTab(GradleTabVersion1 gradleTabVersion1)
```
    Call this to remove one of your own tabs from this.
    
    Parameters:
    gradleTabVersion1 - the tab to remove
  - getGradleTabCount
```
public int getGradleTabCount()
```
  - getGradleTabName
```
public String getGradleTabName(int index)
```
    Parameters:
    index - the index of the tab
    
    Returns:
    the name of the tab at the specified index.
  - getGradleTabIndex
```
public 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
```
public int getCurrentGradleTab()
```
    Returns:
    the currently selected tab
  - setCurrentGradleTab
```
public void setCurrentGradleTab(int index)
```
    Makes the specified tab the current tab.
    
    Parameters:
    index - the index of the tab.
  - addCommandLineArgumentAlteringListener
```
public 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
```
public void removeCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListenerVersion1 listener)
```
  - getOutputLord
```
public OutputUILordVersion1 getOutputLord()
```
  - addOutputObserver
```
public void addOutputObserver(OutputObserverVersion1 observer)
```
  - removeOutputObserver
```
public void removeOutputObserver(OutputObserverVersion1 observer)
```
  - executeCommand
```
public 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
```
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.
  - isBusy
```
public boolean isBusy()
```
    Determines if commands are currently being executed or not.
    
    Returns:
    true if we're busy, false if not.
  - getOnlyShowOutputOnErrors
```
public 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
```
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.
    
    Parameters:
    component - the component to add.
  - setOutputTextFont
```
public void setOutputTextFont(Font font)
```
    Sets the font for the output text
    
    Parameters:
    font - the new font
  - getGradleInterfaceVersion1
```
public GradleInterfaceVersion1 getGradleInterfaceVersion1()
```
    Returns:
    an object that works with lower level gradle and contains the current projects and tasks.
  - getFavoritesEditor
```
public 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.

Class AbstractOpenAPIUIWrapper<U extends BasicGradleUI>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

settingsVersionWrapper

alternateUIInteractionVersionWrapper

gradleInterfaceWrapper

Constructor Detail

AbstractOpenAPIUIWrapper

Method Detail

initialize

instantiateGradleInterfaceWrapper

getGradleUI

aboutToShow

canClose

close

getCurrentDirectory

setCurrentDirectory

getGradleHomeDirectory

getCustomGradleExecutable

addTab

removeTab

getGradleTabCount

getGradleTabName

getGradleTabIndex

getCurrentGradleTab

setCurrentGradleTab

addCommandLineArgumentAlteringListener

removeCommandLineArgumentAlteringListener

getOutputLord

addOutputObserver

removeOutputObserver

executeCommand

refreshTaskTree

isBusy

getOnlyShowOutputOnErrors

setCustomPanelToSetupTab

setOutputTextFont

getGradleInterfaceVersion1

getFavoritesEditor