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_Alignment

Source Location: /PHPExcel/Style/Alignment.php

Class Overview




PHPExcel_Style_Alignment




Author(s):


    
        





      
  


Copyright:


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


                

            Implements interfaces:
            

        

        




Variables






Constants






Methods
























Class Details



[line 48]

PHPExcel_Style_Alignment

PHPExcel_Style_Alignment





Tags:





  

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










[ Top ]







Class Variables



	
	

	
$_horizontal = 

	
[line 69]

  Horizontal

Horizontal





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_indent = 

	
[line 104]

  Indent - only possible with horizontal alignment left and right

Indent - only possible with horizontal alignment left and right





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_isSupervisor = 

	
[line 118]

  Supervisor?

Supervisor?





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 125]

  Parent.

Parent. Only used for supervisor





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style
    

      

	



	
[ Top ]


	
	

	
$_parentPropertyName = 

	
[line 111]

  Parent Borders

Parent Borders





Tags:





  

    var:  string
  

  

    access:  private
  






  

	

  

    

      Type:  
      _parentPropertyName
    

      

	



	
[ Top ]


	
	

	
$_shrinkToFit = 

	
[line 97]

  Shrink to fit

Shrink to fit





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_textRotation = 

	
[line 83]

  Text rotation

Text rotation





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_vertical = 

	
[line 76]

  Vertical

Vertical





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_wrapText = 

	
[line 90]

  Wrap text

Wrap text





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 130]

	

    

    

		PHPExcel_Style_Alignment __construct(
[
$isSupervisor = false])
    

    


	
		Create a new PHPExcel_Style_Alignment

Create a new PHPExcel_Style_Alignment





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $isSupervisor  
        
      

        

    


        
[ Top ]

  

  

	
	
method applyFromArray [line 238]

	

    

    

		PHPExcel_Style_Alignment 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 bindParent [line 150]

	

    

    

		PHPExcel_Style_Alignment bindParent(
PHPExcel
$parent)
    

    


	
		Bind parent.

Bind parent. Only used for supervisor





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel  
        $parent  
        
      

        

    


        
[ Top ]

  

  

	
	
method getActiveCell [line 204]

	

    

    

		string getActiveCell(
)
    

    


	
		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 getActiveSheet [line 182]

	

    

    

		PHPExcel_Worksheet getActiveSheet(
)
    

    


	
		Get the currently active sheet.

Get the currently active sheet. Only used for supervisor





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 473]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHorizontal [line 273]

	

    

    

		string getHorizontal(
)
    

    


	
		Get Horizontal

Get Horizontal





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getIndent [line 440]

	

    

    

		int getIndent(
)
    

    


	
		Get indent

Get indent





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getIsSupervisor [line 161]

	

    

    

		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 getSelectedCells [line 193]

	

    

    

		string getSelectedCells(
)
    

    


	
		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 getSharedComponent [line 172]

	

    

    

		PHPExcel_Style_Alignment 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 getShrinkToFit [line 409]

	

    

    

		boolean getShrinkToFit(
)
    

    


	
		Get Shrink to fit

Get Shrink to fit





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getStyleArray [line 215]

	

    

    

		array getStyleArray(
array
$array)
    

    


	
		Build style array from subcomponents

Build style array from subcomponents





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $array  
        
      

        

    


        
[ Top ]

  

  

	
	
method getTextRotation [line 338]

	

    

    

		int getTextRotation(
)
    

    


	
		Get TextRotation

Get TextRotation





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getVertical [line 306]

	

    

    

		string getVertical(
)
    

    


	
		Get Vertical

Get Vertical





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getWrapText [line 378]

	

    

    

		boolean getWrapText(
)
    

    


	
		Get Wrap Text

Get Wrap Text





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setHorizontal [line 286]

	

    

    

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

    


	
		Set Horizontal

Set Horizontal





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setIndent [line 453]

	

    

    

		PHPExcel_Style_Alignment setIndent(
[int
$pValue = 0])
    

    


	
		Set indent

Set indent





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setShrinkToFit [line 422]

	

    

    

		PHPExcel_Style_Alignment setShrinkToFit(
[boolean
$pValue = false])
    

    


	
		Set Shrink to fit

Set Shrink to fit





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setTextRotation [line 352]

	

    

    

		PHPExcel_Style_Alignment setTextRotation(
[int
$pValue = 0])
    

    


	
		Set TextRotation

Set TextRotation





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setVertical [line 319]

	

    

    

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

    


	
		Set Vertical

Set Vertical





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setWrapText [line 391]

	

    

    

		PHPExcel_Style_Alignment setWrapText(
[boolean
$pValue = false])
    

    


	
		Set Wrap Text

Set Wrap Text





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 491]

	

    

    

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

  
  

	
[ Top ]


	
	

	
HORIZONTAL_CENTER_CONTINUOUS =  'centerContinuous'

	
[line 55]

  
  

	
[ Top ]


	
	

	
HORIZONTAL_GENERAL =  'general'

	
[line 51]

  
  

	
[ Top ]


	
	

	
HORIZONTAL_JUSTIFY =  'justify'

	
[line 56]

  
  

	
[ Top ]


	
	

	
HORIZONTAL_LEFT =  'left'

	
[line 52]

  
  

	
[ Top ]


	
	

	
HORIZONTAL_RIGHT =  'right'

	
[line 53]

  
  

	
[ Top ]


	
	

	
VERTICAL_BOTTOM =  'bottom'

	
[line 59]

  
  

	
[ Top ]


	
	

	
VERTICAL_CENTER =  'center'

	
[line 61]

  
  

	
[ Top ]


	
	

	
VERTICAL_JUSTIFY =  'justify'

	
[line 62]

  
  

	
[ Top ]


	
	

	
VERTICAL_TOP =  'top'

	
[line 60]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Mon, 11 Jan 2010 08:03:41 +0100 by phpDocumentor 1.4.1