PHPExcel_Style

# 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: PHPExcel_IComparable | ### Variables $_horizontal $_indent $_isSupervisor $_parent $_parentPropertyName $_shrinkToFit $_textRotation $_vertical $_wrapText | ### Constants HORIZONTAL_CENTER HORIZONTAL_CENTER_CONTINUOUS HORIZONTAL_GENERAL HORIZONTAL_JUSTIFY HORIZONTAL_LEFT HORIZONTAL_RIGHT VERTICAL_BOTTOM VERTICAL_CENTER VERTICAL_JUSTIFY VERTICAL_TOP | ### Methods __construct applyFromArray bindParent getActiveCell getActiveSheet getHashCode getHorizontal getIndent getIsSupervisor getSelectedCells getSharedComponent getShrinkToFit getStyleArray getTextRotation getVertical getWrapText setHorizontal setIndent setShrinkToFit setTextRotation setVertical setWrapText __clone
### 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 $objPHPExcel->getActiveSheet()->getStyle('B2')->getAlignment()->applyFromArray( array( 'horizontal' => PHPExcel_Style_Alignment::HORIZONTAL_CENTER, 'vertical' => PHPExcel_Style_Alignment::VERTICAL_CENTER, 'rotation' => 0, 'wrap' => true ) ); #### 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