Package burp.api.montoya.ui.contextmenu

Interface WebSocketEditorEvent

All Superinterfaces:

ComponentEvent, ToolSource

public interface WebSocketEditorEvent
extends ComponentEvent, ToolSource

Method Summary

Modifier and Type	Method	Description
int	caretPosition()
ByteArray	getContents()
boolean	isReadOnly()
Optional<Range>	selectionOffsets()	This will return Optional.empty() if the user has not made a selection.
void	setContents(ByteArray contents)	This method can be used to set the content within the message editor programmatically.
WebSocketMessage	webSocketMessage()

Methods inherited from interface burp.api.montoya.ui.contextmenu.ComponentEvent

inputEvent

Methods inherited from interface burp.api.montoya.core.ToolSource

isFromTool, toolType

Method Details

getContents

ByteArray getContents()

Returns:

The contents of the message editor.

setContents

void setContents(ByteArray contents)

This method can be used to set the content within the message editor programmatically. If the editor is read only the contents will not be updated.

Parameters:

contents - The content to set in the message editor.

webSocketMessage

WebSocketMessage webSocketMessage()

Returns:

the WebSocket message used to populate the editor.

isReadOnly

boolean isReadOnly()

Returns:

if the editor is read only.

selectionOffsets

Optional<Range> selectionOffsets()

This will return Optional.empty() if the user has not made a selection.

Returns:

An Optional range of indices that indicates the position of the users current selection.

caretPosition

int caretPosition()

Returns:

The index of the position for the carat within the current message editor.