Package burp.api.montoya.ui.editor

Interface WebSocketMessageEditor

All Superinterfaces:

Editor

public interface WebSocketMessageEditor
extends Editor

Provides extensions with an instance of Burp Suite's WebSocket message editor to use in their own user interface.

Method Summary

Modifier and Type	Method	Description
int	caretPosition()
ByteArray	getContents()
boolean	isModified()
Optional<Selection>	selection()	This will return Optional.empty() if the user has not made a selection.
void	setContents(ByteArray contents)	This method can be used to set content within the message editor programmatically
void	setSearchExpression(String expression)	Update the search expression that is shown in the search bar below the editor.
Component	uiComponent()

Method Details

getContents

ByteArray getContents()

Returns:

The contents of the message editor.

setContents

void setContents(ByteArray contents)

This method can be used to set content within the message editor programmatically

Parameters:

contents - The content to set in the message editor.

setSearchExpression

void setSearchExpression(String expression)

Update the search expression that is shown in the search bar below the editor.

Specified by:

setSearchExpression in interface Editor

Parameters:

expression - The search expression.

isModified

boolean isModified()

Specified by:

isModified in interface Editor

Returns:

True if the user has modified the contents of the editor since the last time the content was set programmatically.

caretPosition

int caretPosition()

Specified by:

caretPosition in interface Editor

Returns:

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

selection

Optional<Selection> selection()

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

Specified by:

selection in interface Editor

Returns:

An Optional containing the users current selection in the editor.

uiComponent

Component uiComponent()

Specified by:

uiComponent in interface Editor

Returns:

UI component of the editor, for extensions to add to their own UI.