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


Files:
BIFFwriter.php
Escher.php
Excel5.php
Font.php
Parser.php
Workbook.php
Worksheet.php
Xf.php

Classes:
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel5_BIFFwriter
PHPExcel_Writer_Excel5_Escher
PHPExcel_Writer_Excel5_Font
PHPExcel_Writer_Excel5_Parser
PHPExcel_Writer_Excel5_Workbook
PHPExcel_Writer_Excel5_Worksheet
PHPExcel_Writer_Excel5_Xf

Class: PHPExcel_Writer_Excel5_Xf

Source Location: /PHPExcel/Writer/Excel5/Xf.php

Class Overview




PHPExcel_Writer_Excel5_Xf




Author(s):


    
        





      
  


Copyright:


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


        




Variables







Methods
























Class Details



[line 71]

PHPExcel_Writer_Excel5_Xf





Tags:





  

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










[ Top ]







Class Variables



	
	

	
$_bg_color = 

	
[line 115]

  The cell's background color.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_bottom_color = 

	
[line 121]

  Color of the bottom border of the cell.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_fg_color = 

	
[line 109]

  The cell's foreground color.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_left_color = 

	
[line 133]

  Color of the left border of the cell.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_numberFormatIndex = 

	
[line 97]

  An index (2 bytes) to a FORMAT record (number format).





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_right_color = 

	
[line 139]

  Color of the right border of the cell.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_text_justlast = 

	
[line 103]

  1 bit, apparently not used.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_top_color = 

	
[line 127]

  Color of the top border of the cell.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 148]

	

    

    

		PHPExcel_Writer_Excel5_Xf __construct(
[
$style = null], integer
$index, PHPExcel_Style
1)
    

    


	
		Constructor





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $index  
        the XF index for the format.
      

          

        PHPExcel_Style  
        1  
        
      

          

        PHPExcel_Style  
        $style  
        
      

        

    


        
[ Top ]

  

  

	
	
method setBgColor [line 410]

	

    

    

		void setBgColor(
int
$colorIndex)
    

    


	
		Sets the cell's background color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setBIFFVersion [line 322]

	

    

    

		void setBIFFVersion(
int
$BIFFVersion)
    

    


	
		Set BIFF version





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $BIFFVersion  
        
      

        

    


        
[ Top ]

  

  

	
	
method setBottomColor [line 343]

	

    

    

		void setBottomColor(
int
$colorIndex)
    

    


	
		Sets the cell's bottom border color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setDiagColor [line 387]

	

    

    

		void setDiagColor(
int
$colorIndex)
    

    


	
		Sets the cell's diagonal border color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setFgColor [line 399]

	

    

    

		void setFgColor(
int
$colorIndex)
    

    


	
		Sets the cell's foreground color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setFontIndex [line 432]

	

    

    

		void setFontIndex(
int
$value)
    

    


	
		Set the font index.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $value  
        Font index, note that value 4 does not exist
      

        

    


        
[ Top ]

  

  

	
	
method setIsStyleXf [line 332]

	

    

    

		void setIsStyleXf(
boolean
$value)
    

    


	
		Is this a style XF ?





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method setLeftColor [line 365]

	

    

    

		void setLeftColor(
int
$colorIndex)
    

    


	
		Sets the cell's left border color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setNumberFormatIndex [line 422]

	

    

    

		void setNumberFormatIndex(
integer
$numberFormatIndex)
    

    


	
		Sets the index to the number format record  It can be date, time, currency, etc...





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $numberFormatIndex  
        Index to format record
      

        

    


        
[ Top ]

  

  

	
	
method setRightColor [line 376]

	

    

    

		void setRightColor(
int
$colorIndex)
    

    


	
		Sets the cell's right border color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setTopColor [line 354]

	

    

    

		void setTopColor(
int
$colorIndex)
    

    


	
		Sets the cell's top border color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method writeXf [line 179]

	

    

    

		string writeXf(
string
$style)
    

    


	
		Generate an Excel BIFF XF record (style or cell).





Tags:





  

    return:  The XF record
  









	
        
Parameters:

    

    

          

        string  
        $style  
        The type of the XF record ('style' or 'cell').
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Sun, 27 Feb 2011 16:37:29 -0800 by phpDocumentor 1.4.3