PHPExcel_Style
[ class tree: PHPExcel_Style ] [ index: PHPExcel_Style ] [ all elements ]
Packages:
PHPExcel
JAMA
Math_Stats
PHPExcel_CachedObjectStorage
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Chart
PHPExcel_Chart_Renderer
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_Reader_Excel2007
PHPExcel_RichText
PHPExcel_Settings
PHPExcel_Shared
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Shared_Trend
PHPExcel_Shared_ZipArchive
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_Fill

Source Location: /PHPExcel/Style/Fill.php

Class Overview




PHPExcel_Style_Fill




Author(s):


    
        





      
  


Copyright:


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


                

            Implements interfaces:
            

        

        





Constants






Methods
























Class Details



[line 36]

PHPExcel_Style_Fill





Tags:





  

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










[ Top ]








Class Methods




  

	
	
constructor __construct [line 120]

	

    

    

		PHPExcel_Style_Fill __construct(
[boolean
$isSupervisor = false], [boolean
$isConditional = false])
    

    


	
		Create a new PHPExcel_Style_Fill





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $isSupervisor  
        Flag indicating if this is a supervisor or not                                     Leave this value at default unless you understand exactly what                                         its ramifications are
      

          

        boolean  
        $isConditional  
        Flag indicating if this is a conditional style or not                                     Leave this value at default unless you understand exactly what                                         its ramifications are
      

        

    


        
[ Top ]

  

  

	
	
method applyFromArray [line 237]

	

    

    

		PHPExcel_Style_Fill applyFromArray(
[array
$pStyles = null])
    

    


	
		Apply styles from array

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

  2.         array(
    3. 

  3.             'type'       => PHPExcel_Style_Fill::FILL_GRADIENT_LINEAR,
    4. 

  4.             'rotation'   => 0,
    5. 

  5.             'startcolor' => array(
    6. 

  6.                 'rgb' => '000000'
    7. 

  7.             ),
    8. 

  8.             'endcolor'   => array(
    9. 

  9.                 'argb' => 'FFFFFFFF'
    10. 

  10.             )
    11. 

  11.         )
    12. 

  12.  );
    13. 






Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $pStyles  
        Array containing style information
      

        

    


        
[ Top ]

  

  

	
	
method bindParent [line 145]

	

    

    

		PHPExcel_Style_Fill bindParent(
PHPExcel_Style
$parent)
    

    


	
		Bind parent. Only used for supervisor





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style  
        $parent  
        
      

        

    


        
[ Top ]

  

  

	
	
method getActiveCell [line 199]

	

    

    

		string getActiveCell(
)
    

    


	
		Get the currently active cell coordinate in currently active sheet.

Only used for supervisor





Tags:





  

    return:  E.g. 'A1'
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getActiveSheet [line 177]

	

    

    

		PHPExcel_Worksheet getActiveSheet(
)
    

    


	
		Get the currently active sheet. Only used for supervisor





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getEndColor [line 354]

	

    

    

		PHPExcel_Style_Color getEndColor(
)
    

    


	
		Get End Color





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getFillType [line 269]

	

    

    

		string getFillType(
)
    

    


	
		Get Fill Type





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 383]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getIsSupervisor [line 156]

	

    

    

		boolean getIsSupervisor(
)
    

    


	
		Is this a supervisor or a real style component?





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRotation [line 297]

	

    

    

		double getRotation(
)
    

    


	
		Get Rotation





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSelectedCells [line 188]

	

    

    

		string getSelectedCells(
)
    

    


	
		Get the currently active cell coordinate in currently active sheet.

Only used for supervisor





Tags:





  

    return:  E.g. 'A1'
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSharedComponent [line 167]

	

    

    

		PHPExcel_Style_Fill getSharedComponent(
)
    

    


	
		Get the shared style component for the currently active cell in currently active sheet.

Only used for style supervisor





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getStartColor [line 325]

	

    

    

		PHPExcel_Style_Color getStartColor(
)
    

    


	
		Get Start Color





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getStyleArray [line 210]

	

    

    

		array getStyleArray(
array
$array)
    

    


	
		Build style array from subcomponents





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $array  
        
      

        

    


        
[ Top ]

  

  

	
	
method setEndColor [line 365]

	

    

    

		PHPExcel_Style_Fill setEndColor(
[PHPExcel_Style_Color
$pValue = null])
    

    


	
		Set End Color





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Color  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setFillType [line 282]

	

    

    

		PHPExcel_Style_Fill setFillType(
[string
$pValue = PHPExcel_Style_Fill::FILL_NONE])
    

    


	
		Set Fill Type





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        PHPExcel_Style_Fill fill type
      

        

    


        
[ Top ]

  

  

	
	
method setRotation [line 310]

	

    

    

		PHPExcel_Style_Fill setRotation(
[double
$pValue = 0])
    

    


	
		Set Rotation





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        double  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setStartColor [line 336]

	

    

    

		PHPExcel_Style_Fill setStartColor(
[PHPExcel_Style_Color
$pValue = null])
    

    


	
		Set Start Color





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Color  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 399]

	

    

    

		void __clone(
)
    

    


	
		Implement PHP __clone to create a deep clone, not just a shallow copy.





Tags:





  

    access:  public
  









	
        
[ Top ]

  









Class Constants



	
	

	
FILL_GRADIENT_LINEAR =  'linear'

	
[line 41]

  
  

	
[ Top ]


	
	

	
FILL_GRADIENT_PATH =  'path'

	
[line 42]

  
  

	
[ Top ]


	
	

	
FILL_NONE =  'none'

	
[line 39]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKDOWN =  'darkDown'

	
[line 43]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKGRAY =  'darkGray'

	
[line 44]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKGRID =  'darkGrid'

	
[line 45]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKHORIZONTAL =  'darkHorizontal'

	
[line 46]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKTRELLIS =  'darkTrellis'

	
[line 47]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKUP =  'darkUp'

	
[line 48]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKVERTICAL =  'darkVertical'

	
[line 49]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_GRAY0625 =  'gray0625'

	
[line 50]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_GRAY125 =  'gray125'

	
[line 51]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTDOWN =  'lightDown'

	
[line 52]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTGRAY =  'lightGray'

	
[line 53]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTGRID =  'lightGrid'

	
[line 54]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTHORIZONTAL =  'lightHorizontal'

	
[line 55]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTTRELLIS =  'lightTrellis'

	
[line 56]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTUP =  'lightUp'

	
[line 57]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTVERTICAL =  'lightVertical'

	
[line 58]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_MEDIUMGRAY =  'mediumGray'

	
[line 59]

  
  

	
[ Top ]


	
	

	
FILL_SOLID =  'solid'

	
[line 40]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Fri, 12 Oct 2012 00:16:15 +0200 by phpDocumentor 1.4.4