org.netbeans.spi.tasklist

Class PushTaskScanner

java.lang.Object

org.netbeans.spi.tasklist.PushTaskScanner

public abstract class PushTaskScanner
extends Object

Task Scanner that can push new Tasks into Task List window.

You should use this scanner type if it takes too long to compute your tasks or if your tasks are calculated asynchronously.
In most cases it is easier to use FileTaskScanner instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PushTaskScanner.Callback Callback into Task List framework

Constructor Summary

Constructors

Constructor and Description
PushTaskScanner(String displayName, String description, String optionsPath) Creates a new instance of PushTaskScanner

Method Summary

Modifier and Type	Method and Description
abstract void	setScope(TaskScanningScope scope, PushTaskScanner.Callback callback) Called by the framework when the user switches to a different scanning scope or when the currently used scope needs to be refreshed.

Methods inherited from class java.lang.Object

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

Constructor Detail

PushTaskScanner

public PushTaskScanner(String displayName,
                       String description,
                       String optionsPath)

Creates a new instance of PushTaskScanner

Parameters:

displayName - Scanner's display name, will appear in Task List's filter window.

description - Scanner's description, will be used for tooltips.

optionsPath - Path that identifies panel in the global Options dialog window, or null if the scanner has no user settings. When scanner's settings changed the scanner must refresh its tasks the Task List window (PushTaskScanner.Callback.clearAllTasks(), PushTaskScanner.Callback.setTasks(org.openide.filesystems.FileObject, java.util.List<? extends org.netbeans.spi.tasklist.Task>)).

Method Detail

setScope

public abstract void setScope(TaskScanningScope scope,
                              PushTaskScanner.Callback callback)

Called by the framework when the user switches to a different scanning scope or when the currently used scope needs to be refreshed.

Parameters:

scope - New scanning scope, null value indicates that task scanning is to be cancelled.

callback - Callback into Task List framework.