PHPExcel_Style
[ class tree: PHPExcel_Style ] [ index: PHPExcel_Style ] [ all elements ]

Class: PHPExcel_Style_Border

Source Location: /PHPExcel/Style/Border.php

Class Overview


PHPExcel_Style_Border


Author(s):

Copyright:

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

Implements interfaces:

Variables

Constants

Methods



Class Details

[line 51]
PHPExcel_Style_Border

PHPExcel_Style_Border




Tags:

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


[ Top ]


Class Variables

$_borderStyle =

[line 74]

Border style

Border style




Tags:

access:  private

Type:   string


[ Top ]

$_color =

[line 81]

Border color

Border color




Tags:

access:  private



[ Top ]

$_isSupervisor =

[line 88]

Supervisor?

Supervisor?




Tags:

access:  private

Type:   boolean


[ Top ]

$_parent =

[line 95]

Parent.

Parent. Only used for supervisor




Tags:

access:  private



[ Top ]

$_parentPropertyName =

[line 102]

Parent property name

Parent property name




Tags:

access:  private

Type:   string


[ Top ]



Class Methods


method applyFromArray [line 289]

PHPExcel_Style_Border applyFromArray( [array $pStyles = null])

Apply styles from array

Apply styles from array

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




Tags:

throws:  Exception
access:  public


Parameters:

array   $pStyles   Array containing style information

[ Top ]

method bindParent [line 129]

PHPExcel_Style_Border bindParent( PHPExcel_Style_Borders $parent, string $parentPropertyName)

Bind parent.

Bind parent. Only used for supervisor




Tags:

access:  public


Parameters:

PHPExcel_Style_Borders   $parent  
string   $parentPropertyName  

[ Top ]

constructor __construct [line 107]

PHPExcel_Style_Border __construct( [ $isSupervisor = false])

Create a new PHPExcel_Style_Border

Create a new PHPExcel_Style_Border




Tags:

access:  public


Parameters:

   $isSupervisor  

[ Top ]

method getActiveCell [line 214]

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

PHPExcel_Worksheet getActiveSheet( )

Get the currently active sheet.

Get the currently active sheet. Only used for supervisor




Tags:

access:  public


[ Top ]

method getBorderStyle [line 312]

string getBorderStyle( )

Get Border style

Get Border style




Tags:

access:  public


[ Top ]

method getColor [line 344]

PHPExcel_Style_Color getColor( )

Get Border Color

Get Border Color




Tags:

access:  public


[ Top ]

method getHashCode [line 373]

string getHashCode( )

Get hash code

Get hash code




Tags:

return:  Hash code
access:  public


[ Top ]

method getIsSupervisor [line 141]

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 getSelectedCells [line 203]

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

PHPExcel_Style_Border 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:

throws:  Exception
access:  public


[ Top ]

method getStyleArray [line 225]

array getStyleArray( array $array)

Build style array from subcomponents

Build style array from subcomponents




Tags:

access:  public


Parameters:

array   $array  

[ Top ]

method setBorderStyle [line 325]

PHPExcel_Style_Border setBorderStyle( [string $pValue = PHPExcel_Style_Border::BORDER_NONE])

Set Border style

Set Border style




Tags:

access:  public


Parameters:

string   $pValue  

[ Top ]

method setColor [line 355]

PHPExcel_Style_Border setColor( [PHPExcel_Style_Color $pValue = null])

Set Border Color

Set Border Color




Tags:

throws:  Exception
access:  public


Parameters:

PHPExcel_Style_Color   $pValue  

[ Top ]

method __clone [line 387]

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

BORDER_DASHDOT =  'dashDot'

[line 55]


[ Top ]

BORDER_DASHDOTDOT =  'dashDotDot'

[line 56]


[ Top ]

BORDER_DASHED =  'dashed'

[line 57]


[ Top ]

BORDER_DOTTED =  'dotted'

[line 58]


[ Top ]

BORDER_DOUBLE =  'double'

[line 59]


[ Top ]

BORDER_HAIR =  'hair'

[line 60]


[ Top ]

BORDER_MEDIUM =  'medium'

[line 61]


[ Top ]

BORDER_MEDIUMDASHDOT =  'mediumDashDot'

[line 62]


[ Top ]

BORDER_MEDIUMDASHDOTDOT =  'mediumDashDotDot'

[line 63]


[ Top ]

BORDER_MEDIUMDASHED =  'mediumDashed'

[line 64]


[ Top ]

BORDER_NONE =  'none'

[line 54]


[ Top ]

BORDER_SLANTDASHDOT =  'slantDashDot'

[line 65]


[ Top ]

BORDER_THICK =  'thick'

[line 66]


[ Top ]

BORDER_THIN =  'thin'

[line 67]


[ Top ]



Documentation generated on Mon, 11 Jan 2010 08:06:41 +0100 by phpDocumentor 1.4.1