[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 TClientSideOptions</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 TClientSideOptions</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-descendents">Descendents</a>
  20              |                                                    <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  21                          
  22                      </div>
  23      <div class="info-box-body">
  24                  <!-- ========== Info from phpDoc block ========= -->
  25  <p class="short-description">TClientSideOptions abstract class.</p>
  26  <p class="description"><p>TClientSideOptions manages client-side options for components that have  common client-side javascript behaviours and client-side events such as  between ActiveControls and validators.</p></p>
  27      <ul class="tags">
  28                  <li><span class="field">abstract:</span> </li>
  29                  <li><span class="field">since:</span> 3.0</li>
  30                  <li><span class="field">version:</span> $Id: TClientScriptManager.php 1397 2006-09-07 07:55:53Z wei $</li>
  31                  <li><span class="field">author:</span> &lt;<a href="mailto:weizhuo[at]gmail[dot]com">weizhuo[at]gmail[dot]com</a>&gt;</li>
  32              </ul>
  33          <p class="notes">
  34              Located in <a class="field" href="_Web_UI_TClientScriptManager_php.html">/Web/UI/TClientScriptManager.php</a> (line <span class="field">510</span>)
  35          </p>
  36          
  37                  
  38          <pre><a href="../System/TComponent.html">TComponent</a>
  39     |
  40     --TClientSideOptions</pre>
  41      
  42              </div>
  43  </div>
  44  
  45      <a name="sec-descendents"></a>
  46      <div class="info-box">
  47          <div class="info-box-title">Direct descendents</div>
  48          <div class="nav-bar">
  49              <a href="#sec-description">Description</a> |
  50              <span class="disabled">Descendents</span>
  51              |                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  52                              
  53                                  </div>
  54          <div class="info-box-body">
  55              <table cellpadding="2" cellspacing="0" class="class-table">
  56                  <tr>
  57                      <th class="class-table-header">Class</th>
  58                      <th class="class-table-header">Description</th>
  59                  </tr>
  60                                  <tr>
  61                      <td style="padding-right: 2em"><a href="../System.Web.UI.WebControls/TValidatorClientSide.html">TValidatorClientSide</a></td>
  62                      <td>
  63                                              TValidatorClientSide class.
  64                                          </td>
  65                  </tr>
  66                                  <tr>
  67                      <td style="padding-right: 2em"><a href="../System.Web.UI.WebControls/TDatePickerClientScript.html">TDatePickerClientScript</a></td>
  68                      <td>
  69                                              TDatePickerClientScript class.
  70                                          </td>
  71                  </tr>
  72                                  <tr>
  73                      <td style="padding-right: 2em"><a href="../System.Web.UI.WebControls/TValidationSummaryClientScript.html">TValidationSummaryClientScript</a></td>
  74                      <td>
  75                                              TValidationSummaryClientScript class.
  76                                          </td>
  77                  </tr>
  78                              </table>
  79          </div>
  80      </div>
  81  
  82  
  83  
  84      <a name="sec-method-summary"></a>
  85      <div class="info-box">
  86          <div class="info-box-title">Method Summary</span></div>
  87          <div class="nav-bar">
  88              <a href="#sec-description">Description</a> |
  89                              <a href="#sec-descendents">Descendents</a> |
  90                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  91          </div>
  92          <div class="info-box-body">            
  93              <div class="method-summary">
  94                                  
  95                  <div class="method-definition">
  96                                              <span class="method-result">TClientSideOptions</span>
  97                                          <a href="#__construct" title="details" class="method-name">__construct</a>
  98                                          ()
  99                                      </div>
 100                                  
 101                  <div class="method-definition">
 102                                              <span class="method-result">void</span>
 103                                          <a href="#ensureFunction" title="details" class="method-name">ensureFunction</a>
 104                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$javascript</span>)
 105                                      </div>
 106                                  
 107                  <div class="method-definition">
 108                                              <span class="method-result">string</span>
 109                                          <a href="#getOption" title="details" class="method-name">getOption</a>
 110                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span>)
 111                                      </div>
 112                                  
 113                  <div class="method-definition">
 114                                              <span class="method-result"><a href="../System.Collections/TMap.html">TMap</a></span>
 115                                          <a href="#getOptions" title="details" class="method-name">getOptions</a>
 116                                          ()
 117                                      </div>
 118                                  
 119                  <div class="method-definition">
 120                                              <span class="method-result">void</span>
 121                                          <a href="#setFunction" title="details" class="method-name">setFunction</a>
 122                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>)
 123                                      </div>
 124                                  
 125                  <div class="method-definition">
 126                                              <span class="method-result">void</span>
 127                                          <a href="#setOption" title="details" class="method-name">setOption</a>
 128                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
 129                                      </div>
 130                              </div>
 131          </div>
 132      </div>        
 133  
 134      
 135      <a name="sec-methods"></a>
 136      <div class="info-box">
 137          <div class="info-box-title">Methods</div>
 138          <div class="nav-bar">
 139              <a href="#sec-description">Description</a> |
 140                              <a href="#sec-descendents">Descendents</a> |
 141                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 142                          
 143          </div>
 144          <div class="info-box-body">
 145              <A NAME='method_detail'></A>
 146  <a name="method__construct" id="__construct"><!-- --></a>
 147  <div class="evenrow">
 148      
 149      <div class="method-header">
 150          <span class="method-title">Constructor __construct</span> (line <span class="line-number">520</span>)
 151      </div> 
 152      
 153      <!-- ========== Info from phpDoc block ========= -->
 154  <p class="short-description">Constructor, initialize the options list.</p>
 155      <ul class="tags">
 156                  <li><span class="field">access:</span> public</li>
 157              </ul>
 158      
 159      <div class="method-signature">
 160          <span class="method-result">TClientSideOptions</span>
 161          <span class="method-name">
 162              __construct
 163          </span>
 164                  ()
 165              </div>
 166      
 167          
 168          
 169      </div>
 170  <a name="methodensureFunction" id="ensureFunction"><!-- --></a>
 171  <div class="oddrow">
 172      
 173      <div class="method-header">
 174          <span class="method-title">ensureFunction</span> (line <span class="line-number">569</span>)
 175      </div> 
 176      
 177      <!-- ========== Info from phpDoc block ========= -->
 178  <p class="short-description">Ensure that the javascript statements are wrapped in a javascript  function block as <pre><ol><code><pre><li><span class="src-key">function</span><span class="src-sym">(</span><span class="src-id">sender</span><span class="src-sym">, </span><span class="src-id">parameter</span><span class="src-sym">)</span><span class="src-sym">{ </span><span class="src-comm">//code }</span></li>
 179  </pre></code></ol></pre>.</p>
 180      <ul class="tags">
 181                  <li><span class="field">access:</span> protected</li>
 182              </ul>
 183      
 184      <div class="method-signature">
 185          <span class="method-result">void</span>
 186          <span class="method-name">
 187              ensureFunction
 188          </span>
 189                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$javascript</span>)
 190              </div>
 191      
 192          
 193          
 194      </div>
 195  <a name="methodgetOption" id="getOption"><!-- --></a>
 196  <div class="evenrow">
 197      
 198      <div class="method-header">
 199          <span class="method-title">getOption</span> (line <span class="line-number">543</span>)
 200      </div> 
 201      
 202      <!-- ========== Info from phpDoc block ========= -->
 203      <ul class="tags">
 204                  <li><span class="field">return:</span> gets a particular option, null if not set.</li>
 205                  <li><span class="field">access:</span> protected</li>
 206              </ul>
 207      
 208      <div class="method-signature">
 209          <span class="method-result">string</span>
 210          <span class="method-name">
 211              getOption
 212          </span>
 213                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span>)
 214              </div>
 215      
 216          
 217          
 218      </div>
 219  <a name="methodgetOptions" id="getOptions"><!-- --></a>
 220  <div class="oddrow">
 221      
 222      <div class="method-header">
 223          <span class="method-title">getOptions</span> (line <span class="line-number">560</span>)
 224      </div> 
 225      
 226      <!-- ========== Info from phpDoc block ========= -->
 227      <ul class="tags">
 228                  <li><span class="field">return:</span> gets the list of options as TMap</li>
 229                  <li><span class="field">access:</span> public</li>
 230              </ul>
 231      
 232      <div class="method-signature">
 233          <span class="method-result"><a href="../System.Collections/TMap.html">TMap</a></span>
 234          <span class="method-name">
 235              getOptions
 236          </span>
 237                  ()
 238              </div>
 239      
 240          
 241          
 242      </div>
 243  <a name="methodsetFunction" id="setFunction"><!-- --></a>
 244  <div class="evenrow">
 245      
 246      <div class="method-header">
 247          <span class="method-title">setFunction</span> (line <span class="line-number">533</span>)
 248      </div> 
 249      
 250      <!-- ========== Info from phpDoc block ========= -->
 251  <p class="short-description">Adds on client-side event handler by wrapping the code within a  javascript function block. If the code begins with &quot;javascript:&quot;, the  code is assumed to be a javascript function block rather than arbiturary  javascript statements.</p>
 252      <ul class="tags">
 253                  <li><span class="field">access:</span> protected</li>
 254              </ul>
 255      
 256      <div class="method-signature">
 257          <span class="method-result">void</span>
 258          <span class="method-name">
 259              setFunction
 260          </span>
 261                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>)
 262              </div>
 263      
 264              <ul class="parameters">
 265                      <li>
 266                  <span class="var-type">string</span>
 267                  <span class="var-name">$name</span><span class="var-description">: option name</span>            </li>
 268                      <li>
 269                  <span class="var-type">string</span>
 270                  <span class="var-name">$code</span><span class="var-description">: javascript statements.</span>            </li>
 271                  </ul>
 272          
 273          
 274      </div>
 275  <a name="methodsetOption" id="setOption"><!-- --></a>
 276  <div class="oddrow">
 277      
 278      <div class="method-header">
 279          <span class="method-title">setOption</span> (line <span class="line-number">552</span>)
 280      </div> 
 281      
 282      <!-- ========== Info from phpDoc block ========= -->
 283      <ul class="tags">
 284                  <li><span class="field">access:</span> protected</li>
 285              </ul>
 286      
 287      <div class="method-signature">
 288          <span class="method-result">void</span>
 289          <span class="method-name">
 290              setOption
 291          </span>
 292                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
 293              </div>
 294      
 295              <ul class="parameters">
 296                      <li>
 297                  <span class="var-type">string</span>
 298                  <span class="var-name">$name</span><span class="var-description">: option name</span>            </li>
 299                      <li>
 300                  <span class="var-type">mixed</span>
 301                  <span class="var-name">$value</span><span class="var-description">: option value.</span>            </li>
 302                  </ul>
 303          
 304          
 305      </div>
 306                              <h4>Inherited Methods</h4>
 307                  <a name='inherited_methods'><!-- --></a>    
 308                                      <!-- =========== Summary =========== -->
 309                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 310                      <blockquote>
 311                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 312                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 313                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 314                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 315                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 316                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 317                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 318                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 319                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 320                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 321                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 322                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 323                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 324                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 325                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 326                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 327                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 328                                              </blockquote>
 329                                          
 330          </div>
 331      </div>
 332  
 333  
 334      <p class="notes" id="credit">
 335          Documentation generated on Mon, 04 Dec 2006 11:26:07 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 336      </p>
 337      </div></body>
 338  </html>