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 Burps various editors and applying themes to custom components.

    • Method Detail

      • registerSuiteTab

        Registration registerSuiteTab​(java.lang.String title,
                              java.awt.Component component)
        This method is used to 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​(ExtensionHttpRequestEditorProvider 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​(ExtensionHttpResponseEditorProvider 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.

      • createRawEditor

        RawEditor createRawEditor​(EditorOptions... options)
        This method is used to 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.

      • createHttpRequestEditor

        HttpRequestEditor createHttpRequestEditor​(EditorOptions... options)
        This method is used to 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)
        This method is used to 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.

      • applyThemeToComponent

        void applyThemeToComponent​(java.awt.Component component)
        This method is used to 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()
        This method is used to identify the theme currently being used.
        Returns:
        the current Theme