PHPExcel_Writer_Excel5
[ class tree: PHPExcel_Writer_Excel5 ] [ index: PHPExcel_Writer_Excel5 ] [ 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:
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




Class for generating Excel XF records (formats)




Author(s):






    

        




Variables







Methods
























Class Details



[line 55]

Class for generating Excel XF records (formats)

Class for generating Excel XF records (formats)





Tags:





  

    author:  Xavier Noguer <xnoguer@rezebra.com>
  










[ Top ]







Class Variables



	
	

	
$_bg_color = 

	
[line 99]

  The cell's background color.

The cell's background color.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_BIFFVersion = 

	
[line 62]

  BIFF version

BIFF version





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_bottom_color = 

	
[line 105]

  Color of the bottom border of the cell.

Color of the bottom border of the cell.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_fg_color = 

	
[line 93]

  The cell's foreground color.

The cell's foreground color.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_fontIndex = 

	
[line 75]

  Index to the FONT record.

Index to the FONT record. Index 4 does not exist





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_isStyleXf = 

	
[line 69]

  Style XF or a cell XF ?

Style XF or a cell XF ?





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_left_color = 

	
[line 117]

  Color of the left border of the cell.

Color of the left border of the cell.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_numberFormatIndex = 

	
[line 81]

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

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





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_right_color = 

	
[line 123]

  Color of the right border of the cell.

Color of the right border of the cell.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_text_justlast = 

	
[line 87]

  1 bit, apparently not used.

1 bit, apparently not used.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]


	
	

	
$_top_color = 

	
[line 111]

  Color of the top border of the cell.

Color of the top border of the cell.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      integer
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 132]

	

    

    

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

    


	
		Constructor

Constructor





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $index  
        the XF index for the format.
      

          

        PHPExcel_Style  
        1  
        
      

          

          
        $style  
        
      

        

    


        
[ Top ]

  

  

	
	
method setBgColor [line 379]

	

    

    

		void setBgColor(
int
$colorIndex)
    

    


	
		Sets the cell's background color

Sets the cell's background color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setBIFFVersion [line 302]

	

    

    

		void setBIFFVersion(
int
$BIFFVersion)
    

    


	
		Set BIFF version

Set BIFF version





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $BIFFVersion  
        
      

        

    


        
[ Top ]

  

  

	
	
method setBottomColor [line 323]

	

    

    

		void setBottomColor(
int
$colorIndex)
    

    


	
		Sets the cell's bottom border color

Sets the cell's bottom border color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setFgColor [line 368]

	

    

    

		void setFgColor(
int
$colorIndex)
    

    


	
		Sets the cell's foreground color

Sets the cell's foreground color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setFontIndex [line 401]

	

    

    

		void setFontIndex(
int
$value)
    

    


	
		Set the font index.

Set the font index.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

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

        

    


        
[ Top ]

  

  

	
	
method setIsStyleXf [line 312]

	

    

    

		void setIsStyleXf(
boolean
$value)
    

    


	
		Is this a style XF ?

Is this a style XF ?





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method setLeftColor [line 345]

	

    

    

		void setLeftColor(
int
$colorIndex)
    

    


	
		Sets the cell's left border color

Sets the cell's left border color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setNumberFormatIndex [line 391]

	

    

    

		void setNumberFormatIndex(
integer
$numberFormatIndex)
    

    


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

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

	

    

    

		void setRightColor(
int
$colorIndex)
    

    


	
		Sets the cell's right border color

Sets the cell's right border color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method setTopColor [line 334]

	

    

    

		void setTopColor(
int
$colorIndex)
    

    


	
		Sets the cell's top border color

Sets the cell's top border color





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $colorIndex  
        Color index
      

        

    


        
[ Top ]

  

  

	
	
method writeXf [line 163]

	

    

    

		string writeXf(
string
$style)
    

    


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

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 ]

  

  

	
	
method _mapBorderStyle [line 409]

	

    

    

		void _mapBorderStyle(

$borderStyle)
    

    


	
		Map border style

Map border style





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

          
        $borderStyle  
        
      

        

    


        
[ Top ]

  

  

	
	
method _mapFillType [line 432]

	

    

    

		void _mapFillType(

$fillType)
    

    


	
		Map fill type

Map fill type





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

          
        $fillType  
        
      

        

    


        
[ Top ]

  

  

	
	
method _mapHAlign [line 465]

	

    

    

		int _mapHAlign(
string
$hAlign)
    

    


	
		Map to BIFF2-BIFF8 codes for horizontal alignment

Map to BIFF2-BIFF8 codes for horizontal alignment





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        string  
        $hAlign  
        
      

        

    


        
[ Top ]

  

  

	
	
method _mapHidden [line 532]

	

    

    

		int _mapHidden(
string
$hidden)
    

    


	
		Map hidden

Map hidden





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        string  
        $hidden  
        
      

        

    


        
[ Top ]

  

  

	
	
method _mapLocked [line 517]

	

    

    

		int _mapLocked(
string
$locked)
    

    


	
		Map locked

Map locked





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        string  
        $locked  
        
      

        

    


        
[ Top ]

  

  

	
	
method _mapTextRotation [line 499]

	

    

    

		int _mapTextRotation(
int
$textRotation)
    

    


	
		Map to BIFF8 codes for text rotation angle

Map to BIFF8 codes for text rotation angle





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        int  
        $textRotation  
        
      

        

    


        
[ Top ]

  

  

	
	
method _mapVAlign [line 483]

	

    

    

		int _mapVAlign(
string
$vAlign)
    

    


	
		Map to BIFF2-BIFF8 codes for vertical alignment

Map to BIFF2-BIFF8 codes for vertical alignment





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        string  
        $vAlign  
        
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Wed, 22 Apr 2009 09:07:08 +0200 by phpDocumentor 1.4.1