org.netbeans.modules.progress.spi

Class Controller

java.lang.Object

org.netbeans.modules.progress.spi.Controller

public class Controller
extends Object

Since:

org.netbeans.api.progress/1 1.18

Field Summary

Fields

Modifier and Type	Field and Description
static Controller	defaultInstance
static int	INITIAL_DELAY initial delay for ading progress indication into the UI.

Constructor Summary

Constructors

Constructor and Description
Controller(ProgressUIWorker comp) Creates a new instance of Controller

Method Summary

Modifier and Type	Method and Description
protected ProgressUIWorkerWithModel	createWorker() Creates a worker.
static Controller	getDefault()
protected Executor	getEventExecutor() Executes runnable synchronously with controller's event dispatch.
TaskModel	getModel()
protected ProgressUIWorker	getProgressUIWorker() Retrieves the ProgressUIWorker instance.
protected void	resetTimer(int delay, boolean activate) The method is responsible to start or stop a timing service in the environment.
protected void	runEvents() Processes the queued events.
void	runNow()

Methods inherited from class java.lang.Object

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

Field Detail

defaultInstance

public static Controller defaultInstance

INITIAL_DELAY

public static final int INITIAL_DELAY

initial delay for ading progress indication into the UI. if finishes earlier, not shown at all, applies just to the status line (default) comtroller.

See Also:

Constant Field Values

Constructor Detail

Controller

public Controller(ProgressUIWorker comp)

Creates a new instance of Controller

Method Detail

getDefault

public static Controller getDefault()

createWorker

protected ProgressUIWorkerWithModel createWorker()

Creates a worker. The default implementation creates a trivial no-op worker. Subclasses should override to create a meaningful worker implementation.

Returns:

worker instance

getProgressUIWorker

protected final ProgressUIWorker getProgressUIWorker()

Retrieves the ProgressUIWorker instance. The instance is lazily created by calling Controller.createWorker().

Returns:

ProgressUIWorker instance

getModel

public TaskModel getModel()

resetTimer

protected void resetTimer(int delay,
                          boolean activate)

The method is responsible to start or stop a timing service in the environment. If "delay" is 0 or less, the method should stop the timer, or at least not call the Controller.runEvents() if the timer ticks.

If "delay" is positive, the method should configure the timer to fire after "delay" milliseconds. Depending on "restart" parameter, the timer should be just configured (false), or activated (true) - potentially canceling the previous schedule.

The default implementation uses RequestProcessor for scheduling.

Parameters:

delay - delay in milliseconds before the timer should fire

activate - if true, activate the changes immediately.

getEventExecutor

protected Executor getEventExecutor()

Executes runnable synchronously with controller's event dispatch. The method is used by Progress API to deliver other events which do not therefore interfere with Controller's own events. If called from the thread dispatching events, the executed Runnables will be delayed after the and may be interleaved by dispatched events.

The method must be overriden by a controller implementation which changes the threading model from the default one.

Returns:

the executor instance

Since:

1.44

runEvents

protected void runEvents()

Processes the queued events. Depending on environment, planning to a specific thread, or passing some specific information may be necessary.

runNow

public void runNow()