org.zaproxy.zap.extension.httppanel.view.syntaxhighlight.components.split.request

Class HttpRequestHeaderPanelSyntaxHighlightTextView

java.lang.Object

org.zaproxy.zap.extension.httppanel.view.syntaxhighlight.HttpPanelSyntaxHighlightTextView

org.zaproxy.zap.extension.httppanel.view.syntaxhighlight.components.split.request.HttpRequestHeaderPanelSyntaxHighlightTextView

All Implemented Interfaces:

EventListener, HttpPanelView, HttpPanelViewModelListener, SearchableHttpPanelView, MessageLocationConsumer, HttpMessageContainer, SelectableContentHttpMessageContainer, SingleHttpMessageContainer, MessageContainer<HttpMessage>, SelectableContentMessageContainer<HttpMessage>, SingleMessageContainer<HttpMessage>, MessageLocationHighlighter, MessageLocationProducer

public class HttpRequestHeaderPanelSyntaxHighlightTextView
extends HttpPanelSyntaxHighlightTextView
implements SelectableContentHttpMessageContainer

Nested Class Summary

Nested classes/interfaces inherited from class org.zaproxy.zap.extension.httppanel.view.syntaxhighlight.HttpPanelSyntaxHighlightTextView

HttpPanelSyntaxHighlightTextView.CustomPopupMenu

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from class org.zaproxy.zap.extension.httppanel.view.syntaxhighlight.HttpPanelSyntaxHighlightTextView

DEFAULT_MESSAGE_CONTAINER_NAME

Constructor Summary

Constructors

Constructor and Description
HttpRequestHeaderPanelSyntaxHighlightTextView(RequestHeaderStringHttpPanelViewModel model)

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.
protected HttpPanelSyntaxHighlightTextArea	createHttpPanelTextArea()
Component	getComponent() Returns the GUI component of the message container.
protected org.zaproxy.zap.extension.httppanel.view.syntaxhighlight.components.split.request.HttpRequestHeaderPanelSyntaxHighlightTextView.HttpRequestHeaderPanelSyntaxHighlightTextArea	getHttpPanelTextArea()
HttpMessage	getMessage() Returns the contained message.
Class<HttpMessage>	getMessageClass() Returns the Class of the container's message, for use as runtime type token.
Class<? extends MessageLocation>	getMessageLocationClass() The type of MessageLocation that it can produce.
String	getName() Returns the name of the message container.
MessageLocation	getSelection() Obtains the current selected location.
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.
boolean	isEmpty() Tells whether or not the message container is empty, that is, doesn't contain any message.
void	removeFocusListener(MessageLocationProducerFocusListener focusListener) Removes the focus listener.
void	removeHighlight(MessageLocation location, MessageLocationHighlight highlightReference) Removes a previous highlight.
boolean	supports(Class<? extends MessageLocation> classLocation) If this replacer handles the given type of location, for example, when using a AMF replacer it would not handle other locations than AMFLocation and a "text" replacer would not handle AMF locations
boolean	supports(MessageLocation location) If this replacer handles the given type of location, for example, when using a AMF replacer it would not handle other locations than AMFLocation and a "text" replacer would not handle AMF locations

Methods inherited from class org.zaproxy.zap.extension.httppanel.view.syntaxhighlight.HttpPanelSyntaxHighlightTextView

dataChanged, getCaptionName, getModel, getPane, getPosition, getTargetViewName, hasChanged, highlight, isEditable, isEnabled, loadConfiguration, save, saveConfiguration, search, setEditable, setParentConfigurationKey, setSelected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

HttpRequestHeaderPanelSyntaxHighlightTextView

public HttpRequestHeaderPanelSyntaxHighlightTextView(RequestHeaderStringHttpPanelViewModel model)

Method Detail

createHttpPanelTextArea

protected HttpPanelSyntaxHighlightTextArea createHttpPanelTextArea()

Specified by:

createHttpPanelTextArea in class HttpPanelSyntaxHighlightTextView

getHttpPanelTextArea

protected org.zaproxy.zap.extension.httppanel.view.syntaxhighlight.components.split.request.HttpRequestHeaderPanelSyntaxHighlightTextView.HttpRequestHeaderPanelSyntaxHighlightTextArea getHttpPanelTextArea()

Overrides:

getHttpPanelTextArea in class HttpPanelSyntaxHighlightTextView

getName

public String getName()

Description copied from interface: MessageContainer

Returns the name of the message container.

The name should be unique among other containers since it will be used to uniquely identify them.

Specified by:

getName in interface HttpPanelView

Specified by:

getName in interface MessageContainer<HttpMessage>

Overrides:

getName in class HttpPanelSyntaxHighlightTextView

Returns:

the name of the container, never null.

getMessageClass

public Class<HttpMessage> getMessageClass()

Description copied from interface: MessageContainer

Returns the Class of the container's message, for use as runtime type token.

Specified by:

getMessageClass in interface MessageContainer<HttpMessage>

Returns:

the Class of the container's message.

getMessageLocationClass

public Class<? extends MessageLocation> getMessageLocationClass()

Description copied from interface: MessageLocationProducer

The type of MessageLocation that it can produce.

Specified by:

getMessageLocationClass in interface MessageLocationProducer

Returns:

the message location

getSelection

public MessageLocation getSelection()

Description copied from interface: MessageLocationProducer

Obtains the current selected location.

Specified by:

getSelection in interface MessageLocationProducer

Returns:

the selected location

create

public MessageLocationHighlightsManager create()

Description copied from interface: MessageLocationProducer

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

Specified by:

create in interface MessageLocationProducer

Returns:

the MessageLocationHighlightsManager

highlight

public MessageLocationHighlight highlight(MessageLocation location)

Description copied from interface: MessageLocationHighlighter

Highlights the given location, with an undefined highlight.

Specified by:

highlight in interface MessageLocationHighlighter

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

public MessageLocationHighlight highlight(MessageLocation location,
                                          MessageLocationHighlight highlight)

Description copied from interface: MessageLocationHighlighter

Highlights the given location with the given highlight.

Specified by:

highlight in interface MessageLocationHighlighter

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

public void removeHighlight(MessageLocation location,
                            MessageLocationHighlight highlightReference)

Description copied from interface: MessageLocationHighlighter

Removes a previous highlight.

Specified by:

removeHighlight in interface MessageLocationHighlighter

Parameters:

location - the location of a previous highlight

highlightReference - a reference to a previous highlight

supports

public boolean supports(MessageLocation location)

Description copied from interface: MessageLocationConsumer

If this replacer handles the given type of location, for example, when using a AMF replacer it would not handle other locations than AMFLocation and a "text" replacer would not handle AMF locations

Specified by:

supports in interface MessageLocationConsumer

Parameters:

location - the location being checked

Returns:

true if the location is supported, false otherwise

supports

public boolean supports(Class<? extends MessageLocation> classLocation)

Description copied from interface: MessageLocationConsumer

If this replacer handles the given type of location, for example, when using a AMF replacer it would not handle other locations than AMFLocation and a "text" replacer would not handle AMF locations

Specified by:

supports in interface MessageLocationConsumer

Parameters:

classLocation - the class of the location being checked

Returns:

true if the location is supported, false otherwise

addFocusListener

public void addFocusListener(MessageLocationProducerFocusListener focusListener)

Description copied from interface: MessageLocationProducer

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

Specified by:

addFocusListener in interface MessageLocationProducer

Parameters:

focusListener - the focus listener that will be removed

removeFocusListener

public void removeFocusListener(MessageLocationProducerFocusListener focusListener)

Description copied from interface: MessageLocationProducer

Removes the focus listener.

Specified by:

removeFocusListener in interface MessageLocationProducer

Parameters:

focusListener - the focus listener that will be removed

getMessage

public HttpMessage getMessage()

Description copied from interface: SingleMessageContainer

Returns the contained message. Might be null if no message is present or an error occurred while getting the message (for example, failed to read a persisted message).

Specified by:

getMessage in interface SingleMessageContainer<HttpMessage>

Returns:

the contained message or null if not present or an error occurred while getting the message.

getComponent

public Component getComponent()

Description copied from interface: MessageContainer

Returns the GUI component of the message container.

Actual type of the component depends on the implementation, example component types: JList, JTable, JTextArea, ...

Specified by:

getComponent in interface MessageContainer<HttpMessage>

Returns:

the GUI component of the container, never null.

isEmpty

public boolean isEmpty()

Description copied from interface: MessageContainer

Tells whether or not the message container is empty, that is, doesn't contain any message.

Specified by:

isEmpty in interface MessageContainer<HttpMessage>

Returns:

true if the container is empty, false otherwise.