Package burp.api.montoya.ui

Interface UserInterface

public interface UserInterface

This interface gives you access to various user-interface-related features. Such as registering your own User Interface providers, creating instances of Burp's various editors and applying themes to custom components.

Method Summary

Modifier and Type	Method	Description
void	applyThemeToComponent(Component component)	Customize UI components in line with Burp's UI style, including font size, colors, table line spacing, etc.
HttpRequestEditor	createHttpRequestEditor(EditorOptions... options)	Create a new instance of Burp's HTTP request editor, for the extension to use in its own UI.
HttpResponseEditor	createHttpResponseEditor(EditorOptions... options)	Create a new instance of Burp's HTTP response editor, for the extension to use in its own UI.
RawEditor	createRawEditor(EditorOptions... options)	Create a new instance of Burp's plain text editor, for the extension to use in its own UI.
WebSocketMessageEditor	createWebSocketMessageEditor(EditorOptions... options)	Create a new instance of Burp's WebSocket message editor, for the extension to use in its own UI.
Font	currentDisplayFont()	Access Burp's font size.
Font	currentEditorFont()	Access the message editor's font type and size.
Theme	currentTheme()	Identify the theme currently being used.
MenuBar	menuBar()
void	openSettingsWindow()	Open Burp's Settings dialog.
Registration	registerContextMenuItemsProvider(ContextMenuItemsProvider provider)	This method can be used to register a provider of custom context menu items.
Registration	registerHotKeyHandler(HotKeyContext context, String hotKey, HotKeyHandler handler)	This method can be used to register hotkey handlers.
Registration	registerHttpRequestEditorProvider(HttpRequestEditorProvider provider)	This method can be used to register a provider of custom HTTP request editors.
Registration	registerHttpResponseEditorProvider(HttpResponseEditorProvider provider)	This method can be used to register a provider of custom HTTP response editors.
Registration	registerSettingsPanel(SettingsPanel settingsPanel)	This method can be used to register a settings panel within Burp's Settings dialog.
Registration	registerSuiteTab(String title, Component component)	Add a custom tab to the main Burp Suite window.
Registration	registerWebSocketMessageEditorProvider(WebSocketMessageEditorProvider provider)	This method can be used to register a provider of custom Web Socket message editors.
SwingUtils	swingUtils()

Method Details

menuBar

MenuBar menuBar()

Returns:

The Burp Suite MenuBar.

registerSuiteTab

Registration registerSuiteTab(String title,
 Component component)

Add a custom tab to the main Burp Suite window.

Parameters:

title - The text to be displayed in the tab heading.

component - The component that will be rendered within the custom tab.

Returns:

A Registration of the custom suite tab.

registerContextMenuItemsProvider

Registration registerContextMenuItemsProvider(ContextMenuItemsProvider provider)

This method can be used to register a provider of custom context menu items.

Parameters:

provider - The provider to register.

Returns:

A Registration of the context menu item provider.

registerHttpRequestEditorProvider

Registration registerHttpRequestEditorProvider(HttpRequestEditorProvider provider)

This method can be used to register a provider of custom HTTP request editors.

Parameters:

provider - The provider to register.

Returns:

A Registration of the HTTP request editor provider.

registerHttpResponseEditorProvider

Registration registerHttpResponseEditorProvider(HttpResponseEditorProvider provider)

This method can be used to register a provider of custom HTTP response editors.

Parameters:

provider - The provider to register.

Returns:

A Registration of the HTTP response editor provider.

registerWebSocketMessageEditorProvider

Registration registerWebSocketMessageEditorProvider(WebSocketMessageEditorProvider provider)

This method can be used to register a provider of custom Web Socket message editors.

Parameters:

provider - The provider to register.

Returns:

A Registration of the Web Socket message editor provider.

registerHotKeyHandler

Registration registerHotKeyHandler(HotKeyContext context,
 String hotKey,
 HotKeyHandler handler)

This method can be used to register hotkey handlers. Hotkeys are defined in the same format as within Burp's Settings.

Parameters:

context - context

hotKey - hotkey

handler - the handler to register

Returns:

A Registration of the Hot Key handler.

registerSettingsPanel

Registration registerSettingsPanel(SettingsPanel settingsPanel)

This method can be used to register a settings panel within Burp's Settings dialog.

Parameters:

settingsPanel - the settings panel to register

Returns:

A Registration of the settings panel.

createRawEditor

RawEditor createRawEditor(EditorOptions... options)

Create a new instance of Burp's plain text editor, for the extension to use in its own UI.

Parameters:

options - Optional options to apply to the editor.

Returns:

An instance of the RawEditor interface.

createWebSocketMessageEditor

WebSocketMessageEditor createWebSocketMessageEditor(EditorOptions... options)

Create a new instance of Burp's WebSocket message editor, for the extension to use in its own UI.

Parameters:

options - Optional options to apply to the editor.

Returns:

An instance of the WebSocketMessageEditor interface.

createHttpRequestEditor

HttpRequestEditor createHttpRequestEditor(EditorOptions... options)

Create a new instance of Burp's HTTP request editor, for the extension to use in its own UI.

Parameters:

options - Optional options to apply to the editor.

Returns:

An instance of the HttpRequestEditor interface.

createHttpResponseEditor

HttpResponseEditor createHttpResponseEditor(EditorOptions... options)

Create a new instance of Burp's HTTP response editor, for the extension to use in its own UI.

Parameters:

options - Optional options to apply to the editor.

Returns:

An instance of the HttpResponseEditor interface.

openSettingsWindow

void openSettingsWindow()

Open Burp's Settings dialog. If a custom SettingsPanel has been registered, it is selected automatically.

applyThemeToComponent

void applyThemeToComponent(Component component)

Customize UI components in line with Burp's UI style, including font size, colors, table line spacing, etc. The action is performed recursively on any child components of the passed-in component.

Parameters:

component - The component to be customized.

currentTheme

Theme currentTheme()

Identify the theme currently being used.

Returns:

The current Theme

currentEditorFont

Font currentEditorFont()

Access the message editor's font type and size.

Returns:

The current Font, as specified in the Settings dialog under the HTTP message display setting.

currentDisplayFont

Font currentDisplayFont()

Access Burp's font size.

Returns:

The current Font, as specified in the Settings dialog under the Appearance setting.

swingUtils

SwingUtils swingUtils()

Returns:

An instance of SwingUtils