org.zaproxy.zap.view.messagelocation

Interface MessageLocationProducer

All Known Subinterfaces:

SelectableContentHttpMessageContainer, SelectableContentMessageContainer<T>

All Known Implementing Classes:

HttpRequestAllPanelSyntaxHighlightTextView, HttpRequestBodyPanelSyntaxHighlightTextView, HttpRequestHeaderPanelSyntaxHighlightTextView, SelectMessageLocationsPanel

public interface MessageLocationProducer

A component capable of producing MessageLocations, normally through the UI.

Since:

2.4.0

See Also:

MessageLocation, MessageLocationProducerFocusListener

Method Summary

Modifier and Type	Method and Description
void	addFocusListener(MessageLocationProducerFocusListener focusListener) Adds the focus listener, starting to be notified of changes in the focus.
MessageLocationHighlightsManager	create() Creates a MessageLocationHighlightsManager responsible to manage the highlights of the message locations produced.
Class<? extends MessageLocation>	getMessageLocationClass() The type of MessageLocation that it can produce.
MessageLocation	getSelection() Obtains the current selected location.
void	removeFocusListener(MessageLocationProducerFocusListener focusListener) Removes the focus listener.

Method Detail

getMessageLocationClass

Class<? extends MessageLocation> getMessageLocationClass()

The type of MessageLocation that it can produce.

Returns:

the message location

getSelection

MessageLocation getSelection()

Obtains the current selected location.

Returns:

the selected location

addFocusListener

void addFocusListener(MessageLocationProducerFocusListener focusListener)

Adds the focus listener, starting to be notified of changes in the focus.

Parameters:

focusListener - the focus listener that will be removed

removeFocusListener

void removeFocusListener(MessageLocationProducerFocusListener focusListener)

Removes the focus listener.

Parameters:

focusListener - the focus listener that will be removed

create

MessageLocationHighlightsManager create()

Creates a MessageLocationHighlightsManager responsible to manage the highlights of the message locations produced.

Returns:

the MessageLocationHighlightsManager