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

Source Location: /PHPExcel/Style.php

Class Overview




PHPExcel_Style




Author(s):


    
        





      
  


Copyright:


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


                

            Implements interfaces:
            

        

        




Variables







Methods
























Class Details



[line 71]

PHPExcel_Style

PHPExcel_Style





Tags:





  

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










[ Top ]







Class Variables



	
	

	
$_alignment = 

	
[line 99]

  Alignment

Alignment





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Alignment
    

      

	



	
[ Top ]


	
	

	
$_borders = 

	
[line 92]

  Borders

Borders





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Borders
    

      

	



	
[ Top ]


	
	

	
$_conditionalStyles = 

	
[line 113]

  Conditional styles

Conditional styles





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Conditional[]
    

      

	



	
[ Top ]


	
	

	
$_fill = 

	
[line 85]

  Fill

Fill





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Fill
    

      

	



	
[ Top ]


	
	

	
$_font = 

	
[line 78]

  Font

Font





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Font
    

      

	



	
[ Top ]


	
	

	
$_hashIndex = 

	
[line 643]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_index = 

	
[line 141]

  Index of style in collection.

Index of style in collection. Only used for real style.





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_isSupervisor = 

	
[line 127]

  Style supervisor?

Style supervisor?





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_numberFormat = 

	
[line 106]

  Number Format

Number Format





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_NumberFormat
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 134]

  Parent.

Parent. Only used for style supervisor





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel
    

      

	



	
[ Top ]


	
	

	
$_protection = 

	
[line 120]

  Protection

Protection





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Protection
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 148]

	

    

    

		PHPExcel_Style __construct(
[boolean
$isSupervisor = false])
    

    


	
		Create a new PHPExcel_Style

Create a new PHPExcel_Style





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $isSupervisor  
        
      

        

    


        
[ Top ]

  

  

	
	
method applyFromArray [line 298]

	

    

    

		PHPExcel_Style applyFromArray(
[array
$pStyles = null], [boolean
$pAdvanced = true])
    

    


	
		Apply styles from array

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

  2.          array(
    3. 

  3.              'font'    => array(
    4. 

  4.                  'name'      => 'Arial',
    5. 

  5.                  'bold'      => true,
    6. 

  6.                  'italic'    => false,
    7. 

  7.                  'underline' => PHPExcel_Style_Font::UNDERLINE_DOUBLE,
    8. 

  8.                  'strike'    => false,
    9. 

  9.                  'color'     => array(
    10. 

  10.                      'rgb' => '808080'
    11. 

  11.                  )
    12. 

  12.              ),
    13. 

  13.              'borders' => array(
    14. 

  14.                  'bottom'     => array(
    15. 

  15.                      'style' => PHPExcel_Style_Border::BORDER_DASHDOT,
    16. 

  16.                      'color' => array(
    17. 

  17.                          'rgb' => '808080'
    18. 

  18.                      )
    19. 

  19.                  ),
    20. 

  20.                  'top'     => array(
    21. 

  21.                      'style' => PHPExcel_Style_Border::BORDER_DASHDOT,
    22. 

  22.                      'color' => array(
    23. 

  23.                          'rgb' => '808080'
    24. 

  24.                      )
    25. 

  25.                  )
    26. 

  26.              )
    27. 

  27.          )
    28. 

  28.  );
    29. 






Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $pStyles  
        Array containing style information
      

          

        boolean  
        $pAdvanced  
        Advanced mode for setting borders.
      

        

    


        
[ Top ]

  

  

	
	
method bindParent [line 179]

	

    

    

		PHPExcel_Style bindParent(
PHPExcel
$parent)
    

    


	
		Bind parent.

Bind parent. Only used for supervisor





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel  
        $parent  
        
      

        

    


        
[ Top ]

  

  

	
	
method getActiveSheet [line 222]

	

    

    

		PHPExcel_Worksheet getActiveSheet(
)
    

    


	
		Get the currently active sheet.

Get the currently active sheet. Only used for supervisor





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getAlignment [line 569]

	

    

    

		PHPExcel_Style_Alignment getAlignment(
)
    

    


	
		Get Alignment

Get Alignment





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getBorders [line 560]

	

    

    

		PHPExcel_Style_Borders getBorders(
)
    

    


	
		Get Borders

Get Borders





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getConditionalStyles [line 587]

	

    

    

		PHPExcel_Style_Conditional[] getConditionalStyles(
)
    

    


	
		Get Conditional Styles.

Get Conditional Styles. Only used on supervisor.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getFill [line 530]

	

    

    

		PHPExcel_Style_Fill getFill(
)
    

    


	
		Get Fill

Get Fill





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getFont [line 539]

	

    

    

		PHPExcel_Style_Font getFont(
)
    

    


	
		Get Font

Get Font





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 620]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashIndex [line 653]

	

    

    

		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 getIndex [line 674]

	

    

    

		int getIndex(
)
    

    


	
		Get own index in style collection

Get own index in style collection





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getIsSupervisor [line 190]

	

    

    

		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 getNumberFormat [line 578]

	

    

    

		PHPExcel_Style_NumberFormat getNumberFormat(
)
    

    


	
		Get Number Format

Get Number Format





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getParent [line 254]

	

    

    

		PHPExcel getParent(
)
    

    


	
		Get parent.

Get parent. Only used for style supervisor





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getProtection [line 611]

	

    

    

		PHPExcel_Style_Protection getProtection(
)
    

    


	
		Get Protection

Get Protection





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSharedComponent [line 201]

	

    

    

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

	

    

    

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

	

    

    

		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 setConditionalStyles [line 597]

	

    

    

		PHPExcel_Style setConditionalStyles(
[PHPExcel_Style_Conditional[]
$pValue = null])
    

    


	
		Set Conditional Styles.

Set Conditional Styles. Only used on supervisor.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Conditional[]  
        $pValue  
        Array of condtional styles
      

        

    


        
[ Top ]

  

  

	
	
method setFont [line 549]

	

    

    

		PHPExcel_Style setFont(
PHPExcel_Style_Font
$font)
    

    


	
		Set font

Set font





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Font  
        $font  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHashIndex [line 665]

	

    

    

		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 setIndex [line 684]

	

    

    

		void setIndex(
int
$pValue)
    

    


	
		Set own index in style collection

Set own index in style collection





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 692]

	

    

    

		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 ]

  






        

		    

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