Class Segment


  • public class Segment
    extends Position
    Internal class. Do not use. Only public for testing purposes.

    A segment is the image of a master document fragment in a projection document.

    Since:
    3.0
    Restriction:
    This class is not intended to be subclassed by clients.
    Restriction:
    This class is not intended to be instantiated by clients.
    • Field Detail

      • fragment

        public Fragment fragment
        The corresponding fragment for this segment.
      • isMarkedForStretch

        public boolean isMarkedForStretch
        A flag indicating that the segment updater should stretch this segment when a change happens at its boundaries.
      • isMarkedForShift

        public boolean isMarkedForShift
        A flag indicating that the segment updater should shift this segment when a change happens at its boundaries.
    • Constructor Detail

      • Segment

        public Segment​(int offset,
                       int length)
        Creates a new segment covering the given range.
        Parameters:
        offset - the offset of the segment
        length - the length of the segment
    • Method Detail

      • markForStretch

        public void markForStretch()
        Sets the stretching flag.
      • isMarkedForStretch

        public boolean isMarkedForStretch()
        Returns true if the stretching flag is set, false otherwise.
        Returns:
        true if the stretching flag is set, false otherwise
      • markForShift

        public void markForShift()
        Sets the shifting flag.
      • isMarkedForShift

        public boolean isMarkedForShift()
        Returns true if the shifting flag is set, false otherwise.
        Returns:
        true if the shifting flag is set, false otherwise
      • clearMark

        public void clearMark()
        Clears the shifting and the stretching flag.