Package com.intellij.util.ui.update

Class MergingUpdateQueue

java.lang.Object

com.intellij.util.ui.update.MergingUpdateQueue

All Implemented Interfaces:

Disposable, Activatable, java.lang.Runnable

Direct Known Subclasses:

NavBarUpdateQueue

public class MergingUpdateQueue
extends java.lang.Object
implements java.lang.Runnable, Disposable, Activatable

Use this class to postpone task execution and optionally merge identical tasks. This is needed e.g. to reflect in UI status of some background activity: it doesn't make sense and would be inefficient to update UI 1000 times per second, so it's better to postpone 'update UI' task execution for e.g. 500ms and if new updates are added during this period they can be simply ignored.

Create instance of this class and use queue(Update) method to add new tasks.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Nested classes/interfaces inherited from interface com.intellij.util.ui.update.Activatable

Activatable.Adapter

Field Summary

Fields

Modifier and Type	Field and Description
static javax.swing.JComponent	ANY_COMPONENT

Constructor Summary

Constructors

Constructor and Description
MergingUpdateQueue(java.lang.String name, int mergingTimeSpan, boolean isActive, javax.swing.JComponent modalityStateComponent)
MergingUpdateQueue(java.lang.String name, int mergingTimeSpan, boolean isActive, javax.swing.JComponent modalityStateComponent, Disposable parent)
MergingUpdateQueue(java.lang.String name, int mergingTimeSpan, boolean isActive, javax.swing.JComponent modalityStateComponent, Disposable parent, javax.swing.JComponent activationComponent)
MergingUpdateQueue(java.lang.String name, int mergingTimeSpan, boolean isActive, javax.swing.JComponent modalityStateComponent, Disposable parent, javax.swing.JComponent activationComponent, Alarm.ThreadToUse thread)
MergingUpdateQueue(java.lang.String name, int mergingTimeSpan, boolean isActive, javax.swing.JComponent modalityStateComponent, Disposable parent, javax.swing.JComponent activationComponent, boolean executeInDispatchThread)

Method Summary

Modifier and Type	Method and Description
void	activate()
void	cancelAllUpdates()
void	deactivate()
void	dispose() Usually not invoked directly, see class javadoc.
protected void	execute(Update [] update)
void	flush()
ModalityState	getModalityState()
void	hideNotify()
boolean	isActive()
boolean	isEmpty()
boolean	isFlushing()
protected boolean	isModalityStateCorrect()
boolean	isPassThrough()
boolean	isSuspended()
void	queue(Update update) Adds a task to be executed.
void	restartTimer()
void	resume()
void	run()
void	run(Update update)
void	sendFlush()
void	setActivationComponent(javax.swing.JComponent c)
void	setMergingTimeSpan(int timeSpan)
void	setModalityStateComponent(javax.swing.JComponent modalityStateComponent)
void	setPassThrough(boolean passThrough)
MergingUpdateQueue	setRestartTimerOnAdd(boolean restart)
void	setTrackUiActivity(boolean trackUiActivity)
void	showNotify()
void	suspend()
java.lang.String	toString()
MergingUpdateQueue	usePassThroughInUnitTestMode() Switches on the PassThrough mode if this method is called during testing.

Methods inherited from class java.lang.Object

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

Field Detail

ANY_COMPONENT

public static final javax.swing.JComponent ANY_COMPONENT

Constructor Detail

MergingUpdateQueue

public MergingUpdateQueue(java.lang.String name,
                          int mergingTimeSpan,
                          boolean isActive,
                          javax.swing.JComponent modalityStateComponent)

MergingUpdateQueue

public MergingUpdateQueue(java.lang.String name,
                          int mergingTimeSpan,
                          boolean isActive,
                          javax.swing.JComponent modalityStateComponent,
                          Disposable parent)

MergingUpdateQueue

public MergingUpdateQueue(java.lang.String name,
                          int mergingTimeSpan,
                          boolean isActive,
                          javax.swing.JComponent modalityStateComponent,
                          Disposable parent,
                          javax.swing.JComponent activationComponent)

MergingUpdateQueue

public MergingUpdateQueue(java.lang.String name,
                          int mergingTimeSpan,
                          boolean isActive,
                          javax.swing.JComponent modalityStateComponent,
                          Disposable parent,
                          javax.swing.JComponent activationComponent,
                          boolean executeInDispatchThread)

MergingUpdateQueue

public MergingUpdateQueue(java.lang.String name,
                          int mergingTimeSpan,
                          boolean isActive,
                          javax.swing.JComponent modalityStateComponent,
                          Disposable parent,
                          javax.swing.JComponent activationComponent,
                          Alarm.ThreadToUse thread)

Parameters:

name - name of this queue, used only for debugging purposes

mergingTimeSpan - time (in milliseconds) for which execution of tasks will be postponed

isActive - if true the queue will execute tasks otherwise it'll just collect them and execute only after activate() is called

modalityStateComponent - makes sense only if thread is SWING_THREAD, in that case the tasks will be processed in ModalityState corresponding the given component

parent - if not null the queue will be disposed when the given parent is disposed

activationComponent - if not null the tasks will be processing only when the given component is showing

thread - specifies on which thread the tasks are executed

Method Detail

setMergingTimeSpan

public void setMergingTimeSpan(int timeSpan)

cancelAllUpdates

public void cancelAllUpdates()

isPassThrough

public final boolean isPassThrough()

setPassThrough

public final void setPassThrough(boolean passThrough)

Parameters:

passThrough - if true the tasks won't be postponed but executed immediately instead

usePassThroughInUnitTestMode

public final MergingUpdateQueue usePassThroughInUnitTestMode()

Switches on the PassThrough mode if this method is called during testing. It is needed to support some old tests, which expect such behaviour.

Returns:

this instance for the sequential creation (the Builder pattern)

activate

public void activate()

deactivate

public void deactivate()

suspend

public void suspend()

resume

public void resume()

hideNotify

public void hideNotify()

Specified by:

hideNotify in interface Activatable

showNotify

public void showNotify()

Specified by:

showNotify in interface Activatable

restartTimer

public void restartTimer()

run

public void run()

Specified by:

run in interface java.lang.Runnable

flush

public void flush()

setModalityStateComponent

public void setModalityStateComponent(javax.swing.JComponent modalityStateComponent)

isModalityStateCorrect

protected boolean isModalityStateCorrect()

isSuspended

public boolean isSuspended()

execute

protected void execute(Update [] update)

queue

public void queue(Update update)

Adds a task to be executed.

run

public final void run(Update update)

isActive

public boolean isActive()

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getModalityState

public ModalityState getModalityState()

setActivationComponent

public void setActivationComponent(javax.swing.JComponent c)

setRestartTimerOnAdd

public MergingUpdateQueue setRestartTimerOnAdd(boolean restart)

isEmpty

public boolean isEmpty()

sendFlush

public void sendFlush()

isFlushing

public boolean isFlushing()

setTrackUiActivity

public void setTrackUiActivity(boolean trackUiActivity)