Docs For Class PHPExcel_Style_Borders

PHPExcel_Style

# Class: PHPExcel_Style_Borders

Source Location: /PHPExcel/Style/Borders.php

### Class Overview

PHPExcel_Style_Borders

#### Author(s):

#### Copyright:

- Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)

Implements interfaces:

- PHPExcel_IComparable

### 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 36]
PHPExcel_Style_Borders

#### Tags:

copyright: | Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)

[ Top ]

### Class Methods

### constructor __construct [line 145]

`PHPExcel_Style_Borders __construct( [ $isSupervisor = false])`

Create a new PHPExcel_Style_Borders

#### Tags:

access: | public

#### Parameters:

| $isSupervisor |

[ Top ]

### method applyFromArray [line 295]

`PHPExcel_Style_Borders applyFromArray( [array $pStyles = null])`

Apply styles from array

1. $objPHPExcel-> getActiveSheet()->getStyle('B2')->getBorders()-> applyFromArray(
2. array(
3. 'bottom' => array(
4. 'style' => PHPExcel_Style_Border:: BORDER_DASHDOT,
5. 'color' => array(
6. 'rgb' => '808080'
7. )
8. ),
9. 'top' => array(
10. 'style' => PHPExcel_Style_Border:: BORDER_DASHDOT,
11. 'color' => array(
12. 'rgb' => '808080'
13. )
14. )
15. )
16. );

1. $objPHPExcel-> getActiveSheet()->getStyle('B2')->getBorders()-> applyFromArray(
2. array(
3. 'allborders' => array(
4. 'style' => PHPExcel_Style_Border:: BORDER_DASHDOT,
5. 'color' => array(
6. 'rgb' => '808080'
7. )
8. )
9. )
10. );

#### Tags:

throws: | Exception
access: | public

#### Parameters:

array | $pStyles | Array containing style information

[ Top ]

### method bindParent [line 187]

`PHPExcel_Style_Borders bindParent( PHPExcel_Style $parent)`

Bind parent. Only used for supervisor

#### Tags:

access: | public

#### Parameters:

PHPExcel_Style | $parent |

[ Top ]

### method getActiveCell [line 241]

`string getActiveCell( )`

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 219]

`PHPExcel_Worksheet getActiveSheet( )`

Get the currently active sheet. Only used for supervisor

#### Tags:

access: | public

[ Top ]

### method getAllBorders [line 382]

`PHPExcel_Style_Border getAllBorders( )`

Get AllBorders (pseudo-border). Only applies to supervisor.

#### Tags:

throws: | Exception
access: | public

[ Top ]

### method getBottom [line 363]

`PHPExcel_Style_Border getBottom( )`

Get Bottom

#### Tags:

access: | public

[ Top ]

### method getDiagonal [line 372]

`PHPExcel_Style_Border getDiagonal( )`

Get Diagonal

#### Tags:

access: | public

[ Top ]

### method getDiagonalDirection [line 446]

`int getDiagonalDirection( )`

Get DiagonalDirection

#### Tags:

access: | public

[ Top ]

### method getHashCode [line 477]

`string getHashCode( )`

Get hash code

#### Tags:

return: | Hash code
access: | public

[ Top ]

### method getHorizontal [line 434]

`PHPExcel_Style_Border getHorizontal( )`

Get Horizontal (pseudo-border). Only applies to supervisor.

#### Tags:

throws: | Exception
access: | public

[ Top ]

### method getInside [line 408]

`boolean getInside( )`

Get Inside (pseudo-border). Only applies to supervisor.

#### Tags:

throws: | Exception
access: | public

[ Top ]

### method getIsSupervisor [line 198]

`boolean getIsSupervisor( )`

Is this a supervisor or a real style component?

#### Tags:

access: | public

[ Top ]

### method getLeft [line 336]

`PHPExcel_Style_Border getLeft( )`

Get Left

#### Tags:

access: | public

[ Top ]

### method getOutline [line 395]

`boolean getOutline( )`

Get Outline (pseudo-border). Only applies to supervisor.

#### Tags:

throws: | Exception
access: | public

[ Top ]

### method getRight [line 345]

`PHPExcel_Style_Border getRight( )`

Get Right

#### Tags:

access: | public

[ Top ]

### method getSelectedCells [line 230]

`string getSelectedCells( )`

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 209]

`PHPExcel_Style_Borders getSharedComponent( )`

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 252]

`array getStyleArray( array $array)`

Build style array from subcomponents

#### Tags:

access: | public

#### Parameters:

array | $array |

[ Top ]

### method getTop [line 354]

`PHPExcel_Style_Border getTop( )`

Get Top

#### Tags:

access: | public

[ Top ]

### method getVertical [line 421]

`PHPExcel_Style_Border getVertical( )`

Get Vertical (pseudo-border). Only applies to supervisor.

#### Tags:

throws: | Exception
access: | public

[ Top ]

### method setDiagonalDirection [line 459]

`PHPExcel_Style_Borders setDiagonalDirection( [int $pValue = PHPExcel_Style_Borders::DIAGONAL_NONE])`

Set DiagonalDirection

#### Tags:

access: | public

#### Parameters:

int | $pValue |

[ Top ]

### method __clone [line 495]

`void __clone( )`

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

#### Tags:

access: | public

[ Top ]

### Class Constants

#### DIAGONAL_BOTH = 3

[line 42]

[ Top ]

#### DIAGONAL_DOWN = 2

[line 41]

[ Top ]

#### DIAGONAL_NONE = 0

[line 39]

[ Top ]

#### DIAGONAL_UP = 1

[line 40]

[ Top ]

Documentation generated on Sun, 27 Feb 2011 16:28:40 -0800 by phpDocumentor 1.4.3