com.itextpdf.pdfua.checkers.utils.tables.ITableIterator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdfua-android Show documentation
The newest version!
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2024 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    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 Affero 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 com.itextpdf.pdfua.checkers.utils.tables;


/**
 * Interface that provides methods for iterating over the elements of a table.
 */
interface ITableIterator {

    /**
     * Checks if there is a next element in the iteration.
     *
     * @return {@code true} if there is a next element, {@code false} otherwise.
     */
    boolean hasNext();


    /**
     * Gets the next element in the iteration.
     *
     * @return The next element.
     */
    T next();

    /**
     * Gets the number of rows in the body of the table.
     *
     * @return The number of rows in the body of the table.
     */
    int getAmountOfRowsBody();

    /**
     * Gets the number of rows in the header of the table.
     *
     * @return The number of rows in the header of the table.
     */
    int getAmountOfRowsHeader();

    /**
     * Gets the number of rows in the footer of the table.
     *
     * @return The number of rows in the footer of the table.
     */
    int getAmountOfRowsFooter();

    /**
     * Returns the amount of columns the table has.
     * All rows in a table in UA specification must have the same column count.
     * So return the max column count for correctly generated error messages.
     *
     * @return the amount of columns
     */
    int getNumberOfColumns();

    /**
     * Gets the row index of the current position.
     *
     * @return The row index.
     */
    int getRow();

    /**
     * Gets the column index of current position.
     *
     * @return The column index.
     */
    int getCol();

    /**
     * Gets the rowspan of current position.
     *
     * @return the rowspan
     */
    int getRowspan();

    /**
     * Gets the colspan of the current position
     *
     * @return the colspan of current position
     */
    int getColspan();


}