PHPExcel_Style
[ class tree: PHPExcel_Style ] [ index: PHPExcel_Style ] [ all elements ]
Packages:
default
com-tecnick-tcpdf
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Best_Fit
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
Alignment.php
Border.php
Borders.php
Color.php
Conditional.php
Fill.php
Font.php
NumberFormat.php
Protection.php
Style.php

Classes:
PHPExcel_Style
PHPExcel_Style_Alignment
PHPExcel_Style_Border
PHPExcel_Style_Borders
PHPExcel_Style_Color
PHPExcel_Style_Conditional
PHPExcel_Style_Fill
PHPExcel_Style_Font
PHPExcel_Style_NumberFormat
PHPExcel_Style_Protection

Class: PHPExcel_Style_Borders

Source Location: /PHPExcel/Style/Borders.php

Class Overview




PHPExcel_Style_Borders




Author(s):


    
        





      
  


Copyright:


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


                

            Implements interfaces:
            

        

        




Variables






Constants






Methods
























Class Details



[line 51]

PHPExcel_Style_Borders

PHPExcel_Style_Borders





Tags:





  

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










[ Top ]







Class Variables



	
	

	
$_allBorders = 

	
[line 105]

  All borders psedo-border.

All borders psedo-border. Only applies to supervisor.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_bottom = 

	
[line 84]

  Bottom

Bottom





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_diagonal = 

	
[line 91]

  Diagonal

Diagonal





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_diagonalDirection = 

	
[line 98]

  DiagonalDirection

DiagonalDirection





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_hashIndex = 

	
[line 505]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_horizontal = 

	
[line 133]

  Horizontal pseudo-border.

Horizontal pseudo-border. Only applies to supervisor.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_inside = 

	
[line 119]

  Inside psedo-border.

Inside psedo-border. Only applies to supervisor.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_isSupervisor = 

	
[line 147]

  Supervisor?

Supervisor?





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_left = 

	
[line 63]

  Left

Left





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_outline = 

	
[line 112]

  Outline psedo-border.

Outline psedo-border. Only applies to supervisor.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 154]

  Parent.

Parent. Only used for supervisor





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style
    

      

	



	
[ Top ]


	
	

	
$_parentPropertyName = 

	
[line 140]

  Parent Borders

Parent Borders





Tags:





  

    var:  string
  

  

    access:  private
  






  

	

  

    

      Type:  
      _parentPropertyName
    

      

	



	
[ Top ]


	
	

	
$_right = 

	
[line 70]

  Right

Right





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_top = 

	
[line 77]

  Top

Top





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_vertical = 

	
[line 126]

  Vertical pseudo-border.

Vertical pseudo-border. Only applies to supervisor.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 159]

	

    

    

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

	

    

    

		PHPExcel_Style_Borders applyFromArray(
[array
$pStyles = null])
    

    


	
		Apply styles from array

Apply styles from array
 
  1.  $objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray(
    2. 

  2.          array(
    3. 

  3.              'bottom'     => array(
    4. 

  4.                  'style' => PHPExcel_Style_Border::BORDER_DASHDOT,
    5. 

  5.                  'color' => array(
    6. 

  6.                      'rgb' => '808080'
    7. 

  7.                  )
    8. 

  8.              ),
    9. 

  9.              'top'     => array(
    10. 

  10.                  'style' => PHPExcel_Style_Border::BORDER_DASHDOT,
    11. 

  11.                  'color' => array(
    12. 

  12.                      'rgb' => '808080'
    13. 

  13.                  )
    14. 

  14.              )
    15. 

  15.          )
    16. 

  16.  );
    17. 

 
  1.  $objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray(
    2. 

  2.          array(
    3. 

  3.              'allborders' => array(
    4. 

  4.                  'style' => PHPExcel_Style_Border::BORDER_DASHDOT,
    5. 

  5.                  'color' => array(
    6. 

  6.                      'rgb' => '808080'
    7. 

  7.                  )
    8. 

  8.              )
    9. 

  9.          )
    10. 

  10.  );
    11. 






Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $pStyles  
        Array containing style information
      

        

    


        
[ Top ]

  

  

	
	
method bindParent [line 201]

	

    

    

		PHPExcel_Style_Borders bindParent(
PHPExcel_Style
$parent)
    

    


	
		Bind parent.

Bind parent. Only used for supervisor





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style  
        $parent  
        
      

        

    


        
[ Top ]

  

  

	
	
method getActiveSheet [line 233]

	

    

    

		PHPExcel_Worksheet getActiveSheet(
)
    

    


	
		Get the currently active sheet.

Get the currently active sheet. Only used for supervisor





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getAllBorders [line 390]

	

    

    

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

	

    

    

		PHPExcel_Style_Border getBottom(
)
    

    


	
		Get Bottom

Get Bottom





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDiagonal [line 380]

	

    

    

		PHPExcel_Style_Border getDiagonal(
)
    

    


	
		Get Diagonal

Get Diagonal





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDiagonalDirection [line 454]

	

    

    

		int getDiagonalDirection(
)
    

    


	
		Get DiagonalDirection

Get DiagonalDirection





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 485]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashIndex [line 515]

	

    

    

		string getHashIndex(
)
    

    


	
		Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    return:  Hash index
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHorizontal [line 442]

	

    

    

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

	

    

    

		boolean getInside(
)
    

    


	
		Get Inside (pseudo-border).

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





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getIsSupervisor [line 212]

	

    

    

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

	

    

    

		PHPExcel_Style_Border getLeft(
)
    

    


	
		Get Left

Get Left





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getOutline [line 403]

	

    

    

		boolean getOutline(
)
    

    


	
		Get Outline (pseudo-border).

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





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRight [line 353]

	

    

    

		PHPExcel_Style_Border getRight(
)
    

    


	
		Get Right

Get Right





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSharedComponent [line 223]

	

    

    

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

	

    

    

		array getStyleArray(
array
$array)
    

    


	
		Build style array from subcomponents

Build style array from subcomponents





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $array  
        
      

        

    


        
[ Top ]

  

  

	
	
method getTop [line 362]

	

    

    

		PHPExcel_Style_Border getTop(
)
    

    


	
		Get Top

Get Top





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getVertical [line 429]

	

    

    

		PHPExcel_Style_Border getVertical(
)
    

    


	
		Get Vertical (pseudo-border).

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





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getXActiveCell [line 255]

	

    

    

		string getXActiveCell(
)
    

    


	
		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 getXSelectedCells [line 244]

	

    

    

		string getXSelectedCells(
)
    

    


	
		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 setDiagonalDirection [line 467]

	

    

    

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

    


	
		Set DiagonalDirection

Set DiagonalDirection





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHashIndex [line 527]

	

    

    

		void setHashIndex(
string
$value)
    

    


	
		Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $value  
        Hash index
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 534]

	

    

    

		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_DOWN =  2

	
[line 56]

  
  

	
[ Top ]


	
	

	
DIAGONAL_NONE =  0

	
[line 54]

  
  

	
[ Top ]


	
	

	
DIAGONAL_UP =  1

	
[line 55]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Mon, 10 Aug 2009 08:02:18 +0200 by phpDocumentor 1.4.1