ca.qc.ircm.platelayout.client.PlateLayoutWidget Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of plate-layout Show documentation
Layout for micro well plates used in laboratories
There is a newer version: 0.9
/*
 * Copyright (c) 2016 Institut de recherches cliniques de Montreal (IRCM)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */

package ca.qc.ircm.platelayout.client;

import com.google.gwt.user.client.ui.Grid;

import java.util.List;

/**
 * Plate layout widget.
 */
public class PlateLayoutWidget extends Grid {
  public static final String CLASSNAME = "v-plate-layout";
  public static final String HEADER_CLASSNAME = "v-plate-layout-header";
  public static final String COLUMN_HEADER_CLASSNAME = "v-plate-layout-header-column";
  public static final String ROW_HEADER_CLASSNAME = "v-plate-layout-header-row";
  public static final String WELL_CLASSNAME = "v-plate-layout-well";

  /**
   * Initializes plate layout widget.
   */
  public PlateLayoutWidget() {
    super(1, 1);
    setCellSpacing(0);
    setCellPadding(0);
    addStyleName(CLASSNAME);
    getCellFormatter().addStyleName(0, 0, HEADER_CLASSNAME);
  }

  /**
   * Resizes number of columns.
   *
   * @param columns
   *          number of columns
   */
  @Override
  public void resizeColumns(int columns) {
    int column = Math.max(numColumns, 1);
    super.resizeColumns(columns);
    if (numRows < 1) {
      return;
    }
    while (column < columns) {
      createColumnHeader(column);
      for (int row = 1; row < numRows; row++) {
        createWell(column, row);
      }
      column++;
    }
  }

  private void createColumnHeader(int column) {
    applyDefaultCellStyles(0, column);
    setText(0, column, columnHeaderText(column - 1));
  }

  private String columnHeaderText(int column) {
    StringBuilder builder = new StringBuilder();
    int substract = column >= 26 ? 1 : 0;
    while (column >= 26) {
      builder.append((char) ('A' + column % 26));
      column /= 26;
    }
    builder.append((char) ('A' + column - substract));
    return builder.reverse().toString();
  }

  /**
   * Resizes number of rows.
   *
   * @param rows
   *          number of rows
   */
  @Override
  public void resizeRows(int rows) {
    int row = Math.max(numRows, 1);
    super.resizeRows(rows);
    if (numColumns < 1) {
      return;
    }
    while (row < rows) {
      createRowHeader(row);
      for (int column = 1; column < numColumns; column++) {
        createWell(column, row);
      }
      row++;
    }
  }

  private void createRowHeader(int row) {
    applyDefaultCellStyles(row, 0);
    setText(row, 0, String.valueOf(row));
  }

  private void createWell(int column, int row) {
    applyDefaultCellStyles(row, column);
  }

  private void applyDefaultCellStyles(int row, int column) {
    if (row == 0 || column == 0) {
      getCellFormatter().addStyleName(row, column, HEADER_CLASSNAME);
      if (row == 0 && column > 0) {
        getCellFormatter().addStyleName(row, column, COLUMN_HEADER_CLASSNAME);
      }
      if (row > 0 && column == 0) {
        getCellFormatter().addStyleName(row, column, ROW_HEADER_CLASSNAME);
      }
    } else {
      getCellFormatter().addStyleName(row, column, WELL_CLASSNAME);
    }
  }

  /**
   * Sets styles for cell.
   *
   * @param row
   *          row
   * @param column
   *          column
   * @param styles
   *          styles to set
   */
  public void setCellStyles(int row, int column, List styles) {
    String styleName = getCellFormatter().getStyleName(row, column);
    if (!styleName.isEmpty()) {
      getCellFormatter().removeStyleName(row, column, styleName);
    }
    applyDefaultCellStyles(row, column);
    if (styles != null) {
      for (String style : styles) {
        getCellFormatter().addStyleName(row, column, style);
      }
    }
  }

  /**
   * Clear all well widgets.
   */
  public void clearWells() {
    for (int column = 1; column < numColumns; column++) {
      for (int row = 1; row < numRows; row++) {
        setWidget(row, column, null);
      }
    }
  }
}