class PHPExcel_Worksheet_RowDimension in Loft Data Grids 7.2

PHPExcel_Worksheet_RowDimension

@category PHPExcel @package PHPExcel_Worksheet @copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)

Hierarchy

• class \PHPExcel_Worksheet_RowDimension

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Worksheet/RowDimension.php, line 36

class PHPExcel_Worksheet_RowDimension {

  /**
   * Row index
   *
   * @var int
   */
  private $_rowIndex;

  /**
   * Row height (in pt)
   *
   * When this is set to a negative value, the row height should be ignored by IWriter
   *
   * @var double
   */
  private $_rowHeight = -1;

  /**
   * ZeroHeight for Row?
   *
   * @var bool
   */
  private $_zeroHeight = false;

  /**
   * Visible?
   *
   * @var bool
   */
  private $_visible = true;

  /**
   * Outline level
   *
   * @var int
   */
  private $_outlineLevel = 0;

  /**
   * Collapsed
   *
   * @var bool
   */
  private $_collapsed = false;

  /**
   * Index to cellXf. Null value means row has no explicit cellXf format.
   *
   * @var int|null
   */
  private $_xfIndex;

  /**
   * Create a new PHPExcel_Worksheet_RowDimension
   *
   * @param int $pIndex Numeric row index
   */
  public function __construct($pIndex = 0) {

    // Initialise values
    $this->_rowIndex = $pIndex;

    // set row dimension as unformatted by default
    $this->_xfIndex = null;
  }

  /**
   * Get Row Index
   *
   * @return int
   */
  public function getRowIndex() {
    return $this->_rowIndex;
  }

  /**
   * Set Row Index
   *
   * @param int $pValue
   * @return PHPExcel_Worksheet_RowDimension
   */
  public function setRowIndex($pValue) {
    $this->_rowIndex = $pValue;
    return $this;
  }

  /**
   * Get Row Height
   *
   * @return double
   */
  public function getRowHeight() {
    return $this->_rowHeight;
  }

  /**
   * Set Row Height
   *
   * @param double $pValue
   * @return PHPExcel_Worksheet_RowDimension
   */
  public function setRowHeight($pValue = -1) {
    $this->_rowHeight = $pValue;
    return $this;
  }

  /**
   * Get ZeroHeight
   *
   * @return bool
   */
  public function getZeroHeight() {
    return $this->_zeroHeight;
  }

  /**
   * Set ZeroHeight
   *
   * @param bool $pValue
   * @return PHPExcel_Worksheet_RowDimension
   */
  public function setZeroHeight($pValue = false) {
    $this->_zeroHeight = $pValue;
    return $this;
  }

  /**
   * Get Visible
   *
   * @return bool
   */
  public function getVisible() {
    return $this->_visible;
  }

  /**
   * Set Visible
   *
   * @param bool $pValue
   * @return PHPExcel_Worksheet_RowDimension
   */
  public function setVisible($pValue = true) {
    $this->_visible = $pValue;
    return $this;
  }

  /**
   * Get Outline Level
   *
   * @return int
   */
  public function getOutlineLevel() {
    return $this->_outlineLevel;
  }

  /**
   * Set Outline Level
   *
   * Value must be between 0 and 7
   *
   * @param int $pValue
   * @throws PHPExcel_Exception
   * @return PHPExcel_Worksheet_RowDimension
   */
  public function setOutlineLevel($pValue) {
    if ($pValue < 0 || $pValue > 7) {
      throw new PHPExcel_Exception("Outline level must range between 0 and 7.");
    }
    $this->_outlineLevel = $pValue;
    return $this;
  }

  /**
   * Get Collapsed
   *
   * @return bool
   */
  public function getCollapsed() {
    return $this->_collapsed;
  }

  /**
   * Set Collapsed
   *
   * @param bool $pValue
   * @return PHPExcel_Worksheet_RowDimension
   */
  public function setCollapsed($pValue = true) {
    $this->_collapsed = $pValue;
    return $this;
  }

  /**
   * Get index to cellXf
   *
   * @return int
   */
  public function getXfIndex() {
    return $this->_xfIndex;
  }

  /**
   * Set index to cellXf
   *
   * @param int $pValue
   * @return PHPExcel_Worksheet_RowDimension
   */
  public function setXfIndex($pValue = 0) {
    $this->_xfIndex = $pValue;
    return $this;
  }

  /**
   * Implement PHP __clone to create a deep clone, not just a shallow copy.
   */
  public function __clone() {
    $vars = get_object_vars($this);
    foreach ($vars as $key => $value) {
      if (is_object($value)) {
        $this->{$key} = clone $value;
      }
      else {
        $this->{$key} = $value;
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPExcel_Worksheet_RowDimension::$_collapsed	private	property	* Collapsed * *
PHPExcel_Worksheet_RowDimension::$_outlineLevel	private	property	* Outline level * *
PHPExcel_Worksheet_RowDimension::$_rowHeight	private	property	* Row height (in pt) * * When this is set to a negative value, the row height should be ignored by IWriter * *
PHPExcel_Worksheet_RowDimension::$_rowIndex	private	property	* Row index * *
PHPExcel_Worksheet_RowDimension::$_visible	private	property	* Visible? * *
PHPExcel_Worksheet_RowDimension::$_xfIndex	private	property	* Index to cellXf. Null value means row has no explicit cellXf format. * *
PHPExcel_Worksheet_RowDimension::$_zeroHeight	private	property	* ZeroHeight for Row? * *
PHPExcel_Worksheet_RowDimension::getCollapsed	public	function	Get Collapsed
PHPExcel_Worksheet_RowDimension::getOutlineLevel	public	function	Get Outline Level
PHPExcel_Worksheet_RowDimension::getRowHeight	public	function	Get Row Height
PHPExcel_Worksheet_RowDimension::getRowIndex	public	function	Get Row Index
PHPExcel_Worksheet_RowDimension::getVisible	public	function	Get Visible
PHPExcel_Worksheet_RowDimension::getXfIndex	public	function	* Get index to cellXf * *
PHPExcel_Worksheet_RowDimension::getZeroHeight	public	function	* Get ZeroHeight * *
PHPExcel_Worksheet_RowDimension::setCollapsed	public	function	Set Collapsed
PHPExcel_Worksheet_RowDimension::setOutlineLevel	public	function	Set Outline Level
PHPExcel_Worksheet_RowDimension::setRowHeight	public	function	Set Row Height
PHPExcel_Worksheet_RowDimension::setRowIndex	public	function	Set Row Index
PHPExcel_Worksheet_RowDimension::setVisible	public	function	Set Visible
PHPExcel_Worksheet_RowDimension::setXfIndex	public	function	* Set index to cellXf * *
PHPExcel_Worksheet_RowDimension::setZeroHeight	public	function	* Set ZeroHeight * *
PHPExcel_Worksheet_RowDimension::__clone	public	function	* Implement PHP __clone to create a deep clone, not just a shallow copy.
PHPExcel_Worksheet_RowDimension::__construct	public	function	Create a new PHPExcel_Worksheet_RowDimension