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_Fill

Source Location: /PHPExcel/Style/Fill.php

Class Overview




PHPExcel_Style_Fill




Author(s):


    
        





      
  


Copyright:


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


                

            Implements interfaces:
            

        

        




Variables






Constants






Methods
























Class Details



[line 43]

PHPExcel_Style_Fill

PHPExcel_Style_Fill





Tags:





  

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










[ Top ]







Class Variables



	
	

	
$_endColor = 

	
[line 94]

  End color

End color





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Color
    

      

	



	
[ Top ]


	
	

	
$_fillType = 

	
[line 73]

  Fill type

Fill type





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_hashIndex = 

	
[line 323]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 102]

  Parent Style

Parent Style





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style
    

      

	



	
[ Top ]


	
	

	
$_parentPropertyName = 

	
[line 109]

  Parent Borders

Parent Borders





Tags:





  

    var:  string
  

  

    access:  private
  






  

	

  

    

      Type:  
      _parentPropertyName
    

      

	



	
[ Top ]


	
	

	
$_rotation = 

	
[line 80]

  Rotation

Rotation





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      double
    

      

	



	
[ Top ]


	
	

	
$_startColor = 

	
[line 87]

  Start color

Start color





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Color
    

      

	



	
[ Top ]










Class Methods




  

	
	
method applyFromArray [line 197]

	

    

    

		void applyFromArray(
[array
$pStyles = null])
    

    


	
		Apply styles from array

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 ]

  

  

	
	
constructor __construct [line 114]

	

    

    

		PHPExcel_Style_Fill __construct(
)
    

    


	
		Create a new PHPExcel_Style_Fill

Create a new PHPExcel_Style_Fill





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getEndColor [line 286]

	

    

    

		PHPExcel_Style_Color getEndColor(
)
    

    


	
		Get End Color

Get End Color





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getFillType [line 224]

	

    

    

		string getFillType(
)
    

    


	
		Get Fill Type

Get Fill Type





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 307]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashIndex [line 333]

	

    

    

		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 getRotation [line 247]

	

    

    

		double getRotation(
)
    

    


	
		Get Rotation

Get Rotation





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getStartColor [line 265]

	

    

    

		PHPExcel_Style_Color getStartColor(
)
    

    


	
		Get Start Color

Get Start Color





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method propertyBeginBind [line 163]

	

    

    

		PHPExcel_Style_Fill propertyBeginBind(
)
    

    


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

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





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method propertyGetBound [line 146]

	

    

    

		PHPExcel_Style_Fill propertyGetBound(
)
    

    


	
		Property Get Bound

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





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method propertyPrepareBind [line 131]

	

    

    

		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 setEndColor [line 298]

	

    

    

		void setEndColor(
[PHPExcel_Style_Color
$pValue = null])
    

    


	
		Set End Color

Set End Color





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Color  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setFillType [line 238]

	

    

    

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

    


	
		Set Fill Type

Set Fill Type





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        PHPExcel_Style_Fill fill type
      

        

    


        
[ Top ]

  

  

	
	
method setHashIndex [line 345]

	

    

    

		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 setRotation [line 256]

	

    

    

		void setRotation(
[double
$pValue = 0])
    

    


	
		Set Rotation

Set Rotation





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        double  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setStartColor [line 277]

	

    

    

		void setStartColor(
[PHPExcel_Style_Color
$pValue = null])
    

    


	
		Set Start Color

Set Start Color





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Color  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 352]

	

    

    

		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



	
	

	
FILL_GRADIENT_LINEAR =  'linear'

	
[line 48]

  
  

	
[ Top ]


	
	

	
FILL_GRADIENT_PATH =  'path'

	
[line 49]

  
  

	
[ Top ]


	
	

	
FILL_NONE =  'none'

	
[line 46]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKDOWN =  'darkDown'

	
[line 50]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKGRAY =  'darkGray'

	
[line 51]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKGRID =  'darkGrid'

	
[line 52]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKHORIZONTAL =  'darkHorizontal'

	
[line 53]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKTRELLIS =  'darkTrellis'

	
[line 54]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKUP =  'darkUp'

	
[line 55]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_DARKVERTICAL =  'darkVertical'

	
[line 56]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_GRAY0625 =  'gray0625'

	
[line 57]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_GRAY125 =  'gray125'

	
[line 58]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTDOWN =  'lightDown'

	
[line 59]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTGRAY =  'lightGray'

	
[line 60]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTGRID =  'lightGrid'

	
[line 61]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTHORIZONTAL =  'lightHorizontal'

	
[line 62]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTTRELLIS =  'lightTrellis'

	
[line 63]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTUP =  'lightUp'

	
[line 64]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_LIGHTVERTICAL =  'lightVertical'

	
[line 65]

  
  

	
[ Top ]


	
	

	
FILL_PATTERN_MEDIUMGRAY =  'mediumGray'

	
[line 66]

  
  

	
[ Top ]


	
	

	
FILL_SOLID =  'solid'

	
[line 47]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Mon, 05 Jan 2009 20:37:13 +0100 by phpDocumentor 1.4.1