ca.cgjennings.apps.arkham
Interface StrangeEonsEditor.HeartbeatListener

All Superinterfaces:

java.util.EventListener

Enclosing interface:

StrangeEonsEditor

public static interface StrangeEonsEditor.HeartbeatListener
extends java.util.EventListener

A listener to be called by an editor once per redraw update check. The rate of this check is set by the Preview Window Update Rate setting in the preferences dialog. Plug-ins can use this to write changes to a component as the user manipulates editor controls. If the listener returns true, this indicates that the listener has made changes to the component and it should be redrawn.

heartbeat

boolean heartbeat(StrangeEonsEditor editor)

The listener is being offered a chance to write changes to the component, and should return true is changes are written that require the preview to be redrawn.

Note that if the listener always returns true, then the preview window will not update, as pending updates are queued and drawn only when the queue stops growing.

Parameters:

editor - the editor that is processing a heartbeat

Returns:

true if the preview should be redrawn