Package com.luciad.view.gxy

Class TLcdGXYCompositeLabelObstacleProvider

java.lang.Object
com.luciad.view.gxy.TLcdGXYCompositeLabelObstacleProvider
All Implemented Interfaces:
ILcdGXYLabelObstacleProvider
public class TLcdGXYCompositeLabelObstacleProvider extends Object implements ILcdGXYLabelObstacleProvider
Composite implementation of the ILcdGXYLabelObstacleProvider interface. This implementation returns the union of the label obstacles returned by the delegate label obstacle providers.
Since:
10.1

  • Constructor Details

    • TLcdGXYCompositeLabelObstacleProvider

      public TLcdGXYCompositeLabelObstacleProvider()

  • Method Details

    • getLabelObstacles

      public List getLabelObstacles(Graphics aGraphics, ILcdGXYView aGXYView)
      Description copied from interface: ILcdGXYLabelObstacleProvider
      Returns a java.util.List with objects of type TLcdGXYLabelObstacle.
      Specified by:
      getLabelObstacles in interface ILcdGXYLabelObstacleProvider
      Parameters:
      aGraphics - The graphics, provided as contextual info.
      aGXYView - The view, provided as contextual info.
      Returns:
      The java.util.List with TLcdGXYLabelObstacle objects. Implementations are allowed to return the same instance of the list for subsequent calls, to avoid recreating the same obstacles all the time. Therefore users of this method should not keep long term references, nor attempt to modify the returned list or the TLcdGXYLabelObstacle objects inside it.

    • addGXYLabelObstacleProvider

      public void addGXYLabelObstacleProvider(ILcdGXYLabelObstacleProvider aLabelObstacleProvider)
      Adds the given label obstacle provider to the list of delegate label obstacle providers.
      Parameters:
      aLabelObstacleProvider - the label obstacle provider to be added.

    • removeGXYLabelObstacleProvider

      public boolean removeGXYLabelObstacleProvider(ILcdGXYLabelObstacleProvider aLabelObstacleProvider)
      Removes the given label obstacle provider from the list of delegate label obstacle providers.
      Parameters:
      aLabelObstacleProvider - the label obstacle provider to be removed.
      Returns:
      true if the given label obstacle provider was removed, and false otherwise.

    • getLabelObstacleProviders

      public List<ILcdGXYLabelObstacleProvider> getLabelObstacleProviders()
      Returns the list of delegate label obstacle providers. Modifying this list will not influence the internal working of this class.
      Returns:
      the list of delegate label obstacle providers.