org.scijava.event
Interface EventHistory

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HasPluginInfo, Prioritized, RichPlugin, SciJavaPlugin, Service

All Known Implementing Classes:

DefaultEventHistory

public interface EventHistory
extends Service

Interface for service that keeps a history of SciJava events.

Author:

Curtis Rueden

Method Summary

void	addListener(EventHistoryListener l) Adds an event history listener.
void	clear() Clears the recorded event history.
boolean	isActive() Gets whether event history tracking is currently active.
void	removeListener(EventHistoryListener l) Removes an event history listener.
void	setActive(boolean active) Activates or deactivates event history tracking.
String	toHTML(Set<Class<? extends SciJavaEvent>> filtered, Set<Class<? extends SciJavaEvent>> highlighted) Gets the recorded event history as an HTML string.

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

getPriority, setPriority

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

setActive

void setActive(boolean active)

Activates or deactivates event history tracking.

isActive

boolean isActive()

Gets whether event history tracking is currently active.

clear

void clear()

Clears the recorded event history.

toHTML

String toHTML(Set<Class<? extends SciJavaEvent>> filtered,
              Set<Class<? extends SciJavaEvent>> highlighted)

Gets the recorded event history as an HTML string.

Parameters:

filtered - Set of event types to filter out from the history.

highlighted - Set of event types to highlight in the history.

Returns:

An HTML string representing the recorded event history.

addListener

void addListener(EventHistoryListener l)

Adds an event history listener. This mechanism exists (rather than using the event bus) to avoid event feedback loops when reporting history changes.

removeListener

void removeListener(EventHistoryListener l)

Removes an event history listener. This mechanism exists (rather than using the event bus) to avoid event feedback loops when reporting history changes.