public static interface PinWatchUISupport.ValueProvider
DebuggerServiceRegistration
for the corresponding debugger session ID path.Modifier and Type | Interface and Description |
---|---|
static interface |
PinWatchUISupport.ValueProvider.ValueChangeListener
Listener for watch value changes.
|
Modifier and Type | Method and Description |
---|---|
default String |
getEditableValue(Watch watch)
Determine whether the current watch value is editable and if yes,
return the value to edit.
|
default String |
getEvaluatingText()
Get a localized text to be displayed when the watch is being evaluated.
|
default Action[] |
getHeadActions(Watch watch)
Get actions to be displayed at the head of pin watch component.
|
String |
getId()
Get a unique ID of this value provider.
|
default Action[] |
getTailActions(Watch watch)
Get actions to be displayed at the tail of pin watch component.
|
String |
getValue(Watch watch)
Get current value of pinned watch.
|
void |
setChangeListener(Watch watch,
PinWatchUISupport.ValueProvider.ValueChangeListener chl)
Allows to set a value change listener for a specific watch.
|
default boolean |
setValue(Watch watch,
String value)
Set a watch value as a response to finished editing.
|
void |
unsetChangeListener(Watch watch)
Unset a value change listener for a specific watch.
|
String getId()
PinWatchUISupport.pin(org.netbeans.api.debugger.Watch, java.lang.String)
.String getValue(Watch watch)
PinWatchUISupport.ValueProvider.getEvaluatingText()
returns when the watch value is being computed,
or null
when the watch can not be resolved.watch
- the watch whose value is to be returned.PinWatchUISupport.ValueProvider.getEvaluatingText()
,
or null
.default String getEvaluatingText()
PinWatchUISupport.ValueProvider.getValue(org.netbeans.api.debugger.Watch)
when the watch is
being computed.default String getEditableValue(Watch watch)
PinWatchUISupport.ValueProvider.getValue(org.netbeans.api.debugger.Watch)
might not be the proper value to edit. It may contain type description
or more descriptive information about the value. This method should
provide a raw textual representation of the value to edit,
or null
when the value is not editable.null
.watch
- The watch to return the editable value fornull
when the value is not editable.default boolean setValue(Watch watch, String value)
PinWatchUISupport.ValueProvider.getEditableValue(org.netbeans.api.debugger.Watch)
returns
a non-null value.UnsupportedOperationException
.watch
- The watch to set the value for.value
- The new watch value.true
when the value was set successfully and
the UI should get updated from PinWatchUISupport.ValueProvider.getValue(org.netbeans.api.debugger.Watch)
,
false
when the set fails and the last watch value
should stay. The implementation is responsible for any error
reporting when the set fails.default Action[] getHeadActions(Watch watch)
null
.watch
- The watch to get the actions fornull
elements (for action separators),
or null
when no actions should be displayed.default Action[] getTailActions(Watch watch)
null
.watch
- The watch to get the actions fornull
elements (for action separators),
or null
when no actions should be displayed.void setChangeListener(Watch watch, PinWatchUISupport.ValueProvider.ValueChangeListener chl)
watch
- The watch to listen for changeschl
- The value change listener.void unsetChangeListener(Watch watch)
watch
- The watch to unset the listener from.