PHPExcel_Worksheet_ColumnDimension Class Reference

Collaboration diagram for PHPExcel_Worksheet_ColumnDimension:

Public Member Functions
	__construct ($pIndex= 'A')
	Create a new PHPExcel_Worksheet_RowDimension.
	getColumnIndex ()
	Get ColumnIndex.
	setColumnIndex ($pValue)
	Set ColumnIndex.
	getWidth ()
	Get Width.
	setWidth ($pValue=-1)
	Set Width.
	getAutoSize ()
	Get Auto Size.
	setAutoSize ($pValue=false)
	Set Auto Size.
	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.
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy.

Private Attributes
	$_columnIndex
	$_width
	$_autoSize
	$_visible
	$_outlineLevel = 0
	$_collapsed

Detailed Description

Definition at line 36 of file ColumnDimension.php.

Constructor & Destructor Documentation

PHPExcel_Worksheet_ColumnDimension::__construct

(

$pIndex = 'A'

)

Create a new PHPExcel_Worksheet_RowDimension.

Parameters

string

$pIndex

Character column index

Definition at line 87 of file ColumnDimension.php.

    {
        // Initialise values
        $this->_columnIndex             = $pIndex;
        $this->_width                   = -1;
        $this->_autoSize                = false;
        $this->_visible                 = true;
        $this->_outlineLevel    = 0;
        $this->_collapsed               = false;
    }

Member Function Documentation

PHPExcel_Worksheet_ColumnDimension::__clone

(

)

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

Definition at line 228 of file ColumnDimension.php.

References $key.

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

PHPExcel_Worksheet_ColumnDimension::getAutoSize

(

)

Get Auto Size.

Returns

bool

Definition at line 143 of file ColumnDimension.php.

References $_autoSize.

                                  {
        return $this->_autoSize;
    }

PHPExcel_Worksheet_ColumnDimension::getCollapsed

(

)

Get Collapsed.

Returns

bool

Definition at line 210 of file ColumnDimension.php.

References $_collapsed.

                                   {
        return $this->_collapsed;
    }

PHPExcel_Worksheet_ColumnDimension::getColumnIndex

(

)

Get ColumnIndex.

Returns

string

Definition at line 103 of file ColumnDimension.php.

References $_columnIndex.

                                     {
        return $this->_columnIndex;
    }

PHPExcel_Worksheet_ColumnDimension::getOutlineLevel

(

)

Get Outline Level.

Returns

int

Definition at line 183 of file ColumnDimension.php.

References $_outlineLevel.

                                      {
        return $this->_outlineLevel;
    }

PHPExcel_Worksheet_ColumnDimension::getVisible

(

)

Get Visible.

Returns

bool

Definition at line 163 of file ColumnDimension.php.

References $_visible.

                                 {
        return $this->_visible;
    }

PHPExcel_Worksheet_ColumnDimension::getWidth

(

)

Get Width.

Returns

double

Definition at line 123 of file ColumnDimension.php.

References $_width.

                               {
        return $this->_width;
    }

PHPExcel_Worksheet_ColumnDimension::setAutoSize

(

$pValue = false

)

Set Auto Size.

Parameters

bool

$pValue

Returns

PHPExcel_Worksheet_ColumnDimension

Definition at line 153 of file ColumnDimension.php.

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

PHPExcel_Worksheet_ColumnDimension::setCollapsed

(

$pValue = true

)

Set Collapsed.

Parameters

bool

$pValue

Returns

PHPExcel_Worksheet_ColumnDimension

Definition at line 220 of file ColumnDimension.php.

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

PHPExcel_Worksheet_ColumnDimension::setColumnIndex

(

$pValue

)

Set ColumnIndex.

Parameters

string

$pValue

Returns

PHPExcel_Worksheet_ColumnDimension

Definition at line 113 of file ColumnDimension.php.

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

PHPExcel_Worksheet_ColumnDimension::setOutlineLevel

(

$pValue

)

Set Outline Level.

Value must be between 0 and 7

Parameters

int

$pValue

Exceptions

Exception

Returns

PHPExcel_Worksheet_ColumnDimension

Definition at line 196 of file ColumnDimension.php.

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

PHPExcel_Worksheet_ColumnDimension::setVisible

(

$pValue = true

)

Set Visible.

Parameters

bool

$pValue

Returns

PHPExcel_Worksheet_ColumnDimension

Definition at line 173 of file ColumnDimension.php.

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

PHPExcel_Worksheet_ColumnDimension::setWidth

(

$pValue = -1

)

Set Width.

Parameters

double

$pValue

Returns

PHPExcel_Worksheet_ColumnDimension

Definition at line 133 of file ColumnDimension.php.

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

Field Documentation

PHPExcel_Worksheet_ColumnDimension::$_autoSize

private

Definition at line 59 of file ColumnDimension.php.

Referenced by getAutoSize().

PHPExcel_Worksheet_ColumnDimension::$_collapsed

private

Definition at line 80 of file ColumnDimension.php.

Referenced by getCollapsed().

PHPExcel_Worksheet_ColumnDimension::$_columnIndex

private

Definition at line 43 of file ColumnDimension.php.

Referenced by getColumnIndex().

PHPExcel_Worksheet_ColumnDimension::$_outlineLevel = 0

private

Definition at line 73 of file ColumnDimension.php.

Referenced by getOutlineLevel().

PHPExcel_Worksheet_ColumnDimension::$_visible

private

Definition at line 66 of file ColumnDimension.php.

Referenced by getVisible().

PHPExcel_Worksheet_ColumnDimension::$_width

private

Definition at line 52 of file ColumnDimension.php.

Referenced by getWidth().

---

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

• Services/Excel/classes/PHPExcel/Worksheet/ColumnDimension.php