org.gradle.gradleplugin.userinterface.swing.generic

Class OutputTextPane

java.lang.Object

org.gradle.gradleplugin.userinterface.swing.generic.OutputTextPane

public class OutputTextPane
extends Object

Rich text pane meant to simplify adding text, scrolling, prevent line wrapping, and highlighting FileLinks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OutputTextPane.Interaction This allows us to interact with our parent control.

Constructor Summary

Constructors

Constructor and Description
OutputTextPane(OutputTextPane.Interaction interaction, boolean allowsClickingFiles, Font font, FileLinkDefinitionLord fileLinkDefinitionLord)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsClickingFiles()
void	appendText(String text) This appends the text to gradle's output window.
JComponent	asComponent()
AttributeSet	getDefaultStyle()
FileLink	getFileLinkAt(Point point) Returns the FileLink at the specified point.
FileLink	getNextFileLink() Returns the next file link relative to the specified file link.
FileLink	getPreviousFileLink() Returns the previous file link relative to the specified file link.
String	getText()
JTextPane	getTextComponent()
boolean	hasClickableLinks()
void	resetHighlights() Call this if you've changed any styles of our text and want to revert it back to the defaults.
void	selectFileLink(FileLink fileLink) Selects and scrolls to the specified file link
void	setFont(Font font)
void	setText(String text) This sets the full text of this control, removing existing text.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputTextPane

public OutputTextPane(OutputTextPane.Interaction interaction,
              boolean allowsClickingFiles,
              Font font,
              FileLinkDefinitionLord fileLinkDefinitionLord)

Method Detail

getDefaultStyle

public AttributeSet getDefaultStyle()

asComponent

public JComponent asComponent()

Returns:

the component you would use to insert this control into a container. Its actually the scroll pane.

getTextComponent

public JTextPane getTextComponent()

getText

public String getText()

appendText

public void appendText(String text)

This appends the text to gradle's output window.

setText

public void setText(String text)

This sets the full text of this control, removing existing text.

Parameters:

text - the new text of this control

getFileLinkAt

public FileLink getFileLinkAt(Point point)

Returns the FileLink at the specified point.

Parameters:

point - the point where a FileLink may or may not be

Returns:

a FileLink object if one exists at the specified point, null otherwise.

setFont

public void setFont(Font font)

hasClickableLinks

public boolean hasClickableLinks()

allowsClickingFiles

public boolean allowsClickingFiles()

selectFileLink

public void selectFileLink(FileLink fileLink)

Selects and scrolls to the specified file link

getPreviousFileLink

public FileLink getPreviousFileLink()

Returns the previous file link relative to the specified file link. If you pass in null, we'll return the last one.

getNextFileLink

public FileLink getNextFileLink()

Returns the next file link relative to the specified file link. If you pass in null, we'll return the first one.

resetHighlights

public void resetHighlights()

Call this if you've changed any styles of our text and want to revert it back to the defaults.