Interface ILcdEditableMultilevelGridCoordinate

All Superinterfaces:
ILcdMultilevelGridCoordinate
All Known Implementing Classes:
TLcdMultilevelGridCoordinate

public interface ILcdEditableMultilevelGridCoordinate extends ILcdMultilevelGridCoordinate
A multilevel grid coordinate which can be modified to designate another area on the ILcdMultilevelGrid with regard to which it is defined. The change may incorporate changing the value of a coordinate at a given level or changing the number of levels up to which a multilevel grid coordinate is defined. Increasing the level up to which a multilevel grid coordinate is specified will make it designate an area that is part of the area it used to designate. Decreasing the level up to which a multilevel grid coordinate is specified will make it cover a 'parent' area of the area it used to designate. Changing the value of a coordinate at any level will make it designate an area of the same size at a different location.
Since:
7.0
  • Method Details

    • setCoordinate

      void setCoordinate(int aLevel, int aAxis, int aCoordinate)
      Sets the coordinate at the given level and axis to the given value. Note that if the level passed is equal to or higher than the value returned by ILcdMultilevelGridCoordinate.getCoordinateLevelCount(), the value of the coordinate will not be taken into account until the value returned by getCoordinateLevelCount is higher than the level passed.
      Parameters:
      aLevel - the level at which to change the coordinate.
      aAxis - the axis for which to change the coordinate, either ILcdMultilevelGrid.X_AXIS or ILcdMultilevelGrid.Y_AXIS.
      aCoordinate - the new value for the coordinate at the given level and axis.
    • setCoordinateLevelCount

      void setCoordinateLevelCount(int aLevelCount)
      Sets how many levels of this coordinate are taken into account. This means that all levels of this coordinate are taken into account up to, but not including, the specified value. The other (higher) levels should always be discarded. Note that the level count of a multilevel grid coordinate is not necessarily the total number of levels which could be specified. Increasing the coordinate level count will not specify the values of the highest levels. The coordinates should be specified explicitly before or after increasing the level count.
      Parameters:
      aLevelCount - the number of levels taken into account for this multilevel grid coordinate.