PHPExcel_Worksheet_RowDimension Class Reference

Collaboration diagram for PHPExcel_Worksheet_RowDimension:

Public Member Functions
	__construct ($pIndex=0)
	Create a new PHPExcel_Worksheet_RowDimension.
	getRowIndex ()
	Get Row Index.
	setRowIndex ($pValue)
	Set Row Index.
	getRowHeight ()
	Get Row Height.
	setRowHeight ($pValue=-1)
	Set Row Height.
	getVisible ()
	Get Visible.
	setVisible ($pValue=true)
	Set Visible.
	getOutlineLevel ()
	Get Outline Level.
	setOutlineLevel ($pValue)
	Set Outline Level.
	getCollapsed ()
	Get Collapsed.
	setCollapsed ($pValue=true)
	Set Collapsed.
	getXfIndex ()
	Get index to cellXf.
	setXfIndex ($pValue=0)
	Set index to cellXf.
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy.

Private Attributes
	$_rowIndex
	$_rowHeight = -1
	$_visible = true
	$_outlineLevel = 0
	$_collapsed = false
	$_xfIndex

Detailed Description

Definition at line 36 of file RowDimension.php.

Constructor & Destructor Documentation

PHPExcel_Worksheet_RowDimension::__construct

(

$pIndex = 0

)

Create a new PHPExcel_Worksheet_RowDimension.

Parameters

int

$pIndex

Numeric row index

Definition at line 87 of file RowDimension.php.

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

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

Member Function Documentation

PHPExcel_Worksheet_RowDimension::__clone

(

)

Implement PHP __clone to create a deep clone, not just a shallow copy.

Definition at line 228 of file RowDimension.php.

                                  {
                $vars = get_object_vars($this);
                foreach ($vars as $key => $value) {
                        if (is_object($value)) {
                                $this->$key = clone $value;
                        } else {
                                $this->$key = $value;
                        }
                }
        }

PHPExcel_Worksheet_RowDimension::getCollapsed

(

)

Get Collapsed.

Returns

bool

Definition at line 188 of file RowDimension.php.

References $_collapsed.

                                   {
        return $this->_collapsed;
    }

PHPExcel_Worksheet_RowDimension::getOutlineLevel

(

)

Get Outline Level.

Returns

int

Definition at line 161 of file RowDimension.php.

References $_outlineLevel.

                                      {
        return $this->_outlineLevel;
    }

PHPExcel_Worksheet_RowDimension::getRowHeight

(

)

Get Row Height.

Returns

double

Definition at line 121 of file RowDimension.php.

References $_rowHeight.

                                   {
        return $this->_rowHeight;
    }

PHPExcel_Worksheet_RowDimension::getRowIndex

(

)

Get Row Index.

Returns

int

Definition at line 101 of file RowDimension.php.

References $_rowIndex.

                                  {
        return $this->_rowIndex;
    }

PHPExcel_Worksheet_RowDimension::getVisible

(

)

Get Visible.

Returns

bool

Definition at line 141 of file RowDimension.php.

References $_visible.

                                 {
        return $this->_visible;
    }

PHPExcel_Worksheet_RowDimension::getXfIndex

(

)

Get index to cellXf.

Returns

int

Definition at line 208 of file RowDimension.php.

References $_xfIndex.

        {
                return $this->_xfIndex;
        }

PHPExcel_Worksheet_RowDimension::setCollapsed

(

$pValue = true

)

Set Collapsed.

Parameters

bool

$pValue

Returns

PHPExcel_Worksheet_RowDimension

Definition at line 198 of file RowDimension.php.

                                                 {
        $this->_collapsed = $pValue;
        return $this;
    }

PHPExcel_Worksheet_RowDimension::setOutlineLevel

(

$pValue

)

Set Outline Level.

Value must be between 0 and 7

Parameters

int

$pValue

Exceptions

Exception

Returns

PHPExcel_Worksheet_RowDimension

Definition at line 174 of file RowDimension.php.

                                             {
        if ($pValue < 0 || $pValue > 7) {
                throw new Exception("Outline level must range between 0 and 7.");
        }

        $this->_outlineLevel = $pValue;
        return $this;
    }

PHPExcel_Worksheet_RowDimension::setRowHeight

(

$pValue = -1

)

Set Row Height.

Parameters

double

$pValue

Returns

PHPExcel_Worksheet_RowDimension

Definition at line 131 of file RowDimension.php.

                                               {
        $this->_rowHeight = $pValue;
        return $this;
    }

PHPExcel_Worksheet_RowDimension::setRowIndex

(

$pValue

)

Set Row Index.

Parameters

int

$pValue

Returns

PHPExcel_Worksheet_RowDimension

Definition at line 111 of file RowDimension.php.

                                         {
        $this->_rowIndex = $pValue;
        return $this;
    }

PHPExcel_Worksheet_RowDimension::setVisible

(

$pValue = true

)

Set Visible.

Parameters

bool

$pValue

Returns

PHPExcel_Worksheet_RowDimension

Definition at line 151 of file RowDimension.php.

                                               {
        $this->_visible = $pValue;
        return $this;
    }

PHPExcel_Worksheet_RowDimension::setXfIndex

(

$pValue = 0

)

Set index to cellXf.

Parameters

int

$pValue

Returns

PHPExcel_Worksheet_RowDimension

Definition at line 219 of file RowDimension.php.

        {
                $this->_xfIndex = $pValue;
                return $this;
        }

Field Documentation

PHPExcel_Worksheet_RowDimension::$_collapsed = false

private

Definition at line 73 of file RowDimension.php.

Referenced by getCollapsed().

PHPExcel_Worksheet_RowDimension::$_outlineLevel = 0

private

Definition at line 66 of file RowDimension.php.

Referenced by getOutlineLevel().

PHPExcel_Worksheet_RowDimension::$_rowHeight = -1

private

Definition at line 52 of file RowDimension.php.

Referenced by getRowHeight().

PHPExcel_Worksheet_RowDimension::$_rowIndex

private

Definition at line 43 of file RowDimension.php.

Referenced by getRowIndex().

PHPExcel_Worksheet_RowDimension::$_visible = true

private

Definition at line 59 of file RowDimension.php.

Referenced by getVisible().

PHPExcel_Worksheet_RowDimension::$_xfIndex

private

Definition at line 80 of file RowDimension.php.

Referenced by getXfIndex().

---

The documentation for this class was generated from the following file:

• Services/Excel/PHPExcel/1.7.6/Classes/PHPExcel/Worksheet/RowDimension.php