/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id$ */

package org.apache.fop.render.rtf.rtflib.tools;

import java.util.List;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.impl.SimpleLog;

import org.apache.fop.render.rtf.rtflib.rtfdoc.ITableColumnsInfo;
import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfAttributes;


/**
 * <p>Used when handling fo:table to hold information to build the table.</p>
 *
 * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch),
 * Ed Trembicki-Guy (guye@dnb.com),
 * Boris Poudérous (boris.pouderous@eads-telecom.com), and
 * Peter Herweg (pherweg@web.de).</p>
 *
 *  This class was originally developed for the JFOR project and
 *  is now integrated into FOP.
 */

public class TableContext implements ITableColumnsInfo {
    private final Log log = new SimpleLog("FOP/RTF");
    private final BuilderContext context;
    private final List colWidths = new java.util.ArrayList();
    private int colIndex;

    /**
     * This ArrayList contains one element for each column in the table.
     * value == 0 means there is no row-spanning
     * value >  0 means there is row-spanning
     * Each value in the list is decreased by 1 after each finished table-row
     */
    private final List colRowSpanningNumber = new java.util.ArrayList();

    /**
     * If there has a vertical merged cell to be created, its attributes are
     * inherited from the corresponding MERGE_START-cell.
     * For this purpose the attributes of a cell are stored in this array, as soon
     * as a number-rows-spanned attribute has been found.
     */
    private final List colRowSpanningAttrs = new java.util.ArrayList();

    /**
     * This ArrayList contains one element for each column in the table.
     * value == true means, it's the first of multiple spanned columns
     * value == false meanst, it's NOT the first of multiple spanned columns
     */
    private final List colFirstSpanningCol = new java.util.ArrayList();

    private boolean bNextRowBelongsToHeader;

    /**
     *
     * @param value Specifies, if next row belongs to header
     */
    public void setNextRowBelongsToHeader(boolean value) {
        this.bNextRowBelongsToHeader = value;
    }

    /**
     *
     * @return true, if next row belongs to header
     */
    public boolean getNextRowBelongsToHeader() {
        return bNextRowBelongsToHeader;
    }

    /**
     *
     * @param ctx BuilderContext
     */
    public TableContext(BuilderContext ctx) {
        context = ctx;
    }

    /**
     * Adds a column and sets its width.
     * @param width Width of next column
     */
    public void setNextColumnWidth(Float width) {
        colWidths.add(width);
    }

    /**
     *
     * @return RtfAttributes of current row-spanning cell
     */
    public RtfAttributes getColumnRowSpanningAttrs() {
        return (RtfAttributes)colRowSpanningAttrs.get(colIndex);
    }

    /**
     *
     * @return Number of currently spanned rows
     */
    public Integer getColumnRowSpanningNumber() {
        return (Integer)colRowSpanningNumber.get(colIndex);
    }

    /**
     *
     * @return true, if it's the first of multiple spanning columns
     */
    public boolean getFirstSpanningCol() {
        Boolean b = (Boolean) colFirstSpanningCol.get(colIndex);
        return b;
    }

    /**
     *
     * @param iRowSpanning number of rows to span
     * @param attrs RtfAttributes of row-spanning cell
     */
    public void setCurrentColumnRowSpanning(
            Integer iRowSpanning,  RtfAttributes attrs) {

        if (colIndex < colRowSpanningNumber.size()) {
            colRowSpanningNumber.set(colIndex, iRowSpanning);
            colRowSpanningAttrs.set(colIndex, attrs);
        } else {
            colRowSpanningNumber.add(iRowSpanning);
            colRowSpanningAttrs.add(colIndex, attrs);
        }
    }

    /**
     *
     * @param iRowSpanning number of rows to span in next column
     * @param attrs RtfAttributes of row-spanning cell
     */
    public void setNextColumnRowSpanning(Integer iRowSpanning,
            RtfAttributes attrs) {
        colRowSpanningNumber.add(iRowSpanning);
        colRowSpanningAttrs.add(colIndex, attrs);
    }

    /**
     *
     * @param bFirstSpanningCol specifies, if it's the first of
     *                          multiple spanned columns
     */
    public void setCurrentFirstSpanningCol(
            boolean bFirstSpanningCol) {

        if (colIndex < colRowSpanningNumber.size()) {
            while (colIndex >= colFirstSpanningCol.size()) {
                setNextFirstSpanningCol(false);
            }
            colFirstSpanningCol.set(colIndex, bFirstSpanningCol);
        } else {
            colFirstSpanningCol.add(bFirstSpanningCol);
        }
    }

    /**
     *
     * @param bFirstSpanningCol specifies, if it's the first of
     *                          multiple spanned columns
     */
    public void setNextFirstSpanningCol(
            boolean bFirstSpanningCol) {
        colFirstSpanningCol.add(bFirstSpanningCol);
    }

    /**
     * Added by Peter Herweg on 2002-06-29
     * This function is called after each finished table-row.
     * It decreases all values in colRowSpanningNumber by 1. If a value
     * reaches 0 row-spanning is finished, and the value won't be decreased anymore.
     */
    public void decreaseRowSpannings() {
        for (int z = 0; z < colRowSpanningNumber.size(); ++z) {
            Integer i = (Integer)colRowSpanningNumber.get(z);

            if (i > 0) {
                i = i - 1;
            }

            colRowSpanningNumber.set(z, i);

            if (i == 0) {
                colRowSpanningAttrs.set(z, null);
                colFirstSpanningCol.set(z, false);
            }
        }
    }

    /**
     * Reset the column iteration index, meant to be called when creating a new row
     * The 'public' modifier has been added by Boris Poudérous for
     * 'number-columns-spanned' processing
     */
    public void selectFirstColumn() {
        colIndex = 0;
    }

    /**
     * Increment the column iteration index
     * The 'public' modifier has been added by Boris Poudérous for
     * 'number-columns-spanned' processing
     */
    public void selectNextColumn() {
        colIndex++;
    }

    /**
     * Get current column width according to column iteration index
     * @return INVALID_COLUMN_WIDTH if we cannot find the value
     * The 'public' modifier has been added by Boris Poudérous for
     * 'number-columns-spanned' processing
     */
    public float getColumnWidth() {
        if (colIndex < 0) {
            throw new IllegalStateException("colIndex must not be negative!");
        } else if (colIndex >= getNumberOfColumns()) {
            log.warn("Column width for column " + (colIndex + 1) + " is not defined, using "
                    + INVALID_COLUMN_WIDTH);
            while (colIndex >= getNumberOfColumns()) {
                setNextColumnWidth(INVALID_COLUMN_WIDTH);
            }
        }
        return (Float) colWidths.get(colIndex);
    }

    /**
     * Set current column index.
     * @param index New column index
     */
    public void setColumnIndex(int index) {
        colIndex = index;
    }

    /**
     * @return Index of current column
     */
    public int getColumnIndex() {
        return colIndex;
    }
    /** - end - */

    /**
     * @return Number of columns
     */
    public int getNumberOfColumns() {
        return colWidths.size();
    }
    /** - end - */
}

