Package ghidra.app.util.viewer.field

Class CommentFieldMouseHandler

java.lang.Object

ghidra.app.util.viewer.field.CommentFieldMouseHandler

All Implemented Interfaces:

FieldMouseHandler, FieldMouseHandlerExtension, ExtensionPoint

Direct Known Subclasses:

FunctionRepeatableCommentFieldMouseHandler, VariableCommentFieldMouseHandler

public class CommentFieldMouseHandler
extends java.lang.Object
implements FieldMouseHandlerExtension

A handler to process CommentFieldLocation clicks.

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.util.classfinder.ExtensionPoint

ExtensionPoint.Exclude, ExtensionPoint.Util

Constructor Summary

Constructors

Constructor	Description
CommentFieldMouseHandler()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkWord(java.lang.String wordString, ServiceProvider serviceProvider, Navigatable sourceNavigatable)
boolean	fieldElementClicked(java.lang.Object clickedObject, Navigatable sourceNavigatable, ProgramLocation location, java.awt.event.MouseEvent mouseEvent, ServiceProvider serviceProvider)	Called when a field Field has been clicked.
protected java.lang.String[]	getComment(ProgramLocation programLocation)
protected int	getCommentColumn(ProgramLocation programLocation)
protected int	getCommentRow(ProgramLocation programLocation)
java.lang.Class<?>[]	getSupportedProgramLocations()	Returns an array of types that this handler wishes to handle.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentFieldMouseHandler

public CommentFieldMouseHandler()

Method Detail

getSupportedProgramLocations

public java.lang.Class<?>[] getSupportedProgramLocations()

Description copied from interface: FieldMouseHandler

Returns an array of types that this handler wishes to handle.

Specified by:

getSupportedProgramLocations in interface FieldMouseHandler

Returns:

an array of types that this handler wishes to handle.

See Also:

FieldMouseHandler.getSupportedProgramLocations()

fieldElementClicked

public boolean fieldElementClicked(java.lang.Object clickedObject,
                                   Navigatable sourceNavigatable,
                                   ProgramLocation location,
                                   java.awt.event.MouseEvent mouseEvent,
                                   ServiceProvider serviceProvider)

Description copied from interface: FieldMouseHandler

Called when a field Field has been clicked. The object being passed in may be of any type, as returned by the clicked field. The type is guaranteed to be one of the types returned in the call to FieldMouseHandler.getSupportedProgramLocations().

Specified by:

fieldElementClicked in interface FieldMouseHandler

Parameters:

clickedObject - The object that was clicked

sourceNavigatable - The source navigatable that was clicked upon.

location - The location at the time the click was made. Due to swing delay, this location may not be the same as you would get if you asked the navagatable for the current location.SC

mouseEvent - The mouse event that triggered the click

serviceProvider - A service provider used to access system resources.

Returns:

true if this handler wishes to have exclusive handling rights to processing the clickedObject

See Also:

FieldMouseHandlerExtension#fieldElementClicked(Object, Navigatable, MouseEvent, ServiceProvider)

getCommentRow

protected int getCommentRow(ProgramLocation programLocation)

getCommentColumn

protected int getCommentColumn(ProgramLocation programLocation)

getComment

protected java.lang.String[] getComment(ProgramLocation programLocation)

checkWord

protected boolean checkWord(java.lang.String wordString,
                            ServiceProvider serviceProvider,
                            Navigatable sourceNavigatable)