[Sommaire] [Imprimer]

   1  <?xml version="1.0" encoding="iso-8859-1"?>
   2  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3    <html xmlns="http://www.w3.org/1999/xhtml">
   4          <head>
   5              <!-- template designed by Marco Von Ballmoos -->
   6              <title>Docs For Class TTheme</title>
   7              <link rel="stylesheet" href="../media/stylesheet.css" />
   8              <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
   9          </head>
  10          <body>
  11              <div class="page-body">            
  12  <h2 class="class-name">Class TTheme</h2>
  13  
  14  <a name="sec-description"></a>
  15  <div class="info-box">
  16      <div class="info-box-title">Description</div>
  17      <div class="nav-bar">
  18                      <span class="disabled">Description</span> |
  19                                                              <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20                          
  21                                              <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  22                          
  23              </div>
  24      <div class="info-box-body">
  25                  <p class="implements">
  26              Implements interfaces:
  27              <ul>
  28                  <li><a href="../System.Web.UI/ITheme.html">ITheme</a></li>            </ul>
  29          </p>
  30                  <!-- ========== Info from phpDoc block ========= -->
  31  <p class="short-description">TTheme class</p>
  32  <p class="description"><p>TTheme represents a particular theme. It is merely a collection of skins  that are applicable to the corresponding controls.</p><p>Each theme is stored as a directory and files under that directory.  The theme name is the directory name. When TTheme is created, the files  whose name has the extension &quot;.skin&quot; are parsed and saved as controls skins.</p><p>A skin is essentially a list of initial property values that are to be applied  to a control when the skin is applied.  Each type of control can have multiple skins identified by the SkinID.  If a skin does not have SkinID, it is the default skin that will be applied  to controls that do not specify particular SkinID.</p><p>Whenever possible, TTheme will try to make use of available cache to save  the parsing time.</p><p>To apply a theme to a particular control, call <a href="../System.Web.UI/TTheme.html#methodapplySkin">applySkin</a>.</p></p>
  33      <ul class="tags">
  34                  <li><span class="field">since:</span> 3.0</li>
  35                  <li><span class="field">version:</span> $Id: TThemeManager.php 1536 2006-12-01 19:51:21Z xue $</li>
  36                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  37              </ul>
  38          <p class="notes">
  39              Located in <a class="field" href="_Web_UI_TThemeManager_php.html">/Web/UI/TThemeManager.php</a> (line <span class="field">189</span>)
  40          </p>
  41          
  42                  
  43          <pre><a href="../System/TComponent.html">TComponent</a>
  44     |
  45     --<a href="../System/TApplicationComponent.html">TApplicationComponent</a>
  46        |
  47        --TTheme</pre>
  48      
  49              </div>
  50  </div>
  51  
  52  
  53      <a name="sec-const-summary"></a>
  54      <div class="info-box">
  55          <div class="info-box-title">Class Constant Summary</span></div>
  56          <div class="nav-bar">
  57              <a href="#sec-description">Description</a> |
  58                          <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
  59                                          | 
  60                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  61                              
  62                      </div>
  63          <div class="info-box-body">
  64              <div class="const-summary">
  65                                  <div class="const-title">
  66                      <img src="../media/images/Constant.png" alt=" " />
  67                      <a href="#SKIN_FILE_EXT" title="details" class="const-name">SKIN_FILE_EXT</a> =                     <span class="var-type">'.skin'</span>
  68  
  69                  </div>
  70                                  <div class="const-title">
  71                      <img src="../media/images/Constant.png" alt=" " />
  72                      <a href="#THEME_CACHE_PREFIX" title="details" class="const-name">THEME_CACHE_PREFIX</a> =                     <span class="var-type">'prado:theme:'</span>
  73  
  74                  </div>
  75                              </div>
  76          </div>
  77      </div>
  78  
  79  
  80      <a name="sec-method-summary"></a>
  81      <div class="info-box">
  82          <div class="info-box-title">Method Summary</span></div>
  83          <div class="nav-bar">
  84              <a href="#sec-description">Description</a> |
  85                                                              <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  86                              
  87                                      <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  88          </div>
  89          <div class="info-box-body">            
  90              <div class="method-summary">
  91                                  
  92                  <div class="method-definition">
  93                                              <span class="method-result">TTheme</span>
  94                                          <a href="#__construct" title="details" class="method-name">__construct</a>
  95                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$themePath</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$themeUrl</span>)
  96                                      </div>
  97                                  
  98                  <div class="method-definition">
  99                                              <span class="method-result">boolean</span>
 100                                          <a href="#applySkin" title="details" class="method-name">applySkin</a>
 101                                              (<span class="var-type"><a href="../System.Web.UI/TControl.html">TControl</a></span>&nbsp;<span class="var-name">$control</span>)
 102                                      </div>
 103                                  
 104                  <div class="method-definition">
 105                                              <span class="method-result">string</span>
 106                                          <a href="#getBasePath" title="details" class="method-name">getBasePath</a>
 107                                          ()
 108                                      </div>
 109                                  
 110                  <div class="method-definition">
 111                                              <span class="method-result">string</span>
 112                                          <a href="#getBaseUrl" title="details" class="method-name">getBaseUrl</a>
 113                                          ()
 114                                      </div>
 115                                  
 116                  <div class="method-definition">
 117                                              <span class="method-result">array</span>
 118                                          <a href="#getJavaScriptFiles" title="details" class="method-name">getJavaScriptFiles</a>
 119                                          ()
 120                                      </div>
 121                                  
 122                  <div class="method-definition">
 123                                              <span class="method-result">string</span>
 124                                          <a href="#getName" title="details" class="method-name">getName</a>
 125                                          ()
 126                                      </div>
 127                                  
 128                  <div class="method-definition">
 129                                              <span class="method-result">array</span>
 130                                          <a href="#getStyleSheetFiles" title="details" class="method-name">getStyleSheetFiles</a>
 131                                          ()
 132                                      </div>
 133                              </div>
 134          </div>
 135      </div>        
 136  
 137      
 138      <a name="sec-methods"></a>
 139      <div class="info-box">
 140          <div class="info-box-title">Methods</div>
 141          <div class="nav-bar">
 142              <a href="#sec-description">Description</a> |
 143                                                                          <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
 144                              
 145                                          <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 146                          
 147          </div>
 148          <div class="info-box-body">
 149              <A NAME='method_detail'></A>
 150  <a name="method__construct" id="__construct"><!-- --></a>
 151  <div class="evenrow">
 152      
 153      <div class="method-header">
 154          <span class="method-title">Constructor __construct</span> (line <span class="line-number">230</span>)
 155      </div> 
 156      
 157      <!-- ========== Info from phpDoc block ========= -->
 158  <p class="short-description">Constructor.</p>
 159      <ul class="tags">
 160                  <li><span class="field">access:</span> public</li>
 161                  <li><span class="field">throws:</span> TConfigurationException if theme path does not exist or any parsing error of the skin files</li>
 162              </ul>
 163      
 164      <div class="method-signature">
 165          <span class="method-result">TTheme</span>
 166          <span class="method-name">
 167              __construct
 168          </span>
 169                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$themePath</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$themeUrl</span>)
 170              </div>
 171      
 172              <ul class="parameters">
 173                      <li>
 174                  <span class="var-type">string</span>
 175                  <span class="var-name">$themePath</span><span class="var-description">: theme path</span>            </li>
 176                      <li>
 177                  <span class="var-type">string</span>
 178                  <span class="var-name">$themeUrl</span><span class="var-description">: theme URL</span>            </li>
 179                  </ul>
 180          
 181          
 182      </div>
 183  <a name="methodapplySkin" id="applySkin"><!-- --></a>
 184  <div class="oddrow">
 185      
 186      <div class="method-header">
 187          <span class="method-title">applySkin</span> (line <span class="line-number">356</span>)
 188      </div> 
 189      
 190      <!-- ========== Info from phpDoc block ========= -->
 191  <p class="short-description">Applies the theme to a particular control.</p>
 192  <p class="description"><p>The control's class name and SkinID value will be used to  identify which skin to be applied. If the control's SkinID is empty,  the default skin will be applied.</p></p>
 193      <ul class="tags">
 194                  <li><span class="field">return:</span> if a skin is successfully applied</li>
 195                  <li><span class="field">access:</span> public</li>
 196                  <li><span class="field">throws:</span> TConfigurationException if any error happened during the skin application</li>
 197              </ul>
 198      
 199      <div class="method-signature">
 200          <span class="method-result">boolean</span>
 201          <span class="method-name">
 202              applySkin
 203          </span>
 204                      (<span class="var-type"><a href="../System.Web.UI/TControl.html">TControl</a></span>&nbsp;<span class="var-name">$control</span>)
 205              </div>
 206      
 207              <ul class="parameters">
 208                      <li>
 209                  <span class="var-type"><a href="../System.Web.UI/TControl.html">TControl</a></span>
 210                  <span class="var-name">$control</span><span class="var-description">: the control to be applied with a skin</span>            </li>
 211                  </ul>
 212          
 213          
 214      </div>
 215  <a name="methodgetBasePath" id="getBasePath"><!-- --></a>
 216  <div class="evenrow">
 217      
 218      <div class="method-header">
 219          <span class="method-title">getBasePath</span> (line <span class="line-number">342</span>)
 220      </div> 
 221      
 222      <!-- ========== Info from phpDoc block ========= -->
 223      <ul class="tags">
 224                  <li><span class="field">return:</span> the file path to the theme folder</li>
 225                  <li><span class="field">access:</span> public</li>
 226              </ul>
 227      
 228      <div class="method-signature">
 229          <span class="method-result">string</span>
 230          <span class="method-name">
 231              getBasePath
 232          </span>
 233                  ()
 234              </div>
 235      
 236          
 237          
 238      </div>
 239  <a name="methodgetBaseUrl" id="getBaseUrl"><!-- --></a>
 240  <div class="oddrow">
 241      
 242      <div class="method-header">
 243          <span class="method-title">getBaseUrl</span> (line <span class="line-number">334</span>)
 244      </div> 
 245      
 246      <!-- ========== Info from phpDoc block ========= -->
 247      <ul class="tags">
 248                  <li><span class="field">return:</span> the URL to the theme folder (without ending slash)</li>
 249                  <li><span class="field">access:</span> public</li>
 250              </ul>
 251      
 252      <div class="method-signature">
 253          <span class="method-result">string</span>
 254          <span class="method-name">
 255              getBaseUrl
 256          </span>
 257                  ()
 258              </div>
 259      
 260          
 261          
 262      </div>
 263  <a name="methodgetJavaScriptFiles" id="getJavaScriptFiles"><!-- --></a>
 264  <div class="evenrow">
 265      
 266      <div class="method-header">
 267          <span class="method-title">getJavaScriptFiles</span> (line <span class="line-number">431</span>)
 268      </div> 
 269      
 270      <!-- ========== Info from phpDoc block ========= -->
 271      <ul class="tags">
 272                  <li><span class="field">return:</span> list of Javascript files (URL) in the theme</li>
 273                  <li><span class="field">access:</span> public</li>
 274              </ul>
 275      
 276      <div class="method-signature">
 277          <span class="method-result">array</span>
 278          <span class="method-name">
 279              getJavaScriptFiles
 280          </span>
 281                  ()
 282              </div>
 283      
 284          
 285          
 286      </div>
 287  <a name="methodgetName" id="getName"><!-- --></a>
 288  <div class="oddrow">
 289      
 290      <div class="method-header">
 291          <span class="method-title">getName</span> (line <span class="line-number">326</span>)
 292      </div> 
 293      
 294      <!-- ========== Info from phpDoc block ========= -->
 295      <ul class="tags">
 296                  <li><span class="field">return:</span> theme name</li>
 297                  <li><span class="field">access:</span> public</li>
 298              </ul>
 299      
 300      <div class="method-signature">
 301          <span class="method-result">string</span>
 302          <span class="method-name">
 303              getName
 304          </span>
 305                  ()
 306              </div>
 307      
 308          
 309          
 310      </div>
 311  <a name="methodgetStyleSheetFiles" id="getStyleSheetFiles"><!-- --></a>
 312  <div class="evenrow">
 313      
 314      <div class="method-header">
 315          <span class="method-title">getStyleSheetFiles</span> (line <span class="line-number">423</span>)
 316      </div> 
 317      
 318      <!-- ========== Info from phpDoc block ========= -->
 319      <ul class="tags">
 320                  <li><span class="field">return:</span> list of CSS files (URL) in the theme</li>
 321                  <li><span class="field">access:</span> public</li>
 322              </ul>
 323      
 324      <div class="method-signature">
 325          <span class="method-result">array</span>
 326          <span class="method-name">
 327              getStyleSheetFiles
 328          </span>
 329                  ()
 330              </div>
 331      
 332          
 333          
 334      </div>
 335                              <h4>Inherited Methods</h4>
 336                  <a name='inherited_methods'><!-- --></a>    
 337                                      <!-- =========== Summary =========== -->
 338                      <p>Inherited From <span class="classname"><a href="../System/TApplicationComponent.html">TApplicationComponent</a></span></p>
 339                      <blockquote>
 340                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetApplication">TApplicationComponent::getApplication()</a></span><br>
 341                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetRequest">TApplicationComponent::getRequest()</a></span><br>
 342                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetResponse">TApplicationComponent::getResponse()</a></span><br>
 343                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetService">TApplicationComponent::getService()</a></span><br>
 344                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetSession">TApplicationComponent::getSession()</a></span><br>
 345                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetUser">TApplicationComponent::getUser()</a></span><br>
 346                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishAsset">TApplicationComponent::publishAsset()</a></span><br>
 347                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishFilePath">TApplicationComponent::publishFilePath()</a></span><br>
 348                                              </blockquote>
 349                                      <!-- =========== Summary =========== -->
 350                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 351                      <blockquote>
 352                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 353                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 354                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 355                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 356                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 357                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 358                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 359                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 360                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 361                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 362                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 363                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 364                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 365                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 366                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 367                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 368                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 369                                              </blockquote>
 370                                          
 371          </div>
 372      </div>
 373  
 374      <a name="sec-consts"></a>
 375      <div class="info-box">
 376          <div class="info-box-title">Class Constants</div>
 377          <div class="nav-bar">
 378              <a href="#sec-description">Description</a> |
 379                                          <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
 380                          
 381              
 382                                          | 
 383                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 384                              
 385                      </div>
 386          <div class="info-box-body">
 387              <a name="constSKIN_FILE_EXT" id="SKIN_FILE_EXT"><!-- --></A>
 388  <div class="oddrow">
 389  
 390      <div class="const-header">
 391          <img src="../media/images/Variable.png" />
 392          <span class="const-title">
 393              <span class="const-name">SKIN_FILE_EXT</span>
 394               = <span class="const-default">'.skin'</span>
 395              (line <span class="line-number">198</span>)
 396          </span>
 397      </div>
 398  
 399      <!-- ========== Info from phpDoc block ========= -->
 400  <p class="short-description">Extension name of skin files</p>
 401      
 402      
 403  </div>
 404  <a name="constTHEME_CACHE_PREFIX" id="THEME_CACHE_PREFIX"><!-- --></A>
 405  <div class="evenrow">
 406  
 407      <div class="const-header">
 408          <img src="../media/images/Variable.png" />
 409          <span class="const-title">
 410              <span class="const-name">THEME_CACHE_PREFIX</span>
 411               = <span class="const-default">'prado:theme:'</span>
 412              (line <span class="line-number">194</span>)
 413          </span>
 414      </div>
 415  
 416      <!-- ========== Info from phpDoc block ========= -->
 417  <p class="short-description">prefix for cache variable name used to store parsed themes</p>
 418      
 419      
 420  </div>
 421  
                        
 422          </div>
 423      </div>
 424  
 425      <p class="notes" id="credit">
 426          Documentation generated on Mon, 04 Dec 2006 11:27:45 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 427      </p>
 428      </div></body>
 429  </html>