Interface ListingMarginProvider
public interface ListingMarginProvider
Interface for objects that want to add a component to the listing's left margin.
-
Method Summary
Modifier and TypeMethodDescriptionvoiddispose()Called when the client is done with this provider.Get the component to show the margin markers.getMarkerLocation(int x, int y) Get the marker location for the given x, y point.booleanReturn true if can be resized.voidscreenDataChanged(ListingPanel listingPanel, AddressIndexMap addressIndexMap, VerticalPixelAddressMap pixelMap) Called to notify this margin provider that the current screen information has changed.voidsetLocation(ProgramLocation location) Called from the client when their location changes internally.voidsetOwnerId(UniversalID ownerId) Sets an optional owner ID that signals when the markers for this provider should be painted.
-
Method Details
-
setOwnerId
Sets an optional owner ID that signals when the markers for this provider should be painted. A null ID means that this provider is a non-snapshot provider and should paint all markers. A non-null ID means this provider's markers will be painted when the marker's owner ID this provider's ID .- Parameters:
ownerId- the ID
-
getComponent
JComponent getComponent()Get the component to show the margin markers.- Returns:
- the component
-
isResizeable
boolean isResizeable()Return true if can be resized.- Returns:
- true if can be resized.
-
screenDataChanged
void screenDataChanged(ListingPanel listingPanel, AddressIndexMap addressIndexMap, VerticalPixelAddressMap pixelMap) Called to notify this margin provider that the current screen information has changed.- Parameters:
listingPanel- the listing panel.addressIndexMap- the address index map to use.pixelMap- the vertical pixel map to use.
-
setLocation
Called from the client when their location changes internally. This is different from a tool location event, which is considered a global event.- Parameters:
location- the location
-
getMarkerLocation
Get the marker location for the given x, y point.- Parameters:
x- the horizontal coordinate.y- the vertical coordinate.- Returns:
- the location
-
dispose
void dispose()Called when the client is done with this provider.
-