org.gradle.gradleplugin.userinterface.swing.generic

Class TaskTreeComponent

java.lang.Object

org.gradle.gradleplugin.userinterface.swing.generic.TaskTreeComponent

public class TaskTreeComponent
extends Object

This displays a tree of projects, subprojects, and tasks. You implement the Interaction to detemine how to handle right clicks and double clicking tasks. To use this, call populate and pass it a filter (allows you to change exactly what is displayed). There are several functions to obtaining the selected items, plus you can get the tree directly for any advanced functionality.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TaskTreeComponent.Interaction
class	TaskTreeComponent.MultipleSelection Object to hold onto mutliple selections, but not just multiples of the same type of node.
class	TaskTreeComponent.ProjectTreeNode This represents a project.
class	TaskTreeComponent.TaskTreeBaseNode This is a basic tree node.
class	TaskTreeComponent.TaskTreeNode This represents a single task.

Constructor Summary

Constructors

Constructor and Description
TaskTreeComponent(GradlePluginLord gradlePluginLord, TaskTreeComponent.Interaction interaction)

Method Summary

Methods

Modifier and Type	Method and Description
TaskTreeComponent.TaskTreeBaseNode	getFirstSelectedNode()
TaskTreeComponent.TaskTreeBaseNode	getNodeAtPoint(Point point) Returns the node at the specified point.
List<TaskTreeComponent.TaskTreeBaseNode>	getSelectedNodes()
TaskTreeComponent.MultipleSelection	getSelectedProjectsAndTasks() This returns the current selection broken up into projects and tasks.
List<TaskView>	getSelectedTasks() This returns a list of selected tasks.
JTree	getTree()
boolean	hasProjectsSelected() Determines if we have any projects selected.
boolean	hasTasksSelected() Determines if we have any tasks selected.
boolean	isPopulated()
void	populate(ProjectAndTaskFilter filter) This populates (and repopulates) the tree.
void	setShowDescription(boolean showDescription)
void	setTreeCellRenderer(TreeCellRenderer renderer)
boolean	showDescription()

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskTreeComponent

public TaskTreeComponent(GradlePluginLord gradlePluginLord,
                 TaskTreeComponent.Interaction interaction)

Method Detail

getTree

public JTree getTree()

setTreeCellRenderer

public void setTreeCellRenderer(TreeCellRenderer renderer)

populate

public void populate(ProjectAndTaskFilter filter)

This populates (and repopulates) the tree. This is surprisingly tedious in an effort to make the tree collapse as little as possible.

isPopulated

public boolean isPopulated()

getNodeAtPoint

public TaskTreeComponent.TaskTreeBaseNode getNodeAtPoint(Point point)

Returns the node at the specified point.

getFirstSelectedNode

public TaskTreeComponent.TaskTreeBaseNode getFirstSelectedNode()

Returns:

the first selected node or null if nothing is selected.

getSelectedNodes

public List<TaskTreeComponent.TaskTreeBaseNode> getSelectedNodes()

Returns:

a list of TaskTabTreeNode based on what is selected in the tree or an empty list if nothing is selected.

hasProjectsSelected

public boolean hasProjectsSelected()

Determines if we have any projects selected. This ignores selected tasks.

Returns:

true if we have projects selected, false otherwise.

hasTasksSelected

public boolean hasTasksSelected()

Determines if we have any tasks selected. This ignores selected projects.

Returns:

true if we have tasks selected, false otherwise.

getSelectedTasks

public List<TaskView> getSelectedTasks()

This returns a list of selected tasks. This ignores selected projects. Note: the tasks are ordered according to the order in which they were selected.

Returns:

the selected tasks. Will return an empty list if no tasks are selected.

getSelectedProjectsAndTasks

public TaskTreeComponent.MultipleSelection getSelectedProjectsAndTasks()

This returns the current selection broken up into projects and tasks.

Returns:

the selected projects and tasks. This never returns null and the contained lists are never null.

showDescription

public boolean showDescription()

setShowDescription

public void setShowDescription(boolean showDescription)