source-class-Com.Tecnick.Pdf.Page.Region

It appears that you are using AdBlocking software. The cost of running this website is covered by advertisements. If you like it please feel free to a small amount of money to secure the future of this website.
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 
<?php
/**
 * Region.php
 *
 * @since       2011-05-23
 * @category    Library
 * @package     PdfPage
 * @author      Nicola Asuni <info@tecnick.com>
 * @copyright   2011-2015 Nicola Asuni - Tecnick.com LTD
 * @license     http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
 * @link        https://github.com/tecnickcom/tc-lib-pdf-page
 *
 * This file is part of tc-lib-pdf-page software library.
 */

namespace Com\Tecnick\Pdf\Page;

use \Com\Tecnick\Color\Pdf as Color;
use \Com\Tecnick\Pdf\Page\Exception as PageException;

/**
 * Com\Tecnick\Pdf\Page\Region
 *
 * @since       2011-05-23
 * @category    Library
 * @package     PdfPage
 * @author      Nicola Asuni <info@tecnick.com>
 * @copyright   2011-2015 Nicola Asuni - Tecnick.com LTD
 * @license     http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
 * @link        https://github.com/tecnickcom/tc-lib-pdf-page
 *
 * A page region defines the writable area of the page.
 */
abstract class Region extends \Com\Tecnick\Pdf\Page\Settings
{
    /**
     * Select the specified page region.
     *
     * @return array Selected region data
     */
    public function selectRegion($idr)
    {
        $this->page[$this->pageid]['currentRegion'] = min(max(0, intval($idr)), $this->page[$this->pageid]['columns']);
        return $this->getCurrentRegion();
    }

    /**
     * Returns the current region data
     *
     * @return array
     */
    public function getCurrentRegion()
    {
        return $this->page[$this->pageid]['region'][$this->page[$this->pageid]['currentRegion']];
    }

    /**
     * Returns the page data with the next selected region.
     * If there are no more regions available,
     * then the first region on the next page is selected.
     * A new page is added if required.
     *
     * @return array Current page data
     */
    public function getNextRegion()
    {
        $nextid = ($this->page[$this->pageid]['currentRegion'] + 1);
        if (isset($this->page[$this->pageid]['region'][$nextid])) {
            $this->page[$this->pageid]['currentRegion'] = $nextid;
            return $this->page[$this->pageid];
        }
        return $this->getNextPage();
    }

    /**
     * Returns the next page data.
     * Creates a new page if required and page break is enabled.
     *
     * @return array Page data
     */
    public function getNextPage()
    {
        if ($this->pageid < $this->pmaxid) {
            return $this->page[++$this->pageid];
        }
        if (!$this->isAutoPageBreakEnabled()) {
            return $this->getCurrentPage();
        }
        return $this->add();
    }

    /**
     * Move to the next page region if required.
     *
     * @param float $height Height of the block to add.
     * @param float $ypos   Starting Y position or NULL for current position.
     *
     * @return array Page data
     */
    public function checkRegionBreak($height = 0, $ypos = null)
    {
        if ($this->isYOutRegion($ypos, $height)) {
            return $this->getNextRegion();
        }
        return $this->getCurrentPage();
    }

    /**
     * Return the auto-page-break status
     *
     * @return bool True if the auto page break is enabled, false otherwise.
     */
    public function isAutoPageBreakEnabled()
    {
        return $this->page[$this->pageid]['autobreak'];
    }

    /**
     * Enable or disable automatic page break.
     *
     * @param bool $isenabled Set this to true to enable automatic page break.
     */
    public function enableAutoPageBreak($isenabled = true)
    {
        $this->page[$this->pageid]['autobreak'] = (bool) $isenabled;
    }

    /**
     * Check if the specified position is outside the region.
     *
     * @param float  $pos Position
     * @param string $min ID of the min region value to check
     * @param string $max ID of the max region value to check
     *
     * @return boolean
     */
    private function isOutRegion($pos, $min, $max)
    {
        $region = $this->getCurrentRegion();
        if (($pos < ($region[$min] - self::EPS)) || ($pos > ($region[$max] + self::EPS))) {
            return true;
        }
        return false;
    }

    /**
     * Check if the specified vertical position is outside the region.
     *
     * @param float $posy   Y position or NULL for current position.
     * @param float $height Additional height to add.
     *
     * @return boolean
     */
    public function isYOutRegion($posy = null, $height = 0)
    {
        if ($posy === null) {
            $posy = $this->getY();
        }
        return $this->isOutRegion(floatval($posy + $height), 'RY', 'RT');
    }

    /**
     * Check if the specified horizontal position is outside the region.
     *
     * @param float $posx  X position or NULL for current position.
     * @param float $width Additional width to add.
     *
     * @return boolean
     */
    public function isXOutRegion($posx = null, $width = 0)
    {
        if ($posx === null) {
            $posx = $this->getX();
        }
        return $this->isOutRegion(floatval($posx + $width), 'RX', 'RL');
    }

    /**
     * Return the absolute horizontal cursor position for the current region.
     *
     * @return float
     */
    public function getX()
    {
        return $this->page[$this->pageid]['region'][$this->page[$this->pageid]['currentRegion']]['x'];
    }

    /**
     * Return the absolute vertical cursor position for the current region.
     *
     * @return float
     */
    public function getY()
    {
        return $this->page[$this->pageid]['region'][$this->page[$this->pageid]['currentRegion']]['y'];
    }

    /**
     * Set the absolute horizontal cursor position for the current region.
     *
     * @param foat $xpos X position relative to the page coordinates.
     */
    public function setX($xpos)
    {
        $this->page[$this->pageid]['region'][$this->page[$this->pageid]['currentRegion']]['x'] = floatval($xpos);
        return $this;
    }

    /**
     * Set the absolute vertical cursor position for the current region.
     *
     * @param foat $ypos Y position relative to the page coordinates.
     */
    public function setY($ypos)
    {
        $this->page[$this->pageid]['region'][$this->page[$this->pageid]['currentRegion']]['y'] = floatval($ypos);
        return $this;
    }
}
 

© 2004-2017 – Nicola Asuni - Tecnick.com - All rights reserved.
about - disclaimer - privacy