com.wa9nnn.wa9nnnutil.tableui.MultiColumn.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wa9nnnutil_3 Show documentation
Utils for scala3 and playframework 3.x.
The newest version!
/*
 * Copyright (C) @year  Dick Lieber, WA9NNN
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License
 * along with this program.  If not, see .
 *
 *
 */

package com.wa9nnn.wa9nnnutil.tableui

/**
 * Creates a [[Table]] with cells ordered in columns.
 *
 *
 */
object MultiColumn {
  /**
   * Build a [[Seq[Seq[Cell]] with items organized into columns.
   *
   * @param items      each will become [[Cell]] in column,
   * @param max        number of columns, number of rows will be determined automatically.
   * @return
   */
  def organize(items: Seq[Any], max: Int, emptyCell: Cell = Cell("")): Seq[Seq[Cell]] = {
    if (items.isEmpty) {
      Seq.empty
    } else {
      val nItems = items.length
      var columnHeight = nItems / max
      if (columnHeight == 0) {
        columnHeight = nItems
      } else {
        val mod: Int = nItems % max
        if (mod > 0) {
          columnHeight += 1
        }
      }

      val grid: Seq[Seq[Any]] = items.grouped(columnHeight).toSeq
      val nRows = grid.head.length
      val nCols = grid.length
      for {
        iRow <- 0 until nRows
      } yield {
        val r: Seq[Cell] = for {
          iCol <- 0 until nCols
          column = grid(iCol)
        }
          yield {
            try {
              Cell(column(iRow))
            } catch {
              case _: Exception =>
                emptyCell
            }
          }
        r
      }
    }
  }


  /**
   * Build a [[Table]] with items organized into columns.
   *
   * @param items         each will become [[Cell]] in column,
   * @param max           number of columns, number of rows will be determined automatically.
   * @param header        non empty to create header that spans the table
   * @param emptyCell     what to put is cells beyond those in items.
   * @param noDataMessage show this if there are no items.
   * @return table
   */
  def apply(items: Seq[Any], max: Int, header: String = "", emptyCell: Cell = Cell(""), noDataMessage: String = "No data available yet!"): Table = {
    if (items.isEmpty) {
      Table(List.empty, Row(noDataMessage))
    } else {

      val organizedByColumn: Seq[Row] = organize(items, max, emptyCell).map { rowOfCells => Row(rowOfCells) }
      val headers = if (header.nonEmpty) {
        val nCols = organizedByColumn.head.cells.length
        Seq(Seq(Cell(header).withColSpan(nCols)))
      } else {
        Seq.empty
      }
      Table(headers, organizedByColumn)
    }
  }
}

trait CellProvider {
  def toCell: Cell
}