Package burp.api.montoya.ui.editor
Interface Editor
-
- All Known Subinterfaces:
HttpRequestEditor,HttpResponseEditor,RawEditor
public interface EditorThis interface provides the shared behaviour between the different editor types available from the Extensions API.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description intcaretPosition()booleanisModified()java.util.Optional<Selection>selection()This will returnOptional.empty()if the user has not made a selection.voidsetSearchExpression(java.lang.String expression)This method is used to update the search expression that is shown in the search bar below the editor.javax.swing.JComponentuiComponent()
-
-
-
Method Detail
-
setSearchExpression
void setSearchExpression(java.lang.String expression)
This method is used to update the search expression that is shown in the search bar below the editor.- Parameters:
expression- The search expression.
-
isModified
boolean isModified()
- Returns:
- True if the user has modified the contents of the editor since the last time the content was set programmatically.
-
caretPosition
int caretPosition()
- Returns:
- The index of the position for the carat within the current message editor.
-
selection
java.util.Optional<Selection> selection()
This will returnOptional.empty()if the user has not made a selection.- Returns:
- An
Optionalcontaining the users current selection in the editor.
-
uiComponent
javax.swing.JComponent uiComponent()
- Returns:
- UI component of the editor, for extensions to add to their own UI.
-
-