Interface ILspLabelPriorityProvider


public interface ILspLabelPriorityProvider
A provider of priorities for labels. This interface can be used in implementations of ILspLabelingAlgorithm to control the order in which labels are placed.
Since:
2012.0
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPriority(TLspLabelID aLabel, TLspPaintState aPaintState, TLspContext aContext)
    Returns the priority for the given label, 0 being the highest priority, Integer.MAX_VALUE the lowest priority.
  • Method Details

    • getPriority

      int getPriority(TLspLabelID aLabel, TLspPaintState aPaintState, TLspContext aContext)
      Returns the priority for the given label, 0 being the highest priority, Integer.MAX_VALUE the lowest priority. Negative values are not allowed.
      Parameters:
      aLabel - the label for which to retrieve a priority
      aPaintState - the paint state, given as context info.
      aContext - the context.
      Returns:
      the priority for the given label.