PHPExcel_Style

# Class: PHPExcel_Style_Borders Source Location: /PHPExcel/Style/Borders.php
### Class Overview
PHPExcel_Style_Borders #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) Implements interfaces: PHPExcel_IComparable | ### Variables $_allBorders $_bottom $_diagonal $_diagonalDirection $_horizontal $_inside $_isSupervisor $_left $_outline $_parent $_parentPropertyName $_right $_top $_vertical | ### Constants DIAGONAL_BOTH DIAGONAL_DOWN DIAGONAL_NONE DIAGONAL_UP | ### Methods __construct applyFromArray bindParent getActiveCell getActiveSheet getAllBorders getBottom getDiagonal getDiagonalDirection getHashCode getHorizontal getInside getIsSupervisor getLeft getOutline getRight getSelectedCells getSharedComponent getStyleArray getTop getVertical setDiagonalDirection __clone
### Class Details [line 51] PHPExcel_Style_Borders PHPExcel_Style_Borders #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_allBorders = [line 106] All borders psedo-border. All borders psedo-border. Only applies to supervisor. #### Tags:
access: | private
Type: | PHPExcel_Style_Border
[ Top ] #### $_bottom = [line 85] Bottom Bottom #### Tags:
access: | private
Type: | PHPExcel_Style_Border
[ Top ] #### $_diagonal = [line 92] Diagonal Diagonal #### Tags:
access: | private
Type: | PHPExcel_Style_Border
[ Top ] #### $_diagonalDirection = [line 99] DiagonalDirection DiagonalDirection #### Tags:
access: | private
Type: | int
[ Top ] #### $_horizontal = [line 134] Horizontal pseudo-border. Horizontal pseudo-border. Only applies to supervisor. #### Tags:
access: | private
Type: | PHPExcel_Style_Border
[ Top ] #### $_inside = [line 120] Inside psedo-border. Inside psedo-border. Only applies to supervisor. #### Tags:
access: | private
Type: | PHPExcel_Style_Border
[ Top ] #### $_isSupervisor = [line 148] Supervisor? Supervisor? #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_left = [line 64] Left Left #### Tags:
access: | private
Type: | PHPExcel_Style_Border
[ Top ] #### $_outline = [line 113] Outline psedo-border. Outline psedo-border. Only applies to supervisor. #### Tags:
access: | private
Type: | PHPExcel_Style_Border
[ Top ] #### $_parent = [line 155] Parent. Parent. Only used for supervisor #### Tags:
access: | private
Type: | PHPExcel_Style
[ Top ] #### $_parentPropertyName = [line 141] Parent Borders Parent Borders #### Tags:
var: | string
access: | private
Type: | _parentPropertyName
[ Top ] #### $_right = [line 71] Right Right #### Tags:
access: | private
Type: | PHPExcel_Style_Border
[ Top ] #### $_top = [line 78] Top Top #### Tags:
access: | private
Type: | PHPExcel_Style_Border
[ Top ] #### $_vertical = [line 127] Vertical pseudo-border. Vertical pseudo-border. Only applies to supervisor. #### Tags:
access: | private
Type: | PHPExcel_Style_Border
[ Top ] ### Class Methods ### constructor __construct [line 160]
`PHPExcel_Style_Borders __construct( [ $isSupervisor = false])`
Create a new PHPExcel_Style_Borders Create a new PHPExcel_Style_Borders #### Tags:
access: | public
#### Parameters:
| $isSupervisor |
[ Top ] ### method applyFromArray [line 310]
`PHPExcel_Style_Borders applyFromArray( [array $pStyles = null])`
Apply styles from array Apply styles from array $objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray( array( 'bottom' => array( 'style' => PHPExcel_Style_Border::BORDER_DASHDOT, 'color' => array( 'rgb' => '808080' ) ), 'top' => array( 'style' => PHPExcel_Style_Border::BORDER_DASHDOT, 'color' => array( 'rgb' => '808080' ) ) ) ); $objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray( array( 'allborders' => array( 'style' => PHPExcel_Style_Border::BORDER_DASHDOT, 'color' => array( 'rgb' => '808080' ) ) ) ); #### Tags:
throws: | Exception
access: | public
#### Parameters:
array | $pStyles | Array containing style information
[ Top ] ### method bindParent [line 202]
`PHPExcel_Style_Borders bindParent( PHPExcel_Style $parent)`
Bind parent. Bind parent. Only used for supervisor #### Tags:
access: | public
#### Parameters:
PHPExcel_Style | $parent |
[ Top ] ### method getActiveCell [line 256]
`string getActiveCell( )`
Get the currently active cell coordinate in currently active sheet. Get the currently active cell coordinate in currently active sheet. Only used for supervisor #### Tags:
return: | E.g. 'A1'
access: | public
[ Top ] ### method getActiveSheet [line 234]
`PHPExcel_Worksheet getActiveSheet( )`
Get the currently active sheet. Get the currently active sheet. Only used for supervisor #### Tags:
access: | public
[ Top ] ### method getAllBorders [line 391]
`PHPExcel_Style_Border getAllBorders( )`
Get AllBorders (pseudo-border). Get AllBorders (pseudo-border). Only applies to supervisor. #### Tags:
throws: | Exception
access: | public
[ Top ] ### method getBottom [line 372]
`PHPExcel_Style_Border getBottom( )`
Get Bottom Get Bottom #### Tags:
access: | public
[ Top ] ### method getDiagonal [line 381]
`PHPExcel_Style_Border getDiagonal( )`
Get Diagonal Get Diagonal #### Tags:
access: | public
[ Top ] ### method getDiagonalDirection [line 455]
`int getDiagonalDirection( )`
Get DiagonalDirection Get DiagonalDirection #### Tags:
access: | public
[ Top ] ### method getHashCode [line 486]
`string getHashCode( )`
Get hash code Get hash code #### Tags:
return: | Hash code
access: | public
[ Top ] ### method getHorizontal [line 443]
`PHPExcel_Style_Border getHorizontal( )`
Get Horizontal (pseudo-border). Get Horizontal (pseudo-border). Only applies to supervisor. #### Tags:
throws: | Exception
access: | public
[ Top ] ### method getInside [line 417]
`boolean getInside( )`
Get Inside (pseudo-border). Get Inside (pseudo-border). Only applies to supervisor. #### Tags:
throws: | Exception
access: | public
[ Top ] ### method getIsSupervisor [line 213]
`boolean getIsSupervisor( )`
Is this a supervisor or a real style component? Is this a supervisor or a real style component? #### Tags:
access: | public
[ Top ] ### method getLeft [line 345]
`PHPExcel_Style_Border getLeft( )`
Get Left Get Left #### Tags:
access: | public
[ Top ] ### method getOutline [line 404]
`boolean getOutline( )`
Get Outline (pseudo-border). Get Outline (pseudo-border). Only applies to supervisor. #### Tags:
throws: | Exception
access: | public
[ Top ] ### method getRight [line 354]
`PHPExcel_Style_Border getRight( )`
Get Right Get Right #### Tags:
access: | public
[ Top ] ### method getSelectedCells [line 245]
`string getSelectedCells( )`
Get the currently active cell coordinate in currently active sheet. Get the currently active cell coordinate in currently active sheet. Only used for supervisor #### Tags:
return: | E.g. 'A1'
access: | public
[ Top ] ### method getSharedComponent [line 224]
`PHPExcel_Style_Borders getSharedComponent( )`
Get the shared style component for the currently active cell in currently active sheet. Get the shared style component for the currently active cell in currently active sheet. Only used for style supervisor #### Tags:
access: | public
[ Top ] ### method getStyleArray [line 267]
`array getStyleArray( array $array)`
Build style array from subcomponents Build style array from subcomponents #### Tags:
access: | public
#### Parameters:
array | $array |
[ Top ] ### method getTop [line 363]
`PHPExcel_Style_Border getTop( )`
Get Top Get Top #### Tags:
access: | public
[ Top ] ### method getVertical [line 430]
`PHPExcel_Style_Border getVertical( )`
Get Vertical (pseudo-border). Get Vertical (pseudo-border). Only applies to supervisor. #### Tags:
throws: | Exception
access: | public
[ Top ] ### method setDiagonalDirection [line 468]
`PHPExcel_Style_Borders setDiagonalDirection( [int $pValue = PHPExcel_Style_Borders::DIAGONAL_NONE])`
Set DiagonalDirection Set DiagonalDirection #### Tags:
access: | public
#### Parameters:
int | $pValue |
[ Top ] ### method __clone [line 504]
`void __clone( )`
Implement PHP __clone to create a deep clone, not just a shallow copy. Implement PHP __clone to create a deep clone, not just a shallow copy. #### Tags:
access: | public
[ Top ] ### Class Constants #### DIAGONAL_BOTH = 3 [line 57] [ Top ] #### DIAGONAL_DOWN = 2 [line 56] [ Top ] #### DIAGONAL_NONE = 0 [line 54] [ Top ] #### DIAGONAL_UP = 1 [line 55] [ Top ] Documentation generated on Mon, 11 Jan 2010 08:06:43 +0100 by phpDocumentor 1.4.1