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_Alignment

Source Location: /PHPExcel/Style/Alignment.php

Class Overview




PHPExcel_Style_Alignment




Author(s):


    
        





      
  


Copyright:


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


                

            Implements interfaces:
            

        

        




Variables






Constants






Methods
























Class Details



[line 40]

PHPExcel_Style_Alignment

PHPExcel_Style_Alignment





Tags:





  

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










[ Top ]







Class Variables



	
	

	
$_hashIndex = 

	
[line 381]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_horizontal = 

	
[line 60]

  Horizontal

Horizontal





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_indent = 

	
[line 95]

  Indent - only possible with horizontal alignment left and right

Indent - only possible with horizontal alignment left and right





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 103]

  Parent Style

Parent Style





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style
    

      

	



	
[ Top ]


	
	

	
$_parentPropertyName = 

	
[line 110]

  Parent Borders

Parent Borders





Tags:





  

    var:  string
  

  

    access:  private
  






  

	

  

    

      Type:  
      _parentPropertyName
    

      

	



	
[ Top ]


	
	

	
$_shrinkToFit = 

	
[line 88]

  Shrink to fit

Shrink to fit





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_textRotation = 

	
[line 74]

  Text rotation

Text rotation





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_vertical = 

	
[line 67]

  Vertical

Vertical





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_wrapText = 

	
[line 81]

  Wrap text

Wrap text





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 115]

	

    

    

		PHPExcel_Style_Alignment __construct(
)
    

    


	
		Create a new PHPExcel_Style_Alignment

Create a new PHPExcel_Style_Alignment





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method applyFromArray [line 196]

	

    

    

		void applyFromArray(
[array
$pStyles = null])
    

    


	
		Apply styles from array

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

  2.          array(
    3. 

  3.              'horizontal' => PHPExcel_Style_Alignment::HORIZONTAL_CENTER,
    4. 

  4.              'vertical'   => PHPExcel_Style_Alignment::VERTICAL_CENTER,
    5. 

  5.              'rotation'   => 0,
    6. 

  6.              'wrap'       => true
    7. 

  7.          )
    8. 

  8.  );
    9. 






Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $pStyles  
        Array containing style information
      

        

    


        
[ Top ]

  

  

	
	
method getHashCode [line 363]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashIndex [line 391]

	

    

    

		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 getHorizontal [line 226]

	

    

    

		string getHorizontal(
)
    

    


	
		Get Horizontal

Get Horizontal





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getIndent [line 339]

	

    

    

		int getIndent(
)
    

    


	
		Get indent

Get indent





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getShrinkToFit [line 318]

	

    

    

		boolean getShrinkToFit(
)
    

    


	
		Get Shrink to fit

Get Shrink to fit





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getTextRotation [line 268]

	

    

    

		int getTextRotation(
)
    

    


	
		Get TextRotation

Get TextRotation





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getVertical [line 247]

	

    

    

		string getVertical(
)
    

    


	
		Get Vertical

Get Vertical





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getWrapText [line 297]

	

    

    

		boolean getWrapText(
)
    

    


	
		Get Wrap Text

Get Wrap Text





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method propertyBeginBind [line 166]

	

    

    

		PHPExcel_Style_Alignment propertyBeginBind(
)
    

    


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

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





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method propertyGetBound [line 149]

	

    

    

		PHPExcel_Style_Alignment propertyGetBound(
)
    

    


	
		Property Get Bound

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





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method propertyPrepareBind [line 134]

	

    

    

		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 setHashIndex [line 403]

	

    

    

		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 setHorizontal [line 235]

	

    

    

		void setHorizontal(
[string
$pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL])
    

    


	
		Set Horizontal

Set Horizontal





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setIndent [line 348]

	

    

    

		void setIndent(
[int
$pValue = 0])
    

    


	
		Set indent

Set indent





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setShrinkToFit [line 327]

	

    

    

		void setShrinkToFit(
[boolean
$pValue = false])
    

    


	
		Set Shrink to fit

Set Shrink to fit





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setTextRotation [line 278]

	

    

    

		void setTextRotation(
[int
$pValue = 0])
    

    


	
		Set TextRotation

Set TextRotation





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setVertical [line 256]

	

    

    

		void setVertical(
[string
$pValue = PHPExcel_Style_Alignment::VERTICAL_BOTTOM])
    

    


	
		Set Vertical

Set Vertical





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setWrapText [line 306]

	

    

    

		void setWrapText(
[boolean
$pValue = false])
    

    


	
		Set Wrap Text

Set Wrap Text





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 410]

	

    

    

		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



	
	

	
HORIZONTAL_CENTER =  'center'

	
[line 46]

  
  

	
[ Top ]


	
	

	
HORIZONTAL_GENERAL =  'general'

	
[line 43]

  
  

	
[ Top ]


	
	

	
HORIZONTAL_JUSTIFY =  'justify'

	
[line 47]

  
  

	
[ Top ]


	
	

	
HORIZONTAL_LEFT =  'left'

	
[line 44]

  
  

	
[ Top ]


	
	

	
HORIZONTAL_RIGHT =  'right'

	
[line 45]

  
  

	
[ Top ]


	
	

	
VERTICAL_BOTTOM =  'bottom'

	
[line 50]

  
  

	
[ Top ]


	
	

	
VERTICAL_CENTER =  'center'

	
[line 52]

  
  

	
[ Top ]


	
	

	
VERTICAL_JUSTIFY =  'justify'

	
[line 53]

  
  

	
[ Top ]


	
	

	
VERTICAL_TOP =  'top'

	
[line 51]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Mon, 05 Jan 2009 20:36:24 +0100 by phpDocumentor 1.4.1