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

Class ColumnVisualChangeEvent

java.lang.Object
org.eclipse.nebula.widgets.nattable.layer.event.ColumnVisualChangeEvent
All Implemented Interfaces:
ILayerEvent, IVisualChangeEvent
Direct Known Subclasses:
ColumnHeaderSelectionEvent, ColumnSelectionEvent, ColumnStructuralChangeEvent, ColumnVisualUpdateEvent, RenameColumnHeaderEvent, SortColumnEvent
public abstract class ColumnVisualChangeEvent extends Object implements IVisualChangeEvent
An event that indicates a visible change to one ore more columns in the layer.

  • Constructor Details

    • ColumnVisualChangeEvent

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

    • ColumnVisualChangeEvent

      public ColumnVisualChangeEvent(ILayer layer, Range... columnPositionRanges)
      Creates a new ColumnVisualChangeEvent based on the given information.
      Parameters:
      layer - The ILayer to which the given column positions match.
      columnPositionRanges - The column position ranges for the columns that have changed.

    • ColumnVisualChangeEvent

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

    • ColumnVisualChangeEvent

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

    • ColumnVisualChangeEvent

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

    • ColumnVisualChangeEvent

      protected ColumnVisualChangeEvent(ColumnVisualChangeEvent event)
      Creates a new ColumnVisualChangeEvent based on the given instance. Mainly needed for cloning.
      Parameters:
      event - The ColumnVisualChangeEvent 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.

    • getColumnPositionRanges

      public Collection<Range> getColumnPositionRanges()
      Returns:
      The column position ranges for the columns that have changed.

    • setColumnPositionRanges

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

    • getColumnIndexes

      public int[] getColumnIndexes()
      Returns:
      The indexes of the columns 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