org.zaproxy.zap.view.messagelocation

Interface MessageLocationHighlighter

All Superinterfaces:

MessageLocationConsumer

All Known Subinterfaces:

SelectableContentHttpMessageContainer, SelectableContentMessageContainer<T>

All Known Implementing Classes:

HttpPanelComponentViewsManager, HttpRequestAllPanelSyntaxHighlightTextView, HttpRequestBodyPanelSyntaxHighlightTextView, HttpRequestHeaderPanelSyntaxHighlightTextView, RequestAllComponent, RequestSplitComponent, ResponseAllComponent, ResponseSplitComponent, SelectMessageLocationsPanel

public interface MessageLocationHighlighter
extends MessageLocationConsumer

A MessageLocationConsumer capable of highlighting locations.

Since:

2.4.0

See Also:

MessageLocationHighlight, MessageLocation

Method Summary

Modifier and Type	Method and Description
MessageLocationHighlight	highlight(MessageLocation location) Highlights the given location, with an undefined highlight.
MessageLocationHighlight	highlight(MessageLocation location, MessageLocationHighlight highlight) Highlights the given location with the given highlight.
void	removeHighlight(MessageLocation location, MessageLocationHighlight highlightReference) Removes a previous highlight.

Methods inherited from interface org.zaproxy.zap.model.MessageLocationConsumer

supports, supports

Method Detail

highlight

MessageLocationHighlight highlight(MessageLocation location)

Highlights the given location, with an undefined highlight.

Parameters:

location - the location that will be highlighted

Returns:

a reference to the highlight added, null if it's was not possible to highlight

highlight

MessageLocationHighlight highlight(MessageLocation location,
                                   MessageLocationHighlight highlight)

Highlights the given location with the given highlight.

Parameters:

location - the location that will be highlighted

highlight - the highlight applied to the location

Returns:

a reference to the highlight added, null if it's was not possible to highlight

removeHighlight

void removeHighlight(MessageLocation location,
                     MessageLocationHighlight highlightReference)

Removes a previous highlight.

Parameters:

location - the location of a previous highlight

highlightReference - a reference to a previous highlight