Package ghidra.app.services
Interface MarkerSet
-
- All Superinterfaces:
java.lang.Comparable<MarkerSet>
public interface MarkerSet extends java.lang.Comparable<MarkerSet>
Defines methods for working with a set of addresses that correspond to markers.- See Also:
MarkerService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidadd(Address addr)Add a marker at the address.voidadd(AddressRange range)Add a marker across the address range.voidadd(Address start, Address end)Add the range given the start and end of the range.voidadd(AddressSetView addrSet)Add a marker at each address in the given address set.voidclear(Address addr)Clear any marker at the address.voidclear(AddressRange range)Clear any marker across the address range.voidclear(Address start, Address end)Remove the given range from the marker set.voidclear(AddressSetView addrSet)Clear any marker at each address in the address set.voidclearAll()Clear all defined markers.booleancontains(Address addr)Determine if this marker set contains the specified address.booleandisplayInMarkerBar()AddressSetgetAddressSet()Return the address set for this marker set.java.awt.ColorgetMarkerColor()Get the color for the marker.AddressgetMaxAddress()Returns the maximum Address in this MarkerSet;AddressgetMinAddress()Returns the minimum Address in this MarkerSet;java.lang.StringgetName()Return the name of this MarkerSet.intgetPriority()Get display priority.booleanintersects(Address start, Address end)Returns true if any address in this MarkerSet is contained in the range defined by start and end.booleanisActive()Returns true if this MarkerSet is active.booleanisColoringBackground()Returns true if this MarkerSet is coloring the background in the listing for locations contained in this MarkerSet.booleanisDisplayedInNavigationBar()booleanisPreferred()Gets whether this marker is in the preferred group when determining display priority.voidsetActive(boolean state)Return true if this marker set is active.voidsetAddressSet(AddressSetView set)Clears the current set off addresses in this markerSet and adds in the addresses from the given AddressSet.voidsetAddressSetCollection(AddressSetCollection set)Sets the AddressSetCollection to be used for this this marker set.voidsetColoringBackground(boolean b)Sets whether or not the MarkerSet is coloring the background of areas in the listing contained in this MarkerSet.voidsetMarkerColor(java.awt.Color color)Set the color for the marker.voidsetNavigationListener(MarkerListener listener)Set the marker manager listener to use for user interaction with markers owned by this manager.
-
-
-
Method Detail
-
add
void add(Address addr)
Add a marker at the address.
-
add
void add(AddressRange range)
Add a marker across the address range.
-
setAddressSetCollection
void setAddressSetCollection(AddressSetCollection set)
Sets the AddressSetCollection to be used for this this marker set.Warning! Using this method will cause this MarkerSet to directly use the given AddressSetCollection. If the given AddressSetCollection is not an instance of ModifiableAddressSetCollection, then the markerSet methods that add and remove addresses will thrown an IllegalArgumentException.
- Parameters:
set- the addressSetCollection to use as this markerSet's addressSetCollection.
-
setAddressSet
void setAddressSet(AddressSetView set)
Clears the current set off addresses in this markerSet and adds in the addresses from the given AddressSet.- Parameters:
set- the set of addresses to use in this marker set.
-
add
void add(AddressSetView addrSet)
Add a marker at each address in the given address set.
-
contains
boolean contains(Address addr)
Determine if this marker set contains the specified address.- Parameters:
addr- address- Returns:
- true if marker set contains addr.
-
getAddressSet
AddressSet getAddressSet()
Return the address set for this marker set.
-
clear
void clear(Address addr)
Clear any marker at the address.
-
clear
void clear(AddressRange range)
Clear any marker across the address range.
-
clear
void clear(Address start, Address end)
Remove the given range from the marker set.- Parameters:
start- the start of the range to remove.end- the end of the range to remove.
-
clear
void clear(AddressSetView addrSet)
Clear any marker at each address in the address set.
-
getName
java.lang.String getName()
Return the name of this MarkerSet.
-
clearAll
void clearAll()
Clear all defined markers.
-
getPriority
int getPriority()
Get display priority.
-
isPreferred
boolean isPreferred()
Gets whether this marker is in the preferred group when determining display priority. Typically point markers are in the preferred group and area markers are not.
-
setActive
void setActive(boolean state)
Return true if this marker set is active.
-
getMarkerColor
java.awt.Color getMarkerColor()
Get the color for the marker.
-
setMarkerColor
void setMarkerColor(java.awt.Color color)
Set the color for the marker.- Parameters:
color- marker color
-
setNavigationListener
void setNavigationListener(MarkerListener listener)
Set the marker manager listener to use for user interaction with markers owned by this manager.
-
isDisplayedInNavigationBar
boolean isDisplayedInNavigationBar()
- Returns:
- true if this marker manager displays in the right hand navigation bar.
-
displayInMarkerBar
boolean displayInMarkerBar()
- Returns:
- true if this marker manager displays in the left hand marker bar.
-
isColoringBackground
boolean isColoringBackground()
Returns true if this MarkerSet is coloring the background in the listing for locations contained in this MarkerSet.
-
isActive
boolean isActive()
Returns true if this MarkerSet is active. Being "active" means that it is displayed in the listing.
-
setColoringBackground
void setColoringBackground(boolean b)
Sets whether or not the MarkerSet is coloring the background of areas in the listing contained in this MarkerSet.- Parameters:
b- true to color the background.
-
getMinAddress
Address getMinAddress()
Returns the minimum Address in this MarkerSet;- Returns:
- the minimum Address in this MarkerSet;
-
getMaxAddress
Address getMaxAddress()
Returns the maximum Address in this MarkerSet;- Returns:
- the maximum Address in this MarkerSet;
-
intersects
boolean intersects(Address start, Address end)
Returns true if any address in this MarkerSet is contained in the range defined by start and end.- Parameters:
start- the start address of the range to check for intersection.end- the end address of the range to check for intersection.- Returns:
- true if the set of addresses contained in this MarkerSet intersects the given range.
-
-