org.gradle.gradleplugin.userinterface.swing.generic

Class OutputPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.gradle.gradleplugin.userinterface.swing.generic.OutputPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ExecuteGradleCommandServerProtocol.ExecutionInteraction

Direct Known Subclasses:

OutputTab

public class OutputPanel
extends JPanel
implements ExecuteGradleCommandServerProtocol.ExecutionInteraction

This is a panel that displays the results of executing a gradle command. It shows gradle's output as well as progress.

Author:

mhunsicker

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OutputPanel.OutputPanelParent

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
OutputPanel(GradlePluginLord gradlePluginLord, OutputPanel.OutputPanelParent parent, AlternateUIInteraction alternateUIInteraction)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canBeReusedNow() Determines if this panel is ready to be reused.
boolean	close()
boolean	getOnlyShowOutputOnErrors()
Request	getRequest()
void	initialize() Call this after initializing this, but after setting any additional swing properties (actually, just the font for now).
boolean	isBusy()
boolean	isPending()
boolean	isPinned()
void	reportExecutionFinished(boolean wasSuccessful, BuildResult buildResult, String output) Notification that execution of all tasks has completed.
void	reportExecutionFinished(boolean wasSuccessful, String output, Throwable throwable) Notification that execution of a task has completed.
void	reportExecutionStarted() Notification that execution of a task or tasks has been started.
void	reportFatalError(String message)
void	reportLiveOutput(String output) Report real-time output from gradle and its subsystems (such as ant).
void	reportNumberOfTasksToExecute(int size) Notification of the total number of tasks that will be executed.
void	reportTaskComplete(String currentTaskName, float percentComplete)
void	reportTaskStarted(String currentTaskName, float percentComplete) Notification that a single task has completed.
void	reset() Call this before you use this.
protected void	setBusy(boolean busy)
void	setFont(Font font) Sets the font for this component.
void	setOnlyShowOutputOnErrors(boolean value)
void	setPinned(boolean pinned)
void	setRequest(Request request, boolean onlyShowOutputOnErrors) This is called whenever a new request is made.
boolean	stop() This stops the currently executing task if any exists.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputPanel

public OutputPanel(GradlePluginLord gradlePluginLord,
           OutputPanel.OutputPanelParent parent,
           AlternateUIInteraction alternateUIInteraction)

Method Detail

initialize

public void initialize()

Call this after initializing this, but after setting any additional swing properties (actually, just the font for now). I really only added this as an optimization. Since we'll always be setting the font, I didn't want the various style objects created only to be thrown away and re-created. This way, you can set the font before we create the styles.

setRequest

public void setRequest(Request request,
              boolean onlyShowOutputOnErrors)

This is called whenever a new request is made. It associates this request with this output panel.

isPinned

public boolean isPinned()

setPinned

public void setPinned(boolean pinned)

isBusy

public boolean isBusy()

setBusy

protected void setBusy(boolean busy)

isPending

public boolean isPending()

getRequest

public Request getRequest()

reset

public void reset()

Call this before you use this. It resets its output as well as enabling buttons appropriately.

reportExecutionStarted

public void reportExecutionStarted()

Notification that execution of a task or tasks has been started.

Specified by:

reportExecutionStarted in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

reportNumberOfTasksToExecute

public void reportNumberOfTasksToExecute(int size)

Notification of the total number of tasks that will be executed. This is called after reportExecutionStarted and before any tasks are executed.

Specified by:

reportNumberOfTasksToExecute in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

Parameters:

size - the total number of tasks.

reportExecutionFinished

public void reportExecutionFinished(boolean wasSuccessful,
                           BuildResult buildResult,
                           String output)

Notification that execution of all tasks has completed. This is only called once at the end.

Parameters:

wasSuccessful - whether or not gradle encountered errors.

buildResult - contains more detailed information about the result of a build.

output - the text that gradle produced. May contain error information, but is usually just status.

reportExecutionFinished

public void reportExecutionFinished(boolean wasSuccessful,
                           String output,
                           Throwable throwable)

Notification that execution of a task has completed. This is the task you initiated and not for each subtask or dependent task.

Specified by:

reportExecutionFinished in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

Parameters:

wasSuccessful - whether or not gradle encountered errors.

output - the text that gradle produced. May contain error information, but is usually just status.

throwable - an exception if one occurred

reportTaskStarted

public void reportTaskStarted(String currentTaskName,
                     float percentComplete)

Notification that a single task has completed. Note: the task you kicked off probably executes other tasks.

Specified by:

reportTaskStarted in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

Parameters:

currentTaskName - the task being executed

percentComplete - the percent complete of all the tasks that make up the task you requested.

reportTaskComplete

public void reportTaskComplete(String currentTaskName,
                      float percentComplete)

Specified by:

reportTaskComplete in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

reportFatalError

public void reportFatalError(String message)

reportLiveOutput

public void reportLiveOutput(String output)

Report real-time output from gradle and its subsystems (such as ant).

Specified by:

reportLiveOutput in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

Parameters:

output - a single line of text to show.

canBeReusedNow

public boolean canBeReusedNow()

Determines if this panel is ready to be reused. Currently, if its not busy or pinned, it can be reused.

setOnlyShowOutputOnErrors

public void setOnlyShowOutputOnErrors(boolean value)

getOnlyShowOutputOnErrors

public boolean getOnlyShowOutputOnErrors()

close

public boolean close()

stop

public boolean stop()

This stops the currently executing task if any exists.

Returns:

true if the request stopped, false if not.

setFont

public void setFont(Font font)

Sets the font for this component.

Overrides:

setFont in class JComponent

Parameters:

font - the desired Font for this component

See Also:

Component.getFont()