ItemHeightMeasurementEnablerTest.java

/**
 * Copyright (c) 2014 - 2017 Frank Appel
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Frank Appel - initial API and implementation
 */
package com.codeaffine.eclipse.swt.widget.scrollable;

import static com.codeaffine.eclipse.swt.test.util.ShellHelper.createShell;
import static com.codeaffine.eclipse.swt.widget.scrollable.TableHelper.createTable;
import static java.util.Arrays.asList;
import static org.assertj.core.api.Assertions.assertThat;

import java.util.List;

import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.Tree;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Rule;
import org.junit.Test;

import com.codeaffine.eclipse.swt.test.util.DisplayHelper;
import com.codeaffine.eclipse.swt.test.util.SWTIgnoreConditions.GtkPlatform;
import com.codeaffine.eclipse.swt.util.ReadAndDispatch;
import com.codeaffine.eclipse.swt.widget.scrollable.context.ScrollableControl;
import com.codeaffine.test.util.junit.ConditionalIgnoreRule;
import com.codeaffine.test.util.junit.ConditionalIgnoreRule.ConditionalIgnore;

public class ItemHeightMeasurementEnablerTest {

  @Rule public final ConditionalIgnoreRule ignoreRule = new ConditionalIgnoreRule();
  @Rule public final DisplayHelper displayHelper = new DisplayHelper();

  private ScrollableAdapterFactory adapterFactory;
  private ScrollableControl<?> scrollableControl;
  private int itemHeight;
  private Shell shell;
  private Table table;

  @Before
  public void setUp() {
    adapterFactory = new ScrollableAdapterFactory();
    shell = createShell( displayHelper );
    table = createTable( shell, 10 );
    itemHeight = table.getItemHeight() * 2;
    scrollableControl = new ScrollableControl<>( table );
  }

  @Test
  public void initialStateWithTable() {
    ItemHeightMeasurementEnabler actual = new ItemHeightMeasurementEnabler( scrollableControl, shell );

    assertThat( actual.height ).isEqualTo( table.getItemHeight() );
    assertThat( actual.intermediateHeightBuffer ).isEqualTo( ItemHeightMeasurementEnabler.UNSET );
    assertThat( actual.onMeasurement ).isFalse();
  }

  @Test
  @ConditionalIgnore( condition = GtkPlatform.class )
  public void initialStateWithTree() {
    Tree tree = new Tree( shell, SWT.NONE );
    ScrollableControl<?> scrollableControl = new ScrollableControl<>( tree );

    ItemHeightMeasurementEnabler actual = new ItemHeightMeasurementEnabler( scrollableControl, shell );

    assertThat( actual.height ).isEqualTo( tree.getItemHeight() );
    assertThat( actual.intermediateHeightBuffer ).isEqualTo( ItemHeightMeasurementEnabler.UNSET );
    assertThat( actual.onMeasurement ).isFalse();
  }

  @Test
  @ConditionalIgnore( condition = GtkPlatform.class )
  public void createTableAdapter() {
    adapterFactory.create( table, TableAdapter.class );

    assertThat( getListeners( table, SWT.MeasureItem ) ).hasSize( 0 );
    assertThat( getListeners( table, SWT.EraseItem ) ).hasSize( 0 );
  }

  @Test
  @ConditionalIgnore( condition = GtkPlatform.class )
  public void createTableAdapterWithOwnerDrawnItemRegistrationOnIndependentWidget() {
    adapterFactory.create( table, TableAdapter.class );
    Table other = createTable( shell, 10 );
    adapterFactory.create( other, TableAdapter.class );
    int expected = configureOwnerDrawnItemHeightAdjustment( table, table.getItemHeight() );
    configureOwnerDrawnItemHeightAdjustment( other, itemHeight );

    new ReadAndDispatch().spinLoop( shell, 100 );

    assertThat( table.getItemHeight() ).isEqualTo( expected );
  }

  @Test
  @ConditionalIgnore( condition = GtkPlatform.class )
  public void createTableAdapterWithOwnerDrawnItemRegistrationAndEraseEventSwallowed() {
    adapterFactory.create( table, TableAdapter.class );
    int configured = configureOwnerDrawnItemHeightAdjustment( table, itemHeight );
    displayHelper.getDisplay().addFilter( SWT.EraseItem, event -> event.type = SWT.NONE );
    shell.open();

    new ReadAndDispatch().spinLoop( shell, 100 );

    assertThat( table.getItemHeight() ).isNotEqualTo( configured );
  }

  @Test
  @ConditionalIgnore( condition = GtkPlatform.class )
  @Ignore( "see: https://github.com/fappel/xiliary/issues/73" )
  public void createTableAdapterWithOwnerDrawnItemRegistrationAndEraseEventSwallowedAfterMeasurmentTookPlace() {
    adapterFactory.create( table, TableAdapter.class );
    int expected = configureOwnerDrawnItemHeightAdjustment( table, itemHeight );
    table.addListener( SWT.EraseItem, evt -> {
      displayHelper.getDisplay().addFilter( SWT.EraseItem, event -> event.type = SWT.NONE );
    } );
    shell.open();

    new ReadAndDispatch().spinLoop( shell, 100 );

    assertThat( table.getItemHeight() ).isEqualTo( expected );
    assertThat( getListeners( table, SWT.MeasureItem ) ).hasSize( 2 );
    assertThat( getListeners( table, SWT.EraseItem ) ).hasSize( 3 );
    assertThat( table.getParent() ).isSameAs( shell );
  }

  @Test
  @ConditionalIgnore( condition = GtkPlatform.class )
  @Ignore( "see: https://github.com/fappel/xiliary/issues/73" )
  public void changeItemHeightByOwnerDrawnItemEvents() {
    adapterFactory.create( table, TableAdapter.class );
    int expectedHeight = configureOwnerDrawnItemHeightAdjustment( table, itemHeight );
    shell.open();

    new ReadAndDispatch().spinLoop( shell, 100 );

    assertThat( table.getItemHeight() ).isEqualTo( expectedHeight );
  }

  @Test
  @ConditionalIgnore( condition = GtkPlatform.class )
  public void changeItemHeightByOwnerDrawnItemEventsToEqualValue() {
    adapterFactory.create( table, TableAdapter.class );
    int expectedHeight = configureOwnerDrawnItemHeightAdjustment( table, table.getItemHeight() );
    shell.open();

    new ReadAndDispatch().spinLoop( shell, 100 );

    assertThat( table.getItemHeight() ).isEqualTo( expectedHeight );
  }

  private static int configureOwnerDrawnItemHeightAdjustment( Table table, int requestedItemHeight ) {
    table.addListener( SWT.MeasureItem, evt -> evt.height = requestedItemHeight );
    table.addListener( SWT.EraseItem, evt -> {} );
    table.addListener( SWT.PaintItem, evt -> {} );
    return requestedItemHeight;
  }

  private static List<Listener> getListeners( Table table, int eventType ) {
    return asList( table.getListeners( eventType ) );
  }
}