org.netbeans.spi.debugger.ui

Class PinWatchUISupport

java.lang.Object

org.netbeans.spi.debugger.ui.PinWatchUISupport

public final class PinWatchUISupport
extends Object

Access to the default UI implementation of pin watches in editor. Watches that are to be pinned by this support class, need to use the EditorPin as the Watch.getPin() and an implementation of PinWatchUISupport.ValueProvider needs to be register via DebuggerServiceRegistration, which acts as a supplier of the watch value.

Use PinWatchUISupport.pin(org.netbeans.api.debugger.Watch, java.lang.String) to pin the watch into editor where the corresponding EditorPin points at and provide valueProviderId of the corresponding registered PinWatchUISupport.ValueProvider which handles the value updates.

Since:

2.53

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PinWatchUISupport.ValueProvider Provider of pinned watch value.

Method Summary

Modifier and Type	Method and Description
static PinWatchUISupport	getDefault() Get the default instance of this class.
void	pin(Watch watch, String valueProviderId) Pin the watch into an editor.

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static PinWatchUISupport getDefault()

Get the default instance of this class.

Returns:

An instance of PinWatchUISupport class.

pin

public void pin(Watch watch,
                String valueProviderId)
         throws IllegalArgumentException

Pin the watch into an editor. The pinned watch need to return EditorPin from Watch.getPin() and a PinWatchUISupport.ValueProvider needs to be registered for the provided valueProviderId.

Parameters:

watch - A watch to pin at the location determined by the EditorPin.

valueProviderId - An id of a registered PinWatchUISupport.ValueProvider.

Throws:

IllegalArgumentException - is thrown when Watch.getPin() does not return an EditorPin, or when we're not able to find the editor where EditorPin points at.