Interface ILcyGXYLayerOrderManager

All Known Implementing Classes:
TLcyGXYLayerOrderManager

public interface ILcyGXYLayerOrderManager
Manages the layer ordering in a gxy view. When new layers are added, this manager is responsible to put them in the correct position.

The manager must work both actively and passively: the layers can be added using its insertGXYLayer method or they can simply be added to the associated gxy view without further notice.

  • Method Details

    • getGXYView

      ILcdGXYView getGXYView()
      Return the gxy view associated with this layer order manager.
      Returns:
      the gxy view associated with this layer order manager.
    • insertGXYLayer

      void insertGXYLayer(ILcdGXYLayer aGXYLayer, int aGXYLayerType, int aModelType)
      Method to insert the given layer to the given gxy view.
      Parameters:
      aGXYLayer - The layer to insert.
      aGXYLayerType - The layer type of the layer.
      aModelType - The model type of the model of the layer.
    • canMoveGXYLayerUp

      boolean canMoveGXYLayerUp(ILcdGXYLayer aGXYLayer)
      Returns true if the given gxy layer can be moved up without violating the layer ordering.
      Parameters:
      aGXYLayer - The layer to test.
      Returns:
      true if the given gxy layer can be moved up.
    • canMoveGXYLayerDown

      boolean canMoveGXYLayerDown(ILcdGXYLayer aGXYLayer)
      Returns true if the given gxy layer can be moved down without violating the layer ordering.
      Parameters:
      aGXYLayer - The layer to test.
      Returns:
      true if the given gxy layer can be moved down.
    • moveLayerUp

      void moveLayerUp(ILcdGXYLayer aGXYLayer)
      Moves the given layer upwards.

      This method should only be called if canMoveGXYLayerUp for the same layer returns true.

      Parameters:
      aGXYLayer - The layer to move.
      See Also:
    • moveLayerDown

      void moveLayerDown(ILcdGXYLayer aGXYLayer)
      Moves the given layer downwards.

      This method should only be called if canMoveGXYLayerDown for the same layer returns true.

      Parameters:
      aGXYLayer - The layer to move.
      See Also:
    • moveLayerTop

      void moveLayerTop(ILcdGXYLayer aGXYLayer)
      Moves the given layer to the top of the view, but respects the layer ordering.

      This method should only be called if canMoveGXYLayerUp for the same layer returns true.

      Parameters:
      aGXYLayer - The layer to move.
      See Also:
    • moveLayerBottom

      void moveLayerBottom(ILcdGXYLayer aGXYLayer)
      Moves the given layer to the bottom of the view, but respects the layer ordering.

      This method should only be called if canMoveGXYLayerDown for the same layer returns true.

      Parameters:
      aGXYLayer - The layer to move.
      See Also: