Proyectos de Subversion Moodle

<?php

namespace PhpOffice\PhpSpreadsheet\Worksheet;

use PhpOffice\PhpSpreadsheet\Cell\Coordinate;

use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;

/**

 * <code>

 * Paper size taken from Office Open XML Part 4 - Markup Language Reference, page 1988:.

 *

 * 1 = Letter paper (8.5 in. by 11 in.)

 * 2 = Letter small paper (8.5 in. by 11 in.)

 * 3 = Tabloid paper (11 in. by 17 in.)

 * 4 = Ledger paper (17 in. by 11 in.)

 * 5 = Legal paper (8.5 in. by 14 in.)

 * 6 = Statement paper (5.5 in. by 8.5 in.)

 * 7 = Executive paper (7.25 in. by 10.5 in.)

 * 8 = A3 paper (297 mm by 420 mm)

 * 9 = A4 paper (210 mm by 297 mm)

 * 10 = A4 small paper (210 mm by 297 mm)

 * 11 = A5 paper (148 mm by 210 mm)

 * 12 = B4 paper (250 mm by 353 mm)

 * 13 = B5 paper (176 mm by 250 mm)

 * 14 = Folio paper (8.5 in. by 13 in.)

 * 15 = Quarto paper (215 mm by 275 mm)

 * 16 = Standard paper (10 in. by 14 in.)

 * 17 = Standard paper (11 in. by 17 in.)

 * 18 = Note paper (8.5 in. by 11 in.)

 * 19 = #9 envelope (3.875 in. by 8.875 in.)

 * 20 = #10 envelope (4.125 in. by 9.5 in.)

 * 21 = #11 envelope (4.5 in. by 10.375 in.)

 * 22 = #12 envelope (4.75 in. by 11 in.)

 * 23 = #14 envelope (5 in. by 11.5 in.)

 * 24 = C paper (17 in. by 22 in.)

 * 25 = D paper (22 in. by 34 in.)

 * 26 = E paper (34 in. by 44 in.)

 * 27 = DL envelope (110 mm by 220 mm)

 * 28 = C5 envelope (162 mm by 229 mm)

 * 29 = C3 envelope (324 mm by 458 mm)

 * 30 = C4 envelope (229 mm by 324 mm)

 * 31 = C6 envelope (114 mm by 162 mm)

 * 32 = C65 envelope (114 mm by 229 mm)

 * 33 = B4 envelope (250 mm by 353 mm)

 * 34 = B5 envelope (176 mm by 250 mm)

 * 35 = B6 envelope (176 mm by 125 mm)

 * 36 = Italy envelope (110 mm by 230 mm)

 * 37 = Monarch envelope (3.875 in. by 7.5 in.).

 * 38 = 6 3/4 envelope (3.625 in. by 6.5 in.)

 * 39 = US standard fanfold (14.875 in. by 11 in.)

 * 40 = German standard fanfold (8.5 in. by 12 in.)

 * 41 = German legal fanfold (8.5 in. by 13 in.)

 * 42 = ISO B4 (250 mm by 353 mm)

 * 43 = Japanese double postcard (200 mm by 148 mm)

 * 44 = Standard paper (9 in. by 11 in.)

 * 45 = Standard paper (10 in. by 11 in.)

 * 46 = Standard paper (15 in. by 11 in.)

 * 47 = Invite envelope (220 mm by 220 mm)

 * 50 = Letter extra paper (9.275 in. by 12 in.)

 * 51 = Legal extra paper (9.275 in. by 15 in.)

 * 52 = Tabloid extra paper (11.69 in. by 18 in.)

 * 53 = A4 extra paper (236 mm by 322 mm)

 * 54 = Letter transverse paper (8.275 in. by 11 in.)

 * 55 = A4 transverse paper (210 mm by 297 mm)

 * 56 = Letter extra transverse paper (9.275 in. by 12 in.)

 * 57 = SuperA/SuperA/A4 paper (227 mm by 356 mm)

 * 58 = SuperB/SuperB/A3 paper (305 mm by 487 mm)

 * 59 = Letter plus paper (8.5 in. by 12.69 in.)

 * 60 = A4 plus paper (210 mm by 330 mm)

 * 61 = A5 transverse paper (148 mm by 210 mm)

 * 62 = JIS B5 transverse paper (182 mm by 257 mm)

 * 63 = A3 extra paper (322 mm by 445 mm)

 * 64 = A5 extra paper (174 mm by 235 mm)

 * 65 = ISO B5 extra paper (201 mm by 276 mm)

 * 66 = A2 paper (420 mm by 594 mm)

 * 67 = A3 transverse paper (297 mm by 420 mm)

 * 68 = A3 extra transverse paper (322 mm by 445 mm)

 * </code>

 */

class PageSetup

{

    // Paper size

    const PAPERSIZE_LETTER = 1;

    const PAPERSIZE_LETTER_SMALL = 2;

    const PAPERSIZE_TABLOID = 3;

    const PAPERSIZE_LEDGER = 4;

    const PAPERSIZE_LEGAL = 5;

    const PAPERSIZE_STATEMENT = 6;

    const PAPERSIZE_EXECUTIVE = 7;

    const PAPERSIZE_A3 = 8;

    const PAPERSIZE_A4 = 9;

    const PAPERSIZE_A4_SMALL = 10;

    const PAPERSIZE_A5 = 11;

    const PAPERSIZE_B4 = 12;

    const PAPERSIZE_B5 = 13;

    const PAPERSIZE_FOLIO = 14;

    const PAPERSIZE_QUARTO = 15;

    const PAPERSIZE_STANDARD_1 = 16;

    const PAPERSIZE_STANDARD_2 = 17;

    const PAPERSIZE_NOTE = 18;

    const PAPERSIZE_NO9_ENVELOPE = 19;

    const PAPERSIZE_NO10_ENVELOPE = 20;

    const PAPERSIZE_NO11_ENVELOPE = 21;

    const PAPERSIZE_NO12_ENVELOPE = 22;

    const PAPERSIZE_NO14_ENVELOPE = 23;

    const PAPERSIZE_C = 24;

    const PAPERSIZE_D = 25;

    const PAPERSIZE_E = 26;

    const PAPERSIZE_DL_ENVELOPE = 27;

    const PAPERSIZE_C5_ENVELOPE = 28;

    const PAPERSIZE_C3_ENVELOPE = 29;

    const PAPERSIZE_C4_ENVELOPE = 30;

    const PAPERSIZE_C6_ENVELOPE = 31;

    const PAPERSIZE_C65_ENVELOPE = 32;

    const PAPERSIZE_B4_ENVELOPE = 33;

    const PAPERSIZE_B5_ENVELOPE = 34;

    const PAPERSIZE_B6_ENVELOPE = 35;

    const PAPERSIZE_ITALY_ENVELOPE = 36;

    const PAPERSIZE_MONARCH_ENVELOPE = 37;

    const PAPERSIZE_6_3_4_ENVELOPE = 38;

    const PAPERSIZE_US_STANDARD_FANFOLD = 39;

    const PAPERSIZE_GERMAN_STANDARD_FANFOLD = 40;

    const PAPERSIZE_GERMAN_LEGAL_FANFOLD = 41;

    const PAPERSIZE_ISO_B4 = 42;

    const PAPERSIZE_JAPANESE_DOUBLE_POSTCARD = 43;

    const PAPERSIZE_STANDARD_PAPER_1 = 44;

    const PAPERSIZE_STANDARD_PAPER_2 = 45;

    const PAPERSIZE_STANDARD_PAPER_3 = 46;

    const PAPERSIZE_INVITE_ENVELOPE = 47;

    const PAPERSIZE_LETTER_EXTRA_PAPER = 48;

    const PAPERSIZE_LEGAL_EXTRA_PAPER = 49;

    const PAPERSIZE_TABLOID_EXTRA_PAPER = 50;

    const PAPERSIZE_A4_EXTRA_PAPER = 51;

    const PAPERSIZE_LETTER_TRANSVERSE_PAPER = 52;

    const PAPERSIZE_A4_TRANSVERSE_PAPER = 53;

    const PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER = 54;

    const PAPERSIZE_SUPERA_SUPERA_A4_PAPER = 55;

    const PAPERSIZE_SUPERB_SUPERB_A3_PAPER = 56;

    const PAPERSIZE_LETTER_PLUS_PAPER = 57;

    const PAPERSIZE_A4_PLUS_PAPER = 58;

    const PAPERSIZE_A5_TRANSVERSE_PAPER = 59;

    const PAPERSIZE_JIS_B5_TRANSVERSE_PAPER = 60;

    const PAPERSIZE_A3_EXTRA_PAPER = 61;

    const PAPERSIZE_A5_EXTRA_PAPER = 62;

    const PAPERSIZE_ISO_B5_EXTRA_PAPER = 63;

    const PAPERSIZE_A2_PAPER = 64;

    const PAPERSIZE_A3_TRANSVERSE_PAPER = 65;

    const PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER = 66;

    // Page orientation

    const ORIENTATION_DEFAULT = 'default';

    const ORIENTATION_LANDSCAPE = 'landscape';

    const ORIENTATION_PORTRAIT = 'portrait';

    // Print Range Set Method

    const SETPRINTRANGE_OVERWRITE = 'O';

    const SETPRINTRANGE_INSERT = 'I';

    const PAGEORDER_OVER_THEN_DOWN = 'overThenDown';

    const PAGEORDER_DOWN_THEN_OVER = 'downThenOver';

    /**

     * Paper size default.

     *

     * @var int

     */

    private static $paperSizeDefault = self::PAPERSIZE_LETTER;

    /**

     * Paper size.

     *

     * @var ?int

     */

    private $paperSize;

    /**

     * Orientation default.

     *

     * @var string

     */

    private static $orientationDefault = self::ORIENTATION_DEFAULT;

    /**

     * Orientation.

     *

     * @var string

     */

    private $orientation;

    /**

     * Scale (Print Scale).

     *

     * Print scaling. Valid values range from 10 to 400

     * This setting is overridden when fitToWidth and/or fitToHeight are in use

     *

     * @var null|int

     */

    private $scale = 100;

    /**

     * Fit To Page

     * Whether scale or fitToWith / fitToHeight applies.

     *

     * @var bool

     */

    private $fitToPage = false;

    /**

     * Fit To Height

     * Number of vertical pages to fit on.

     *

     * @var null|int

     */

    private $fitToHeight = 1;

    /**

     * Fit To Width

     * Number of horizontal pages to fit on.

     *

     * @var null|int

     */

    private $fitToWidth = 1;

    /**

     * Columns to repeat at left.

     *

     * @var array Containing start column and end column, empty array if option unset

     */

    private $columnsToRepeatAtLeft = ['', ''];

    /**

     * Rows to repeat at top.

     *

     * @var array Containing start row number and end row number, empty array if option unset

     */

    private $rowsToRepeatAtTop = [0, 0];

    /**

     * Center page horizontally.

     *

     * @var bool

     */

    private $horizontalCentered = false;

    /**

     * Center page vertically.

     *

     * @var bool

     */

    private $verticalCentered = false;

    /**

     * Print area.

     *

     * @var null|string

     */

    private $printArea;

    /**

     * First page number.

     *

     * @var ?int

     */

    private $firstPageNumber;

    /** @var string */

    private $pageOrder = self::PAGEORDER_DOWN_THEN_OVER;

    /**

     * Create a new PageSetup.

     */

    public function __construct()

    {

        $this->orientation = self::$orientationDefault;

    }

    /**

     * Get Paper Size.

     *

     * @return int

     */

    public function getPaperSize()

    {

        return $this->paperSize ?? self::$paperSizeDefault;

    }

    /**

     * Set Paper Size.

     *

     * @param int $paperSize see self::PAPERSIZE_*

     *

     * @return $this

     */

    public function setPaperSize($paperSize)

    {

        $this->paperSize = $paperSize;

        return $this;

    }

    /**

     * Get Paper Size default.

     */

    public static function getPaperSizeDefault(): int

    {

        return self::$paperSizeDefault;

    }

    /**

     * Set Paper Size Default.

     */

    public static function setPaperSizeDefault(int $paperSize): void

    {

        self::$paperSizeDefault = $paperSize;

    }

    /**

     * Get Orientation.

     *

     * @return string

     */

    public function getOrientation()

    {

        return $this->orientation;

    }

    /**

     * Set Orientation.

     *

     * @param string $orientation see self::ORIENTATION_*

     *

     * @return $this

     */

    public function setOrientation($orientation)

    {

        if ($orientation === self::ORIENTATION_LANDSCAPE || $orientation === self::ORIENTATION_PORTRAIT || $orientation === self::ORIENTATION_DEFAULT) {

            $this->orientation = $orientation;

        }

        return $this;

    }

    public static function getOrientationDefault(): string

    {

        return self::$orientationDefault;

    }

    public static function setOrientationDefault(string $orientation): void

    {

        if ($orientation === self::ORIENTATION_LANDSCAPE || $orientation === self::ORIENTATION_PORTRAIT || $orientation === self::ORIENTATION_DEFAULT) {

            self::$orientationDefault = $orientation;

        }

    }

    /**

     * Get Scale.

     *

     * @return null|int

     */

    public function getScale()

    {

        return $this->scale;

    }

    /**

     * Set Scale.

     * Print scaling. Valid values range from 10 to 400

     * This setting is overridden when fitToWidth and/or fitToHeight are in use.

     *

     * @param null|int $scale

     * @param bool $update Update fitToPage so scaling applies rather than fitToHeight / fitToWidth

     *

     * @return $this

     */

    public function setScale($scale, $update = true)

    {

        // Microsoft Office Excel 2007 only allows setting a scale between 10 and 400 via the user interface,

        // but it is apparently still able to handle any scale >= 0, where 0 results in 100

        if ($scale === null || $scale >= 0) {

            $this->scale = $scale;

            if ($update) {

                $this->fitToPage = false;

            }

        } else {

            throw new PhpSpreadsheetException('Scale must not be negative');

        }

        return $this;

    }

    /**

     * Get Fit To Page.

     *

     * @return bool

     */

    public function getFitToPage()

    {

        return $this->fitToPage;

    }

    /**

     * Set Fit To Page.

     *

     * @param bool $fitToPage

     *

     * @return $this

     */

    public function setFitToPage($fitToPage)

    {

        $this->fitToPage = $fitToPage;

        return $this;

    }

    /**

     * Get Fit To Height.

     *

     * @return null|int

     */

    public function getFitToHeight()

    {

        return $this->fitToHeight;

    }

    /**

     * Set Fit To Height.

     *

     * @param null|int $fitToHeight

     * @param bool $update Update fitToPage so it applies rather than scaling

     *

     * @return $this

     */

    public function setFitToHeight($fitToHeight, $update = true)

    {

        $this->fitToHeight = $fitToHeight;

        if ($update) {

            $this->fitToPage = true;

        }

        return $this;

    }

    /**

     * Get Fit To Width.

     *

     * @return null|int

     */

    public function getFitToWidth()

    {

        return $this->fitToWidth;

    }

    /**

     * Set Fit To Width.

     *

     * @param null|int $value

     * @param bool $update Update fitToPage so it applies rather than scaling

     *

     * @return $this

     */

    public function setFitToWidth($value, $update = true)

    {

        $this->fitToWidth = $value;

        if ($update) {

            $this->fitToPage = true;

        }

        return $this;

    }

    /**

     * Is Columns to repeat at left set?

     *

     * @return bool

     */

    public function isColumnsToRepeatAtLeftSet()

    {

        if (!empty($this->columnsToRepeatAtLeft)) {

            if ($this->columnsToRepeatAtLeft[0] != '' && $this->columnsToRepeatAtLeft[1] != '') {

                return true;

            }

        }

        return false;

    }

    /**

     * Get Columns to repeat at left.

     *

     * @return array Containing start column and end column, empty array if option unset

     */

    public function getColumnsToRepeatAtLeft()

    {

        return $this->columnsToRepeatAtLeft;

    }

    /**

     * Set Columns to repeat at left.

     *

     * @param array $columnsToRepeatAtLeft Containing start column and end column, empty array if option unset

     *

     * @return $this

     */

    public function setColumnsToRepeatAtLeft(array $columnsToRepeatAtLeft)

    {

        $this->columnsToRepeatAtLeft = $columnsToRepeatAtLeft;

        return $this;

    }

    /**

     * Set Columns to repeat at left by start and end.

     *

     * @param string $start eg: 'A'

     * @param string $end eg: 'B'

     *

     * @return $this

     */

    public function setColumnsToRepeatAtLeftByStartAndEnd($start, $end)

    {

        $this->columnsToRepeatAtLeft = [$start, $end];

        return $this;

    }

    /**

     * Is Rows to repeat at top set?

     *

     * @return bool

     */

    public function isRowsToRepeatAtTopSet()

    {

        if (!empty($this->rowsToRepeatAtTop)) {

            if ($this->rowsToRepeatAtTop[0] != 0 && $this->rowsToRepeatAtTop[1] != 0) {

                return true;

            }

        }

        return false;

    }

    /**

     * Get Rows to repeat at top.

     *

     * @return array Containing start column and end column, empty array if option unset

     */

    public function getRowsToRepeatAtTop()

    {

        return $this->rowsToRepeatAtTop;

    }

    /**

     * Set Rows to repeat at top.

     *

     * @param array $rowsToRepeatAtTop Containing start column and end column, empty array if option unset

     *

     * @return $this

     */

    public function setRowsToRepeatAtTop(array $rowsToRepeatAtTop)

    {

        $this->rowsToRepeatAtTop = $rowsToRepeatAtTop;

        return $this;

    }

    /**

     * Set Rows to repeat at top by start and end.

     *

     * @param int $start eg: 1

     * @param int $end eg: 1

     *

     * @return $this

     */

    public function setRowsToRepeatAtTopByStartAndEnd($start, $end)

    {

        $this->rowsToRepeatAtTop = [$start, $end];

        return $this;

    }

    /**

     * Get center page horizontally.

     *

     * @return bool

     */

    public function getHorizontalCentered()

    {

        return $this->horizontalCentered;

    }

    /**

     * Set center page horizontally.

     *

     * @param bool $value

     *

     * @return $this

     */

    public function setHorizontalCentered($value)

    {

        $this->horizontalCentered = $value;

        return $this;

    }

    /**

     * Get center page vertically.

     *

     * @return bool

     */

    public function getVerticalCentered()

    {

        return $this->verticalCentered;

    }

    /**

     * Set center page vertically.

     *

     * @param bool $value

     *

     * @return $this

     */

    public function setVerticalCentered($value)

    {

        $this->verticalCentered = $value;

        return $this;

    }

    /**

     * Get print area.

     *

     * @param int $index Identifier for a specific print area range if several ranges have been set

     *                            Default behaviour, or a index value of 0, will return all ranges as a comma-separated string

     *                            Otherwise, the specific range identified by the value of $index will be returned

     *                            Print areas are numbered from 1

     *

     * @return string

     */

    public function getPrintArea($index = 0)

    {

        if ($index == 0) {

            return (string) $this->printArea;

        }

        $printAreas = explode(',', (string) $this->printArea);

        if (isset($printAreas[$index - 1])) {

            return $printAreas[$index - 1];

        }

        throw new PhpSpreadsheetException('Requested Print Area does not exist');

    }

    /**

     * Is print area set?

     *

     * @param int $index Identifier for a specific print area range if several ranges have been set

     *                            Default behaviour, or an index value of 0, will identify whether any print range is set

     *                            Otherwise, existence of the range identified by the value of $index will be returned

     *                            Print areas are numbered from 1

     *

     * @return bool

     */

    public function isPrintAreaSet($index = 0)

    {

        if ($index == 0) {

            return $this->printArea !== null;

        }

        $printAreas = explode(',', (string) $this->printArea);

        return isset($printAreas[$index - 1]);

    }

    /**

     * Clear a print area.

     *

     * @param int $index Identifier for a specific print area range if several ranges have been set

     *                            Default behaviour, or an index value of 0, will clear all print ranges that are set

     *                            Otherwise, the range identified by the value of $index will be removed from the series

     *                            Print areas are numbered from 1

     *

     * @return $this

     */

    public function clearPrintArea($index = 0)

    {

        if ($index == 0) {

            $this->printArea = null;

        } else {

            $printAreas = explode(',', (string) $this->printArea);

            if (isset($printAreas[$index - 1])) {

                unset($printAreas[$index - 1]);

                $this->printArea = implode(',', $printAreas);

            }

        }

        return $this;

    }

    /**

     * Set print area. e.g. 'A1:D10' or 'A1:D10,G5:M20'.

     *

     * @param string $value

     * @param int $index Identifier for a specific print area range allowing several ranges to be set

     *                            When the method is "O"verwrite, then a positive integer index will overwrite that indexed

     *                                entry in the print areas list; a negative index value will identify which entry to

     *                                overwrite working bacward through the print area to the list, with the last entry as -1.

     *                                Specifying an index value of 0, will overwrite <b>all</b> existing print ranges.

     *                            When the method is "I"nsert, then a positive index will insert after that indexed entry in

     *                                the print areas list, while a negative index will insert before the indexed entry.

     *                                Specifying an index value of 0, will always append the new print range at the end of the

     *                                list.

     *                            Print areas are numbered from 1

     * @param string $method Determines the method used when setting multiple print areas

     *                            Default behaviour, or the "O" method, overwrites existing print area

     *                            The "I" method, inserts the new print area before any specified index, or at the end of the list

     *

     * @return $this

     */

    public function setPrintArea($value, $index = 0, $method = self::SETPRINTRANGE_OVERWRITE)

    {

        if (strpos($value, '!') !== false) {

            throw new PhpSpreadsheetException('Cell coordinate must not specify a worksheet.');

        } elseif (strpos($value, ':') === false) {

            throw new PhpSpreadsheetException('Cell coordinate must be a range of cells.');

        } elseif (strpos($value, '$') !== false) {

            throw new PhpSpreadsheetException('Cell coordinate must not be absolute.');

        }

        $value = strtoupper($value);

        if (!$this->printArea) {

            $index = 0;

        }

        if ($method == self::SETPRINTRANGE_OVERWRITE) {

            if ($index == 0) {

                $this->printArea = $value;

            } else {

                $printAreas = explode(',', (string) $this->printArea);

                if ($index < 0) {

                    $index = count($printAreas) - abs($index) + 1;

                }

                if (($index <= 0) || ($index > count($printAreas))) {

                    throw new PhpSpreadsheetException('Invalid index for setting print range.');

                }

                $printAreas[$index - 1] = $value;

                $this->printArea = implode(',', $printAreas);

            }

        } elseif ($method == self::SETPRINTRANGE_INSERT) {

            if ($index == 0) {

                $this->printArea = $this->printArea ? ($this->printArea . ',' . $value) : $value;

            } else {

                $printAreas = explode(',', (string) $this->printArea);

                if ($index < 0) {

                    $index = (int) abs($index) - 1;

                }

                if ($index > count($printAreas)) {

                    throw new PhpSpreadsheetException('Invalid index for setting print range.');

                }

                $printAreas = array_merge(array_slice($printAreas, 0, $index), [$value], array_slice($printAreas, $index));

                $this->printArea = implode(',', $printAreas);

            }

        } else {

            throw new PhpSpreadsheetException('Invalid method for setting print range.');

        }

        return $this;

    }

    /**

     * Add a new print area (e.g. 'A1:D10' or 'A1:D10,G5:M20') to the list of print areas.

     *

     * @param string $value

     * @param int $index Identifier for a specific print area range allowing several ranges to be set

     *                            A positive index will insert after that indexed entry in the print areas list, while a

     *                                negative index will insert before the indexed entry.

     *                                Specifying an index value of 0, will always append the new print range at the end of the

     *                                list.

     *                            Print areas are numbered from 1

     *

     * @return $this

     */

    public function addPrintArea($value, $index = -1)

    {

        return $this->setPrintArea($value, $index, self::SETPRINTRANGE_INSERT);

    }

    /**

     * Set print area.

     *

     * @param int $column1 Column 1

     * @param int $row1 Row 1

     * @param int $column2 Column 2

     * @param int $row2 Row 2

     * @param int $index Identifier for a specific print area range allowing several ranges to be set

     *                                When the method is "O"verwrite, then a positive integer index will overwrite that indexed

     *                                    entry in the print areas list; a negative index value will identify which entry to

     *                                    overwrite working backward through the print area to the list, with the last entry as -1.

     *                                    Specifying an index value of 0, will overwrite <b>all</b> existing print ranges.

     *                                When the method is "I"nsert, then a positive index will insert after that indexed entry in

     *                                    the print areas list, while a negative index will insert before the indexed entry.

     *                                    Specifying an index value of 0, will always append the new print range at the end of the

     *                                    list.

     *                                Print areas are numbered from 1

     * @param string $method Determines the method used when setting multiple print areas

     *                                Default behaviour, or the "O" method, overwrites existing print area

     *                                The "I" method, inserts the new print area before any specified index, or at the end of the list

     *

     * @return $this

     */

    public function setPrintAreaByColumnAndRow($column1, $row1, $column2, $row2, $index = 0, $method = self::SETPRINTRANGE_OVERWRITE)

    {

        return $this->setPrintArea(

            Coordinate::stringFromColumnIndex($column1) . $row1 . ':' . Coordinate::stringFromColumnIndex($column2) . $row2,

            $index,

            $method

        );

    }

    /**

     * Add a new print area to the list of print areas.

     *

     * @param int $column1 Start Column for the print area

     * @param int $row1 Start Row for the print area

     * @param int $column2 End Column for the print area

     * @param int $row2 End Row for the print area

     * @param int $index Identifier for a specific print area range allowing several ranges to be set

     *                                A positive index will insert after that indexed entry in the print areas list, while a

     *                                    negative index will insert before the indexed entry.

     *                                    Specifying an index value of 0, will always append the new print range at the end of the

     *                                    list.

     *                                Print areas are numbered from 1

     *

     * @return $this

     */

    public function addPrintAreaByColumnAndRow($column1, $row1, $column2, $row2, $index = -1)

    {

        return $this->setPrintArea(

            Coordinate::stringFromColumnIndex($column1) . $row1 . ':' . Coordinate::stringFromColumnIndex($column2) . $row2,

            $index,

            self::SETPRINTRANGE_INSERT

        );

    }

    /**

     * Get first page number.

     *

     * @return ?int

     */

    public function getFirstPageNumber()

    {

        return $this->firstPageNumber;

    }

    /**

     * Set first page number.

     *

     * @param ?int $value

     *

     * @return $this

     */

    public function setFirstPageNumber($value)

    {

        $this->firstPageNumber = $value;

        return $this;

    }

    /**

     * Reset first page number.

     *

     * @return $this

     */

    public function resetFirstPageNumber()

    {

        return $this->setFirstPageNumber(null);

    }

    public function getPageOrder(): string

    {

        return $this->pageOrder;

    }

    public function setPageOrder(?string $pageOrder): self

    {

        if ($pageOrder === null || $pageOrder === self::PAGEORDER_DOWN_THEN_OVER || $pageOrder === self::PAGEORDER_OVER_THEN_DOWN) {

            $this->pageOrder = $pageOrder ?? self::PAGEORDER_DOWN_THEN_OVER;

        }

        return $this;

    }

}