Package org.eclipse.nebula.widgets.nattable.layer.event

Class RowVisualChangeEvent

java.lang.Object
org.eclipse.nebula.widgets.nattable.layer.event.RowVisualChangeEvent
All Implemented Interfaces:
ILayerEvent, IVisualChangeEvent
Direct Known Subclasses:
RowSelectionEvent, RowStructuralChangeEvent, RowUpdateEvent, RowVisualUpdateEvent
public abstract class RowVisualChangeEvent extends Object implements IVisualChangeEvent
An event that indicates a visible change to one ore more rows in the layer.

  • Constructor Details

    • RowVisualChangeEvent

      public RowVisualChangeEvent(ILayer layer, int rowPosition)
      Creates a new RowVisualChangeEvent based on the given information.
      Parameters:
      layer - The ILayer to which the given row position matches.
      rowPosition - The row position of the row that has changed.

    • RowVisualChangeEvent

      public RowVisualChangeEvent(ILayer layer, Range... rowPositionRanges)
      Creates a new RowVisualChangeEvent based on the given information.
      Parameters:
      layer - The ILayer to which the given row positions match.
      rowPositionRanges - The row position ranges for the rows that have changed.

    • RowVisualChangeEvent

      public RowVisualChangeEvent(ILayer layer, Collection<Range> rowPositionRanges)
      Creates a new RowVisualChangeEvent based on the given information.
      Parameters:
      layer - The ILayer to which the given row positions match.
      rowPositionRanges - The row position ranges for the rows that have changed.

    • RowVisualChangeEvent

      public RowVisualChangeEvent(ILayer layer, Collection<Range> rowPositionRanges, Collection<Integer> rowIndexes)
      Creates a new RowVisualChangeEvent based on the given information.
      Parameters:
      layer - The ILayer to which the given column positions match.
      rowPositionRanges - The row position ranges for the rows that have changed.
      rowIndexes - The indexes of the rows that have changed.
      Since:
      1.6

    • RowVisualChangeEvent

      public RowVisualChangeEvent(ILayer layer, Collection<Range> rowPositionRanges, int... rowIndexes)
      Creates a new RowVisualChangeEvent based on the given information.
      Parameters:
      layer - The ILayer to which the given column positions match.
      rowPositionRanges - The row position ranges for the rows that have changed.
      rowIndexes - The indexes of the rows that have changed.
      Since:
      2.0

    • RowVisualChangeEvent

      protected RowVisualChangeEvent(RowVisualChangeEvent event)
      Creates a new RowVisualChangeEvent based on the given instance. Mainly needed for cloning.
      Parameters:
      event - The RowVisualChangeEvent out of which the new instance should be created.

  • Method Details

    • getLayer

      public ILayer getLayer()
      Specified by:
      getLayer in interface IVisualChangeEvent
      Returns:
      the layer that the visible change event is originating from.

    • getRowPositionRanges

      public Collection<Range> getRowPositionRanges()
      Returns:
      The row position ranges for the rows that have changed.

    • setRowPositionRanges

      protected void setRowPositionRanges(Collection<Range> rowPositionRanges)
      Sets the row position ranges for the rows that have changed. Only for internal use in cases where the constructor needs to calculate the row position ranges within the child constructor.
      Parameters:
      rowPositionRanges - The row position ranges for the rows that have changed.

    • getRowIndexes

      public int[] getRowIndexes()
      Returns:
      The indexes of the rows that have changed.
      Since:
      2.0

    • convertToLocal

      public boolean convertToLocal(ILayer localLayer)
      Description copied from interface: ILayerEvent
      Convert the column/row positions carried by the event to the layer about to handle the event.
      Specified by:
      convertToLocal in interface ILayerEvent
      Parameters:
      localLayer - layer about to receive the event
      Returns:
      TRUE if successfully converted, FALSE otherwise

    • getChangedPositionRectangles

      public Collection<org.eclipse.swt.graphics.Rectangle> getChangedPositionRectangles()
      Specified by:
      getChangedPositionRectangles in interface IVisualChangeEvent
      Returns:
      the position rectangles that have changed and need to be redrawn. If no rectangles are returned, then the receiver should assume that the entire layer is changed and will need to be redrawn.

    • toString

      public String toString()
      Overrides:
      toString in class Object