您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符
 
 
 
 

666 行
40 KiB

  1. <!DOCTYPE html><html lang="en">
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  5. <meta charset="utf-8">
  6. <title>PHPExcel classes » \PHPExcel_Style_Alignment</title>
  7. <meta name="author" content="Mike van Riel">
  8. <meta name="description" content="">
  9. <link href="../css/template.css" rel="stylesheet" media="all">
  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
  14. </head>
  15. <body>
  16. <div class="navbar navbar-fixed-top">
  17. <div class="navbar-inner"><div class="container">
  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">PHPExcel classes</a><div class="nav-collapse"><ul class="nav">
  19. <li class="dropdown">
  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  21. API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
  22. <li><a>Packages</a></li>
  23. <li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
  24. <li><a href="../packages/JAMA.html"><i class="icon-folder-open"></i> JAMA</a></li>
  25. <li><a href="../packages/JAMA%0D%0ACholesky%20decomposition%20class%0D%0AFor%20a%20symmetric,%20positive%20definite%20matrix%20A,%20the%20Cholesky%20decomposition%0D%0Ais%20an%20lower%20triangular%20matrix%20L%20so%20that%20A%20=%20L*L'.html"><i class="icon-folder-open"></i> JAMA
  26. Cholesky decomposition class
  27. For a symmetric, positive definite matrix A, the Cholesky decomposition
  28. is an lower triangular matrix L so that A = L*L'</a></li>
  29. <li><a href="../packages/JAMA%0D%0AClass%20to%20obtain%20eigenvalues%20and%20eigenvectors%20of%20a%20real%20matrix.html"><i class="icon-folder-open"></i> JAMA
  30. Class to obtain eigenvalues and eigenvectors of a real matrix</a></li>
  31. <li><a href="../packages/JAMA%0D%0AError%20handling.html"><i class="icon-folder-open"></i> JAMA
  32. Error handling</a></li>
  33. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20LU%20decomposition%20is%20an%20m-by-n%0D%0Aunit%20lower%20triangular%20matrix%20L,%20an%20n-by-n%20upper%20triangular%20matrix%20U,%0D%0Aand%20a%20permutation%20vector%20piv%20of%20length%20m%20so%20that%20A(piv,:)%20=%20L*U.html"><i class="icon-folder-open"></i> JAMA
  34. For an m-by-n matrix A with m &gt;= n, the LU decomposition is an m-by-n
  35. unit lower triangular matrix L, an n-by-n upper triangular matrix U,
  36. and a permutation vector piv of length m so that A(piv,:) = L*U</a></li>
  37. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20QR%20decomposition%20is%20an%20m-by-n%0D%0Aorthogonal%20matrix%20Q%20and%20an%20n-by-n%20upper%20triangular%20matrix%20R%20so%20that%0D%0AA%20=%20Q*R.html"><i class="icon-folder-open"></i> JAMA
  38. For an m-by-n matrix A with m &gt;= n, the QR decomposition is an m-by-n
  39. orthogonal matrix Q and an n-by-n upper triangular matrix R so that
  40. A = Q*R</a></li>
  41. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20singular%20value%20decomposition%20is%0D%0Aan%20m-by-n%20orthogonal%20matrix%20U,%20an%20n-by-n%20diagonal%20matrix%20S,%20and%0D%0Aan%20n-by-n%20orthogonal%20matrix%20V%20so%20that%20A%20=%20U*S*V'.html"><i class="icon-folder-open"></i> JAMA
  42. For an m-by-n matrix A with m &gt;= n, the singular value decomposition is
  43. an m-by-n orthogonal matrix U, an n-by-n diagonal matrix S, and
  44. an n-by-n orthogonal matrix V so that A = U*S*V'</a></li>
  45. <li><a href="../packages/JAMA%0D%0APythagorean%20Theorem:%0D%0Aa%20=%203%0D%0Ab%20=%204%0D%0Ar%20=%20sqrt(square(a)%20+%20square(b))%0D%0Ar%20=%205%0D%0Ar%20=%20sqrt(a%5E2%20+%20b%5E2)%20without%20under.overflow.html"><i class="icon-folder-open"></i> JAMA
  46. Pythagorean Theorem:
  47. a = 3
  48. b = 4
  49. r = sqrt(square(a) + square(b))
  50. r = 5
  51. r = sqrt(a^2 + b^2) without under/overflow</a></li>
  52. <li><a href="../packages/PHPExcel.html"><i class="icon-folder-open"></i> PHPExcel</a></li>
  53. </ul>
  54. </li>
  55. <li class="dropdown" id="charts-menu">
  56. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  57. Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
  58. </li>
  59. <li class="dropdown" id="reports-menu">
  60. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  61. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  62. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  63. <span class="label label-info">551</span></a></li>
  64. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  65. <ul>
  66. <li>todo 
  67. <span class="label label-info">19</span>
  68. </li>
  69. <li>fixme 
  70. <span class="label label-info">10</span>
  71. </li>
  72. </ul></a></li>
  73. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  74. <span class="label label-info">12</span></a></li>
  75. </ul>
  76. </li>
  77. </ul></div>
  78. </div></div>
  79. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  80. </div>
  81. <div id="___" class="container">
  82. <noscript><div class="alert alert-warning">
  83. Javascript is disabled; several features are only available
  84. if Javascript is enabled.
  85. </div></noscript>
  86. <div class="row">
  87. <div class="span4">
  88. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
  89. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
  90. </div>
  91. <ul class="side-nav nav nav-list">
  92. <li class="nav-header">
  93. <i class="icon-custom icon-method"></i> Methods
  94. <ul>
  95. <li class="method public inherited"><a href="#method___clone" title="__clone :: Implement PHP __clone to create a deep clone, not just a shallow copy."><span class="description">Implement PHP __clone to create a deep clone, not just a shallow copy.</span><pre>__clone()</pre></a></li>
  96. <li class="method public "><a href="#method___construct" title="__construct :: Create a new PHPExcel_Style_Alignment"><span class="description">Create a new PHPExcel_Style_Alignment</span><pre>__construct()</pre></a></li>
  97. <li class="method public "><a href="#method_applyFromArray" title="applyFromArray :: Apply styles from array"><span class="description">Apply styles from array</span><pre>applyFromArray()</pre></a></li>
  98. <li class="method public inherited"><a href="#method_bindParent" title="bindParent :: Bind parent."><span class="description">Bind parent.</span><pre>bindParent()</pre></a></li>
  99. <li class="method public inherited"><a href="#method_getActiveCell" title="getActiveCell :: Get the currently active cell coordinate in currently active sheet."><span class="description">Get the currently active cell coordinate in currently active sheet.</span><pre>getActiveCell()</pre></a></li>
  100. <li class="method public inherited"><a href="#method_getActiveSheet" title="getActiveSheet :: Get the currently active sheet."><span class="description">Get the currently active sheet.</span><pre>getActiveSheet()</pre></a></li>
  101. <li class="method public "><a href="#method_getHashCode" title="getHashCode :: Get hash code"><span class="description">Get hash code</span><pre>getHashCode()</pre></a></li>
  102. <li class="method public "><a href="#method_getHorizontal" title="getHorizontal :: Get Horizontal"><span class="description">Get Horizontal</span><pre>getHorizontal()</pre></a></li>
  103. <li class="method public "><a href="#method_getIndent" title="getIndent :: Get indent"><span class="description">Get indent</span><pre>getIndent()</pre></a></li>
  104. <li class="method public inherited"><a href="#method_getIsSupervisor" title="getIsSupervisor :: Is this a supervisor or a cell style component?"><span class="description">Is this a supervisor or a cell style component?</span><pre>getIsSupervisor()</pre></a></li>
  105. <li class="method public inherited"><a href="#method_getSelectedCells" title="getSelectedCells :: Get the currently active cell coordinate in currently active sheet."><span class="description">Get the currently active cell coordinate in currently active sheet.</span><pre>getSelectedCells()</pre></a></li>
  106. <li class="method public "><a href="#method_getSharedComponent" title="getSharedComponent :: Get the shared style component for the currently active cell in currently active sheet."><span class="description">Get the shared style component for the currently active cell in currently active sheet.</span><pre>getSharedComponent()</pre></a></li>
  107. <li class="method public "><a href="#method_getShrinkToFit" title="getShrinkToFit :: Get Shrink to fit"><span class="description">Get Shrink to fit</span><pre>getShrinkToFit()</pre></a></li>
  108. <li class="method public "><a href="#method_getStyleArray" title="getStyleArray :: Build style array from subcomponents"><span class="description">Build style array from subcomponents</span><pre>getStyleArray()</pre></a></li>
  109. <li class="method public "><a href="#method_getTextRotation" title="getTextRotation :: Get TextRotation"><span class="description">Get TextRotation</span><pre>getTextRotation()</pre></a></li>
  110. <li class="method public "><a href="#method_getVertical" title="getVertical :: Get Vertical"><span class="description">Get Vertical</span><pre>getVertical()</pre></a></li>
  111. <li class="method public "><a href="#method_getWrapText" title="getWrapText :: Get Wrap Text"><span class="description">Get Wrap Text</span><pre>getWrapText()</pre></a></li>
  112. <li class="method public "><a href="#method_setHorizontal" title="setHorizontal :: Set Horizontal"><span class="description">Set Horizontal</span><pre>setHorizontal()</pre></a></li>
  113. <li class="method public "><a href="#method_setIndent" title="setIndent :: Set indent"><span class="description">Set indent</span><pre>setIndent()</pre></a></li>
  114. <li class="method public "><a href="#method_setShrinkToFit" title="setShrinkToFit :: Set Shrink to fit"><span class="description">Set Shrink to fit</span><pre>setShrinkToFit()</pre></a></li>
  115. <li class="method public "><a href="#method_setTextRotation" title="setTextRotation :: Set TextRotation"><span class="description">Set TextRotation</span><pre>setTextRotation()</pre></a></li>
  116. <li class="method public "><a href="#method_setVertical" title="setVertical :: Set Vertical"><span class="description">Set Vertical</span><pre>setVertical()</pre></a></li>
  117. <li class="method public "><a href="#method_setWrapText" title="setWrapText :: Set Wrap Text"><span class="description">Set Wrap Text</span><pre>setWrapText()</pre></a></li>
  118. </ul>
  119. </li>
  120. <li class="nav-header">
  121. <i class="icon-custom icon-property"></i> Properties
  122. <ul></ul>
  123. </li>
  124. <li class="nav-header protected">» Protected
  125. <ul>
  126. <li class="property protected "><a href="#property__horizontal" title="$_horizontal :: Horizontal"><span class="description"></span><pre>$_horizontal</pre></a></li>
  127. <li class="property protected "><a href="#property__indent" title="$_indent :: Indent - only possible with horizontal alignment left and right"><span class="description"></span><pre>$_indent</pre></a></li>
  128. <li class="property protected inherited"><a href="#property__isSupervisor" title="$_isSupervisor :: Supervisor?"><span class="description"></span><pre>$_isSupervisor</pre></a></li>
  129. <li class="property protected inherited"><a href="#property__parent" title="$_parent :: Parent."><span class="description"></span><pre>$_parent</pre></a></li>
  130. <li class="property protected "><a href="#property__shrinkToFit" title="$_shrinkToFit :: Shrink to fit"><span class="description"></span><pre>$_shrinkToFit</pre></a></li>
  131. <li class="property protected "><a href="#property__textRotation" title="$_textRotation :: Text rotation"><span class="description"></span><pre>$_textRotation</pre></a></li>
  132. <li class="property protected "><a href="#property__vertical" title="$_vertical :: Vertical"><span class="description"></span><pre>$_vertical</pre></a></li>
  133. <li class="property protected "><a href="#property__wrapText" title="$_wrapText :: Wrap text"><span class="description"></span><pre>$_wrapText</pre></a></li>
  134. </ul>
  135. </li>
  136. <li class="nav-header">
  137. <i class="icon-custom icon-constant"></i> Constants
  138. <ul>
  139. <li class="constant "><a href="#constant_HORIZONTAL_CENTER" title="HORIZONTAL_CENTER :: "><span class="description">HORIZONTAL_CENTER</span><pre>HORIZONTAL_CENTER</pre></a></li>
  140. <li class="constant "><a href="#constant_HORIZONTAL_CENTER_CONTINUOUS" title="HORIZONTAL_CENTER_CONTINUOUS :: "><span class="description">HORIZONTAL_CENTER_CONTINUOUS</span><pre>HORIZONTAL_CENTER_CONTINUOUS</pre></a></li>
  141. <li class="constant "><a href="#constant_HORIZONTAL_DISTRIBUTED" title="HORIZONTAL_DISTRIBUTED :: "><span class="description">HORIZONTAL_DISTRIBUTED</span><pre>HORIZONTAL_DISTRIBUTED</pre></a></li>
  142. <li class="constant "><a href="#constant_HORIZONTAL_FILL" title="HORIZONTAL_FILL :: "><span class="description">HORIZONTAL_FILL</span><pre>HORIZONTAL_FILL</pre></a></li>
  143. <li class="constant "><a href="#constant_HORIZONTAL_GENERAL" title="HORIZONTAL_GENERAL :: "><span class="description">HORIZONTAL_GENERAL</span><pre>HORIZONTAL_GENERAL</pre></a></li>
  144. <li class="constant "><a href="#constant_HORIZONTAL_JUSTIFY" title="HORIZONTAL_JUSTIFY :: "><span class="description">HORIZONTAL_JUSTIFY</span><pre>HORIZONTAL_JUSTIFY</pre></a></li>
  145. <li class="constant "><a href="#constant_HORIZONTAL_LEFT" title="HORIZONTAL_LEFT :: "><span class="description">HORIZONTAL_LEFT</span><pre>HORIZONTAL_LEFT</pre></a></li>
  146. <li class="constant "><a href="#constant_HORIZONTAL_RIGHT" title="HORIZONTAL_RIGHT :: "><span class="description">HORIZONTAL_RIGHT</span><pre>HORIZONTAL_RIGHT</pre></a></li>
  147. <li class="constant "><a href="#constant_VERTICAL_BOTTOM" title="VERTICAL_BOTTOM :: "><span class="description">VERTICAL_BOTTOM</span><pre>VERTICAL_BOTTOM</pre></a></li>
  148. <li class="constant "><a href="#constant_VERTICAL_CENTER" title="VERTICAL_CENTER :: "><span class="description">VERTICAL_CENTER</span><pre>VERTICAL_CENTER</pre></a></li>
  149. <li class="constant "><a href="#constant_VERTICAL_DISTRIBUTED" title="VERTICAL_DISTRIBUTED :: "><span class="description">VERTICAL_DISTRIBUTED</span><pre>VERTICAL_DISTRIBUTED</pre></a></li>
  150. <li class="constant "><a href="#constant_VERTICAL_JUSTIFY" title="VERTICAL_JUSTIFY :: "><span class="description">VERTICAL_JUSTIFY</span><pre>VERTICAL_JUSTIFY</pre></a></li>
  151. <li class="constant "><a href="#constant_VERTICAL_TOP" title="VERTICAL_TOP :: "><span class="description">VERTICAL_TOP</span><pre>VERTICAL_TOP</pre></a></li>
  152. </ul>
  153. </li>
  154. </ul>
  155. </div>
  156. <div class="span8">
  157. <a id="\PHPExcel_Style_Alignment"></a><ul class="breadcrumb">
  158. <li>
  159. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  160. </li>
  161. <li><a href="../namespaces/global.html">global</a></li>
  162. <li class="active">
  163. <span class="divider">\</span><a href="../classes/PHPExcel_Style_Alignment.html">PHPExcel_Style_Alignment</a>
  164. </li>
  165. </ul>
  166. <div class="element class">
  167. <p class="short_description">PHPExcel_Style_Alignment</p>
  168. <div class="details">
  169. <div class="long_description"></div>
  170. <table class="table table-bordered">
  171. <tr>
  172. <th>category</th>
  173. <td>PHPExcel</td>
  174. </tr>
  175. <tr>
  176. <th>package</th>
  177. <td><a href="../packages/PHPExcel.Style.html">PHPExcel_Style</a></td>
  178. </tr>
  179. <tr>
  180. <th>copyright</th>
  181. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>
  182. </tr>
  183. </table>
  184. <h3>
  185. <i class="icon-custom icon-method"></i> Methods</h3>
  186. <a id="method___clone"></a><div class="element clickable method public method___clone" data-toggle="collapse" data-target=".method___clone .collapse">
  187. <h2>Implement PHP __clone to create a deep clone, not just a shallow copy.</h2>
  188. <pre>__clone() </pre>
  189. <div class="labels"><span class="label">Inherited</span></div>
  190. <div class="row collapse"><div class="detail-description">
  191. <div class="long_description"></div>
  192. <table class="table table-bordered"><tr>
  193. <th>inherited_from</th>
  194. <td>\PHPExcel_Style_Supervisor::__clone()</td>
  195. </tr></table>
  196. </div></div>
  197. </div>
  198. <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
  199. <h2>Create a new PHPExcel_Style_Alignment</h2>
  200. <pre>__construct(boolean $isSupervisor, boolean $isConditional) </pre>
  201. <div class="labels"></div>
  202. <div class="row collapse"><div class="detail-description">
  203. <div class="long_description"></div>
  204. <h3>Parameters</h3>
  205. <div class="subelement argument">
  206. <h4>$isSupervisor</h4>
  207. <code>boolean</code><p>Flag indicating if this is a supervisor or not
  208. Leave this value at default unless you understand exactly what
  209. its ramifications are</p></div>
  210. <div class="subelement argument">
  211. <h4>$isConditional</h4>
  212. <code>boolean</code><p>Flag indicating if this is a conditional style or not
  213. Leave this value at default unless you understand exactly what
  214. its ramifications are</p></div>
  215. </div></div>
  216. </div>
  217. <a id="method_applyFromArray"></a><div class="element clickable method public method_applyFromArray" data-toggle="collapse" data-target=".method_applyFromArray .collapse">
  218. <h2>Apply styles from array</h2>
  219. <pre>applyFromArray(array $pStyles) : <a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></pre>
  220. <div class="labels"></div>
  221. <div class="row collapse"><div class="detail-description">
  222. <div class="long_description"><pre><code>$objPHPExcel->getActiveSheet()->getStyle('B2')->getAlignment()->applyFromArray(
  223. array(
  224. 'horizontal' => PHPExcel_Style_Alignment::HORIZONTAL_CENTER,
  225. 'vertical' => PHPExcel_Style_Alignment::VERTICAL_CENTER,
  226. 'rotation' => 0,
  227. 'wrap' => TRUE
  228. )
  229. );
  230. </code></pre></div>
  231. <h3>Parameters</h3>
  232. <div class="subelement argument">
  233. <h4>$pStyles</h4>
  234. <code>array</code><p>Array containing style information</p></div>
  235. <h3>Exceptions</h3>
  236. <table class="table table-bordered"><tr>
  237. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  238. <td></td>
  239. </tr></table>
  240. <h3>Returns</h3>
  241. <div class="subelement response"><code><a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></code></div>
  242. </div></div>
  243. </div>
  244. <a id="method_bindParent"></a><div class="element clickable method public method_bindParent" data-toggle="collapse" data-target=".method_bindParent .collapse">
  245. <h2>Bind parent.</h2>
  246. <pre>bindParent(<a href="../classes/PHPExcel.html">\PHPExcel</a> $parent, $parentPropertyName) : <a href="../classes/PHPExcel_Style_Supervisor.html">\PHPExcel_Style_Supervisor</a></pre>
  247. <div class="labels"><span class="label">Inherited</span></div>
  248. <div class="row collapse"><div class="detail-description">
  249. <div class="long_description"><p>Only used for supervisor</p></div>
  250. <table class="table table-bordered"><tr>
  251. <th>inherited_from</th>
  252. <td>\PHPExcel_Style_Supervisor::bindParent()</td>
  253. </tr></table>
  254. <h3>Parameters</h3>
  255. <div class="subelement argument">
  256. <h4>$parent</h4>
  257. <code><a href="../classes/PHPExcel.html">\PHPExcel</a></code>
  258. </div>
  259. <div class="subelement argument"><h4>$parentPropertyName</h4></div>
  260. <h3>Returns</h3>
  261. <div class="subelement response"><code><a href="../classes/PHPExcel_Style_Supervisor.html">\PHPExcel_Style_Supervisor</a></code></div>
  262. </div></div>
  263. </div>
  264. <a id="method_getActiveCell"></a><div class="element clickable method public method_getActiveCell" data-toggle="collapse" data-target=".method_getActiveCell .collapse">
  265. <h2>Get the currently active cell coordinate in currently active sheet.</h2>
  266. <pre>getActiveCell() : string</pre>
  267. <div class="labels"><span class="label">Inherited</span></div>
  268. <div class="row collapse"><div class="detail-description">
  269. <div class="long_description"><p>Only used for supervisor</p></div>
  270. <table class="table table-bordered"><tr>
  271. <th>inherited_from</th>
  272. <td>\PHPExcel_Style_Supervisor::getActiveCell()</td>
  273. </tr></table>
  274. <h3>Returns</h3>
  275. <div class="subelement response">
  276. <code>string</code>E.g. 'A1'</div>
  277. </div></div>
  278. </div>
  279. <a id="method_getActiveSheet"></a><div class="element clickable method public method_getActiveSheet" data-toggle="collapse" data-target=".method_getActiveSheet .collapse">
  280. <h2>Get the currently active sheet.</h2>
  281. <pre>getActiveSheet() : <a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></pre>
  282. <div class="labels"><span class="label">Inherited</span></div>
  283. <div class="row collapse"><div class="detail-description">
  284. <div class="long_description"><p>Only used for supervisor</p></div>
  285. <table class="table table-bordered"><tr>
  286. <th>inherited_from</th>
  287. <td>\PHPExcel_Style_Supervisor::getActiveSheet()</td>
  288. </tr></table>
  289. <h3>Returns</h3>
  290. <div class="subelement response"><code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code></div>
  291. </div></div>
  292. </div>
  293. <a id="method_getHashCode"></a><div class="element clickable method public method_getHashCode" data-toggle="collapse" data-target=".method_getHashCode .collapse">
  294. <h2>Get hash code</h2>
  295. <pre>getHashCode() : string</pre>
  296. <div class="labels"></div>
  297. <div class="row collapse"><div class="detail-description">
  298. <div class="long_description"></div>
  299. <h3>Returns</h3>
  300. <div class="subelement response">
  301. <code>string</code>Hash code</div>
  302. </div></div>
  303. </div>
  304. <a id="method_getHorizontal"></a><div class="element clickable method public method_getHorizontal" data-toggle="collapse" data-target=".method_getHorizontal .collapse">
  305. <h2>Get Horizontal</h2>
  306. <pre>getHorizontal() : string</pre>
  307. <div class="labels"></div>
  308. <div class="row collapse"><div class="detail-description">
  309. <div class="long_description"></div>
  310. <h3>Returns</h3>
  311. <div class="subelement response"><code>string</code></div>
  312. </div></div>
  313. </div>
  314. <a id="method_getIndent"></a><div class="element clickable method public method_getIndent" data-toggle="collapse" data-target=".method_getIndent .collapse">
  315. <h2>Get indent</h2>
  316. <pre>getIndent() : int</pre>
  317. <div class="labels"></div>
  318. <div class="row collapse"><div class="detail-description">
  319. <div class="long_description"></div>
  320. <h3>Returns</h3>
  321. <div class="subelement response"><code>int</code></div>
  322. </div></div>
  323. </div>
  324. <a id="method_getIsSupervisor"></a><div class="element clickable method public method_getIsSupervisor" data-toggle="collapse" data-target=".method_getIsSupervisor .collapse">
  325. <h2>Is this a supervisor or a cell style component?</h2>
  326. <pre>getIsSupervisor() : boolean</pre>
  327. <div class="labels"><span class="label">Inherited</span></div>
  328. <div class="row collapse"><div class="detail-description">
  329. <div class="long_description"></div>
  330. <table class="table table-bordered"><tr>
  331. <th>inherited_from</th>
  332. <td>\PHPExcel_Style_Supervisor::getIsSupervisor()</td>
  333. </tr></table>
  334. <h3>Returns</h3>
  335. <div class="subelement response"><code>boolean</code></div>
  336. </div></div>
  337. </div>
  338. <a id="method_getSelectedCells"></a><div class="element clickable method public method_getSelectedCells" data-toggle="collapse" data-target=".method_getSelectedCells .collapse">
  339. <h2>Get the currently active cell coordinate in currently active sheet.</h2>
  340. <pre>getSelectedCells() : string</pre>
  341. <div class="labels"><span class="label">Inherited</span></div>
  342. <div class="row collapse"><div class="detail-description">
  343. <div class="long_description"><p>Only used for supervisor</p></div>
  344. <table class="table table-bordered"><tr>
  345. <th>inherited_from</th>
  346. <td>\PHPExcel_Style_Supervisor::getSelectedCells()</td>
  347. </tr></table>
  348. <h3>Returns</h3>
  349. <div class="subelement response">
  350. <code>string</code>E.g. 'A1'</div>
  351. </div></div>
  352. </div>
  353. <a id="method_getSharedComponent"></a><div class="element clickable method public method_getSharedComponent" data-toggle="collapse" data-target=".method_getSharedComponent .collapse">
  354. <h2>Get the shared style component for the currently active cell in currently active sheet.</h2>
  355. <pre>getSharedComponent() : <a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></pre>
  356. <div class="labels"></div>
  357. <div class="row collapse"><div class="detail-description">
  358. <div class="long_description"><p>Only used for style supervisor</p></div>
  359. <h3>Returns</h3>
  360. <div class="subelement response"><code><a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></code></div>
  361. </div></div>
  362. </div>
  363. <a id="method_getShrinkToFit"></a><div class="element clickable method public method_getShrinkToFit" data-toggle="collapse" data-target=".method_getShrinkToFit .collapse">
  364. <h2>Get Shrink to fit</h2>
  365. <pre>getShrinkToFit() : boolean</pre>
  366. <div class="labels"></div>
  367. <div class="row collapse"><div class="detail-description">
  368. <div class="long_description"></div>
  369. <h3>Returns</h3>
  370. <div class="subelement response"><code>boolean</code></div>
  371. </div></div>
  372. </div>
  373. <a id="method_getStyleArray"></a><div class="element clickable method public method_getStyleArray" data-toggle="collapse" data-target=".method_getStyleArray .collapse">
  374. <h2>Build style array from subcomponents</h2>
  375. <pre>getStyleArray(array $array) : array</pre>
  376. <div class="labels"></div>
  377. <div class="row collapse"><div class="detail-description">
  378. <div class="long_description"></div>
  379. <h3>Parameters</h3>
  380. <div class="subelement argument">
  381. <h4>$array</h4>
  382. <code>array</code>
  383. </div>
  384. <h3>Returns</h3>
  385. <div class="subelement response"><code>array</code></div>
  386. </div></div>
  387. </div>
  388. <a id="method_getTextRotation"></a><div class="element clickable method public method_getTextRotation" data-toggle="collapse" data-target=".method_getTextRotation .collapse">
  389. <h2>Get TextRotation</h2>
  390. <pre>getTextRotation() : int</pre>
  391. <div class="labels"></div>
  392. <div class="row collapse"><div class="detail-description">
  393. <div class="long_description"></div>
  394. <h3>Returns</h3>
  395. <div class="subelement response"><code>int</code></div>
  396. </div></div>
  397. </div>
  398. <a id="method_getVertical"></a><div class="element clickable method public method_getVertical" data-toggle="collapse" data-target=".method_getVertical .collapse">
  399. <h2>Get Vertical</h2>
  400. <pre>getVertical() : string</pre>
  401. <div class="labels"></div>
  402. <div class="row collapse"><div class="detail-description">
  403. <div class="long_description"></div>
  404. <h3>Returns</h3>
  405. <div class="subelement response"><code>string</code></div>
  406. </div></div>
  407. </div>
  408. <a id="method_getWrapText"></a><div class="element clickable method public method_getWrapText" data-toggle="collapse" data-target=".method_getWrapText .collapse">
  409. <h2>Get Wrap Text</h2>
  410. <pre>getWrapText() : boolean</pre>
  411. <div class="labels"></div>
  412. <div class="row collapse"><div class="detail-description">
  413. <div class="long_description"></div>
  414. <h3>Returns</h3>
  415. <div class="subelement response"><code>boolean</code></div>
  416. </div></div>
  417. </div>
  418. <a id="method_setHorizontal"></a><div class="element clickable method public method_setHorizontal" data-toggle="collapse" data-target=".method_setHorizontal .collapse">
  419. <h2>Set Horizontal</h2>
  420. <pre>setHorizontal(string $pValue) : <a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></pre>
  421. <div class="labels"></div>
  422. <div class="row collapse"><div class="detail-description">
  423. <div class="long_description"></div>
  424. <h3>Parameters</h3>
  425. <div class="subelement argument">
  426. <h4>$pValue</h4>
  427. <code>string</code>
  428. </div>
  429. <h3>Returns</h3>
  430. <div class="subelement response"><code><a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></code></div>
  431. </div></div>
  432. </div>
  433. <a id="method_setIndent"></a><div class="element clickable method public method_setIndent" data-toggle="collapse" data-target=".method_setIndent .collapse">
  434. <h2>Set indent</h2>
  435. <pre>setIndent(int $pValue) : <a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></pre>
  436. <div class="labels"></div>
  437. <div class="row collapse"><div class="detail-description">
  438. <div class="long_description"></div>
  439. <h3>Parameters</h3>
  440. <div class="subelement argument">
  441. <h4>$pValue</h4>
  442. <code>int</code>
  443. </div>
  444. <h3>Returns</h3>
  445. <div class="subelement response"><code><a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></code></div>
  446. </div></div>
  447. </div>
  448. <a id="method_setShrinkToFit"></a><div class="element clickable method public method_setShrinkToFit" data-toggle="collapse" data-target=".method_setShrinkToFit .collapse">
  449. <h2>Set Shrink to fit</h2>
  450. <pre>setShrinkToFit(boolean $pValue) : <a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></pre>
  451. <div class="labels"></div>
  452. <div class="row collapse"><div class="detail-description">
  453. <div class="long_description"></div>
  454. <h3>Parameters</h3>
  455. <div class="subelement argument">
  456. <h4>$pValue</h4>
  457. <code>boolean</code>
  458. </div>
  459. <h3>Returns</h3>
  460. <div class="subelement response"><code><a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></code></div>
  461. </div></div>
  462. </div>
  463. <a id="method_setTextRotation"></a><div class="element clickable method public method_setTextRotation" data-toggle="collapse" data-target=".method_setTextRotation .collapse">
  464. <h2>Set TextRotation</h2>
  465. <pre>setTextRotation(int $pValue) : <a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></pre>
  466. <div class="labels"></div>
  467. <div class="row collapse"><div class="detail-description">
  468. <div class="long_description"></div>
  469. <h3>Parameters</h3>
  470. <div class="subelement argument">
  471. <h4>$pValue</h4>
  472. <code>int</code>
  473. </div>
  474. <h3>Exceptions</h3>
  475. <table class="table table-bordered"><tr>
  476. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  477. <td></td>
  478. </tr></table>
  479. <h3>Returns</h3>
  480. <div class="subelement response"><code><a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></code></div>
  481. </div></div>
  482. </div>
  483. <a id="method_setVertical"></a><div class="element clickable method public method_setVertical" data-toggle="collapse" data-target=".method_setVertical .collapse">
  484. <h2>Set Vertical</h2>
  485. <pre>setVertical(string $pValue) : <a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></pre>
  486. <div class="labels"></div>
  487. <div class="row collapse"><div class="detail-description">
  488. <div class="long_description"></div>
  489. <h3>Parameters</h3>
  490. <div class="subelement argument">
  491. <h4>$pValue</h4>
  492. <code>string</code>
  493. </div>
  494. <h3>Returns</h3>
  495. <div class="subelement response"><code><a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></code></div>
  496. </div></div>
  497. </div>
  498. <a id="method_setWrapText"></a><div class="element clickable method public method_setWrapText" data-toggle="collapse" data-target=".method_setWrapText .collapse">
  499. <h2>Set Wrap Text</h2>
  500. <pre>setWrapText(boolean $pValue) : <a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></pre>
  501. <div class="labels"></div>
  502. <div class="row collapse"><div class="detail-description">
  503. <div class="long_description"></div>
  504. <h3>Parameters</h3>
  505. <div class="subelement argument">
  506. <h4>$pValue</h4>
  507. <code>boolean</code>
  508. </div>
  509. <h3>Returns</h3>
  510. <div class="subelement response"><code><a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></code></div>
  511. </div></div>
  512. </div>
  513. <h3>
  514. <i class="icon-custom icon-property"></i> Properties</h3>
  515. <a id="property__horizontal"> </a><div class="element clickable property protected property__horizontal" data-toggle="collapse" data-target=".property__horizontal .collapse">
  516. <h2></h2>
  517. <pre>$_horizontal : string</pre>
  518. <div class="labels"></div>
  519. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  520. </div>
  521. <a id="property__indent"> </a><div class="element clickable property protected property__indent" data-toggle="collapse" data-target=".property__indent .collapse">
  522. <h2></h2>
  523. <pre>$_indent : int</pre>
  524. <div class="labels"></div>
  525. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  526. </div>
  527. <a id="property__isSupervisor"> </a><div class="element clickable property protected property__isSupervisor" data-toggle="collapse" data-target=".property__isSupervisor .collapse">
  528. <h2></h2>
  529. <pre>$_isSupervisor : boolean</pre>
  530. <div class="labels"><span class="label">Inherited</span></div>
  531. <div class="row collapse"><div class="detail-description">
  532. <div class="long_description"></div>
  533. <table class="table table-bordered"><tr>
  534. <th>inherited_from</th>
  535. <td>\PHPExcel_Style_Supervisor::$$_isSupervisor</td>
  536. </tr></table>
  537. </div></div>
  538. </div>
  539. <a id="property__parent"> </a><div class="element clickable property protected property__parent" data-toggle="collapse" data-target=".property__parent .collapse">
  540. <h2></h2>
  541. <pre>$_parent : <a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></pre>
  542. <div class="labels"><span class="label">Inherited</span></div>
  543. <div class="row collapse"><div class="detail-description">
  544. <div class="long_description"><p>Only used for supervisor</p></div>
  545. <table class="table table-bordered"><tr>
  546. <th>inherited_from</th>
  547. <td>\PHPExcel_Style_Supervisor::$$_parent</td>
  548. </tr></table>
  549. </div></div>
  550. </div>
  551. <a id="property__shrinkToFit"> </a><div class="element clickable property protected property__shrinkToFit" data-toggle="collapse" data-target=".property__shrinkToFit .collapse">
  552. <h2></h2>
  553. <pre>$_shrinkToFit : boolean</pre>
  554. <div class="labels"></div>
  555. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  556. </div>
  557. <a id="property__textRotation"> </a><div class="element clickable property protected property__textRotation" data-toggle="collapse" data-target=".property__textRotation .collapse">
  558. <h2></h2>
  559. <pre>$_textRotation : int</pre>
  560. <div class="labels"></div>
  561. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  562. </div>
  563. <a id="property__vertical"> </a><div class="element clickable property protected property__vertical" data-toggle="collapse" data-target=".property__vertical .collapse">
  564. <h2></h2>
  565. <pre>$_vertical : string</pre>
  566. <div class="labels"></div>
  567. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  568. </div>
  569. <a id="property__wrapText"> </a><div class="element clickable property protected property__wrapText" data-toggle="collapse" data-target=".property__wrapText .collapse">
  570. <h2></h2>
  571. <pre>$_wrapText : boolean</pre>
  572. <div class="labels"></div>
  573. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  574. </div>
  575. <h3>
  576. <i class="icon-custom icon-constant"></i> Constants</h3>
  577. <a id="constant_HORIZONTAL_CENTER"> </a><div class="element clickable constant constant_HORIZONTAL_CENTER" data-toggle="collapse" data-target=".constant_HORIZONTAL_CENTER .collapse">
  578. <h2>HORIZONTAL_CENTER</h2>
  579. <pre>HORIZONTAL_CENTER </pre>
  580. <div class="labels"></div>
  581. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  582. </div>
  583. <a id="constant_HORIZONTAL_CENTER_CONTINUOUS"> </a><div class="element clickable constant constant_HORIZONTAL_CENTER_CONTINUOUS" data-toggle="collapse" data-target=".constant_HORIZONTAL_CENTER_CONTINUOUS .collapse">
  584. <h2>HORIZONTAL_CENTER_CONTINUOUS</h2>
  585. <pre>HORIZONTAL_CENTER_CONTINUOUS </pre>
  586. <div class="labels"></div>
  587. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  588. </div>
  589. <a id="constant_HORIZONTAL_DISTRIBUTED"> </a><div class="element clickable constant constant_HORIZONTAL_DISTRIBUTED" data-toggle="collapse" data-target=".constant_HORIZONTAL_DISTRIBUTED .collapse">
  590. <h2>HORIZONTAL_DISTRIBUTED</h2>
  591. <pre>HORIZONTAL_DISTRIBUTED </pre>
  592. <div class="labels"></div>
  593. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  594. </div>
  595. <a id="constant_HORIZONTAL_FILL"> </a><div class="element clickable constant constant_HORIZONTAL_FILL" data-toggle="collapse" data-target=".constant_HORIZONTAL_FILL .collapse">
  596. <h2>HORIZONTAL_FILL</h2>
  597. <pre>HORIZONTAL_FILL </pre>
  598. <div class="labels"></div>
  599. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  600. </div>
  601. <a id="constant_HORIZONTAL_GENERAL"> </a><div class="element clickable constant constant_HORIZONTAL_GENERAL" data-toggle="collapse" data-target=".constant_HORIZONTAL_GENERAL .collapse">
  602. <h2>HORIZONTAL_GENERAL</h2>
  603. <pre>HORIZONTAL_GENERAL </pre>
  604. <div class="labels"></div>
  605. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  606. </div>
  607. <a id="constant_HORIZONTAL_JUSTIFY"> </a><div class="element clickable constant constant_HORIZONTAL_JUSTIFY" data-toggle="collapse" data-target=".constant_HORIZONTAL_JUSTIFY .collapse">
  608. <h2>HORIZONTAL_JUSTIFY</h2>
  609. <pre>HORIZONTAL_JUSTIFY </pre>
  610. <div class="labels"></div>
  611. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  612. </div>
  613. <a id="constant_HORIZONTAL_LEFT"> </a><div class="element clickable constant constant_HORIZONTAL_LEFT" data-toggle="collapse" data-target=".constant_HORIZONTAL_LEFT .collapse">
  614. <h2>HORIZONTAL_LEFT</h2>
  615. <pre>HORIZONTAL_LEFT </pre>
  616. <div class="labels"></div>
  617. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  618. </div>
  619. <a id="constant_HORIZONTAL_RIGHT"> </a><div class="element clickable constant constant_HORIZONTAL_RIGHT" data-toggle="collapse" data-target=".constant_HORIZONTAL_RIGHT .collapse">
  620. <h2>HORIZONTAL_RIGHT</h2>
  621. <pre>HORIZONTAL_RIGHT </pre>
  622. <div class="labels"></div>
  623. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  624. </div>
  625. <a id="constant_VERTICAL_BOTTOM"> </a><div class="element clickable constant constant_VERTICAL_BOTTOM" data-toggle="collapse" data-target=".constant_VERTICAL_BOTTOM .collapse">
  626. <h2>VERTICAL_BOTTOM</h2>
  627. <pre>VERTICAL_BOTTOM </pre>
  628. <div class="labels"></div>
  629. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  630. </div>
  631. <a id="constant_VERTICAL_CENTER"> </a><div class="element clickable constant constant_VERTICAL_CENTER" data-toggle="collapse" data-target=".constant_VERTICAL_CENTER .collapse">
  632. <h2>VERTICAL_CENTER</h2>
  633. <pre>VERTICAL_CENTER </pre>
  634. <div class="labels"></div>
  635. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  636. </div>
  637. <a id="constant_VERTICAL_DISTRIBUTED"> </a><div class="element clickable constant constant_VERTICAL_DISTRIBUTED" data-toggle="collapse" data-target=".constant_VERTICAL_DISTRIBUTED .collapse">
  638. <h2>VERTICAL_DISTRIBUTED</h2>
  639. <pre>VERTICAL_DISTRIBUTED </pre>
  640. <div class="labels"></div>
  641. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  642. </div>
  643. <a id="constant_VERTICAL_JUSTIFY"> </a><div class="element clickable constant constant_VERTICAL_JUSTIFY" data-toggle="collapse" data-target=".constant_VERTICAL_JUSTIFY .collapse">
  644. <h2>VERTICAL_JUSTIFY</h2>
  645. <pre>VERTICAL_JUSTIFY </pre>
  646. <div class="labels"></div>
  647. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  648. </div>
  649. <a id="constant_VERTICAL_TOP"> </a><div class="element clickable constant constant_VERTICAL_TOP" data-toggle="collapse" data-target=".constant_VERTICAL_TOP .collapse">
  650. <h2>VERTICAL_TOP</h2>
  651. <pre>VERTICAL_TOP </pre>
  652. <div class="labels"></div>
  653. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  654. </div>
  655. </div>
  656. </div>
  657. </div>
  658. </div>
  659. <div class="row"><footer class="span12">
  660. Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
  661. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
  662. generated on 2014-03-02T15:27:37Z.<br></footer></div>
  663. </div>
  664. </body>
  665. </html>