org.netbeans.modules.parsing.spi

Class Scheduler

java.lang.Object

org.netbeans.modules.parsing.spi.Scheduler

public abstract class Scheduler
extends Object

Scheduler defines when tasks should be started. Some SchedulerTasks (like syntax coloring) are current document sensitive only. It means that such SchedulerTask is automatically scheduled when currently edited document is changed. Other tasks may listen on different events. Implementation of Scheduler just listens on various IDE events, and call one of schedule() methods when something interesting happens. Implementation of Parsing API just finds all SchedulerTasks registered for this Scheduler and reschedules them. Implementation of this class should be registered in your manifest.xml file in "Editors/your mime type" folder.

Field Summary

Fields

Modifier and Type	Field and Description
static Class<? extends Scheduler>	CURSOR_SENSITIVE_TASK_SCHEDULER This implementations of Scheduler reschedules all tasks when: current document is changed (file opened, closed, editor tab switched), text in the current document is changed, cusor position is changed
static int	DEFAULT_REPARSE_DELAY Default reparse delay
static Class<? extends Scheduler>	EDITOR_SENSITIVE_TASK_SCHEDULER This implementations of Scheduler reschedules all tasks when: current document is changed (file opened, closed, editor tab switched), text in the current document is changed
static Class<? extends Scheduler>	SELECTED_NODES_SENSITIVE_TASK_SCHEDULER This implementations of Scheduler reschedules all tasks when nodes selected in editor are changed.

Constructor Summary

Constructors

Constructor and Description
Scheduler()

Method Summary

Modifier and Type	Method and Description
protected abstract SchedulerEvent	createSchedulerEvent(SourceModificationEvent event)
protected Source	getSource() Returns active Source.
protected void	schedule(SchedulerEvent event) Reschedule all tasks registered for this Scheduler (see SchedulerTask.getSchedulerClass().
protected void	schedule(Source source, SchedulerEvent event) Reschedule all tasks registered for this Scheduler (see SchedulerTask.getSchedulerClass(), and sets new Sources for them.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REPARSE_DELAY

public static final int DEFAULT_REPARSE_DELAY

Default reparse delay

See Also:

Constant Field Values

CURSOR_SENSITIVE_TASK_SCHEDULER

public static final Class<? extends Scheduler> CURSOR_SENSITIVE_TASK_SCHEDULER

This implementations of Scheduler reschedules all tasks when:

1. current document is changed (file opened, closed, editor tab switched),
2. text in the current document is changed,
3. cusor position is changed

EDITOR_SENSITIVE_TASK_SCHEDULER

public static final Class<? extends Scheduler> EDITOR_SENSITIVE_TASK_SCHEDULER

This implementations of Scheduler reschedules all tasks when:

1. current document is changed (file opened, closed, editor tab switched),
2. text in the current document is changed

SELECTED_NODES_SENSITIVE_TASK_SCHEDULER

public static final Class<? extends Scheduler> SELECTED_NODES_SENSITIVE_TASK_SCHEDULER

This implementations of Scheduler reschedules all tasks when nodes selected in editor are changed.

Constructor Detail

Scheduler

public Scheduler()

Method Detail

schedule

protected final void schedule(SchedulerEvent event)

Reschedule all tasks registered for this Scheduler (see SchedulerTask.getSchedulerClass().

schedule

protected final void schedule(Source source,
                              SchedulerEvent event)

Reschedule all tasks registered for this Scheduler (see SchedulerTask.getSchedulerClass(), and sets new Sources for them.

Parameters:

sources - A collection of Sources.

getSource

@CheckForNull
protected final Source getSource()

Returns active Source. The Scheduler subclasses should use this method to obtain the active Source rather than caching the Source them self.

Returns:

the Source currently handled by scheduler.

Since:

1.69

createSchedulerEvent

protected abstract SchedulerEvent createSchedulerEvent(SourceModificationEvent event)