PHPExcel_Style
[ class tree: PHPExcel_Style ] [ index: PHPExcel_Style ] [ all elements ]
Packages:
default
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
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 43]

PHPExcel_Style_Borders

PHPExcel_Style_Borders





Tags:





  

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










[ Top ]







Class Variables



	
	

	
$_bottom = 

	
[line 76]

  Bottom

Bottom





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_diagonal = 

	
[line 83]

  Diagonal

Diagonal





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_diagonalDirection = 

	
[line 104]

  DiagonalDirection

DiagonalDirection





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_hashIndex = 

	
[line 538]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_horizontal = 

	
[line 97]

  Horizontal

Horizontal





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_left = 

	
[line 55]

  Left

Left





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_outline = 

	
[line 111]

  Outline, defaults to true

Outline, defaults to true





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 119]

  Parent

Parent





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style
    

      

	



	
[ Top ]


	
	

	
$_parentPropertyName = 

	
[line 126]

  Parent Borders

Parent Borders





Tags:





  

    var:  string
  

  

    access:  private
  






  

	

  

    

      Type:  
      _parentPropertyName
    

      

	



	
[ Top ]


	
	

	
$_right = 

	
[line 62]

  Right

Right





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_top = 

	
[line 69]

  Top

Top





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]


	
	

	
$_vertical = 

	
[line 90]

  Vertical

Vertical





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Border
    

      

	



	
[ Top ]










Class Methods




  

	
	
method applyFromArray [line 323]

	

    

    

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

  

  

	
	
constructor __construct [line 131]

	

    

    

		PHPExcel_Style_Borders __construct(
)
    

    


	
		Create a new PHPExcel_Style_Borders

Create a new PHPExcel_Style_Borders





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getBottom [line 415]

	

    

    

		PHPExcel_Style_Border getBottom(
)
    

    


	
		Get Bottom

Get Bottom





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDiagonal [line 430]

	

    

    

		PHPExcel_Style_Border getDiagonal(
)
    

    


	
		Get Diagonal

Get Diagonal





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDiagonalDirection [line 475]

	

    

    

		int getDiagonalDirection(
)
    

    


	
		Get DiagonalDirection

Get DiagonalDirection





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 517]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashIndex [line 548]

	

    

    

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

	

    

    

		PHPExcel_Style_Border getHorizontal(
)
    

    


	
		Get Horizontal

Get Horizontal





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getLeft [line 368]

	

    

    

		PHPExcel_Style_Border getLeft(
)
    

    


	
		Get Left

Get Left





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getOutline [line 496]

	

    

    

		boolean getOutline(
)
    

    


	
		Get Outline

Get Outline





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRight [line 383]

	

    

    

		PHPExcel_Style_Border getRight(
)
    

    


	
		Get Right

Get Right





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getTop [line 399]

	

    

    

		PHPExcel_Style_Border getTop(
)
    

    


	
		Get Top

Get Top





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getVertical [line 445]

	

    

    

		PHPExcel_Style_Border getVertical(
)
    

    


	
		Get Vertical

Get Vertical





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method propertyBeginBind [line 192]

	

    

    

		PHPExcel_Style_Borders propertyBeginBind(
)
    

    


	
		Property Begin Bind
 If no PHPExcel_Style_Borders has been bound to PHPExcel_Style then bind this one.

Property Begin Bind
 If no PHPExcel_Style_Borders has been bound to PHPExcel_Style then bind this one. Return the actual bound one.





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method propertyCompleteBind [line 214]

	

    

    

		void propertyCompleteBind(
$propertyObject
$propertyObject, $propertyName
$propertyName)
    

    


	
		Property Complete Bind

Property Complete Bind
 Complete the binding process a child property object started





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        $propertyObject  
        $propertyObject  
        
      

          

        $propertyName  
        $propertyName  
        Name of this property in the parent object
      

        

    


        
[ Top ]

  

  

	
	
method propertyGetBound [line 175]

	

    

    

		PHPExcel_Style_Borders propertyGetBound(
)
    

    


	
		Property Get Bound

Property Get Bound
 Returns the PHPExcel_Style_Borders that is actual bound to PHPExcel_Style





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method propertyIsBound [line 258]

	

    

    

		boolean propertyIsBound(
$propertyName
$propertyName)
    

    


	
		Property Is Bound

Property Is Bound
 Determines if a child property is bound to this one





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        $propertyName  
        $propertyName  
        Name of this property in the parent object
      

        

    


        
[ Top ]

  

  

	
	
method propertyPrepareBind [line 160]

	

    

    

		void propertyPrepareBind(
$parent
$parent, $parentPropertyName
$parentPropertyName)
    

    


	
		Property Prepare bind

Property Prepare bind
 Configures this object for late binding as a property of a parent object





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        $parent  
        $parent  
        
      

          

        $parentPropertyName  
        $parentPropertyName  
        
      

        

    


        
[ Top ]

  

  

	
	
method setDiagonalDirection [line 484]

	

    

    

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

    


	
		Set DiagonalDirection

Set DiagonalDirection





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHashIndex [line 560]

	

    

    

		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 setOutline [line 505]

	

    

    

		void setOutline(
[boolean
$pValue = true])
    

    


	
		Set Outline

Set Outline





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 567]

	

    

    

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

  
  

	
[ Top ]


	
	

	
DIAGONAL_NONE =  0

	
[line 46]

  
  

	
[ Top ]


	
	

	
DIAGONAL_UP =  1

	
[line 47]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Mon, 05 Jan 2009 20:36:29 +0100 by phpDocumentor 1.4.1