yui/docs/YAHOO.util.Config.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4         <title>API: container  YAHOO.util.Config   (YUI Library)</title>
   5         <link rel="stylesheet" type="text/css" href="assets/api.css">
   6 </head>
   7
   8 <body id="yahoo-com">
   9 <div id="doc3" class="yui-t2">
  10
  11         <div id="hd">
  12         <h1>Yahoo! UI Library</h1>
  13         <h3>Container&nbsp; <span class="subtitle">2.2.0</span></h3>
  14         <p>
  15         <a href="./index.html">Yahoo! UI Library</a>
  16             &gt; <a href="./module_container.html">container</a>
  17                  &gt; YAHOO.util.Config
  18
  19             </p>
  20         </div>
  21
  22         <div id="bd">
  23                 <div id="yui-main">
  24                         <div class="yui-b">
  25
  26
  27                     <h2>
  28
  29
  30
  31
  32                             Class <b>YAHOO.util.Config</b>
  33                         <span class="extends">
  34                         </span>
  35
  36                         <span class="extends">
  37                         </span>
  38
  39                         </code>
  40                     </h2>
  41                     <!-- class tree goes here -->
  42
  43
  44
  45
  46                     <div class="summary description">
  47                         Config is a utility used within an Object to allow the implementer to maintain a list of local configuration properties and listen for changes to those properties dynamically using CustomEvent. The initial values are also maintained so that the configuration can be reset at any given point to its initial state.
  48                     </div>
  49
  50                         <div class="section constructor details">
  51                         <h3><a name="constructor_detail">Constructor</a></h3>
  52                         <div class="content">
  53                             <div class="detail">
  54                                 <strong>YAHOO.util.Config</strong>
  55                                 <code>
  56                                     (
  57
  58
  59
  60                                                 owner
  61                                     )
  62                                 </code>
  63                                 <div class="description">
  64                                         <dl>
  65                                             <dt>Parameters:</dt>
  66                                                 <dd>
  67                                                     <code>owner
  68                                                     &lt;Object&gt;
  69                                                     </code>
  70                                                         The owner Object to which this Config Object belongs
  71                                                 </dd>
  72                                         </dl>
  73
  74
  75                                 </div>
  76                             </div>
  77                         </div>
  78                     </div>
  79
  80                         <div class="section field details">
  81                             <h3><a name="field_detail">Properties</a></h3>
  82                             <div class="content">
  83                                     <h4><a name="config">config</a>
  84                                         <code>- private Object</code>
  85                                     </h4>
  86                                     <div class="detail">
  87                                         <div class="description">
  88                                             Maintains the local collection of configuration property objects and their specified values
  89                                         </div>
  90                                     </div>
  91
  92
  93
  94
  95                                     <hr />
  96                                     <h4><a name="eventQueue">eventQueue</a>
  97                                         <code>- private Object</code>
  98                                     </h4>
  99                                     <div class="detail">
 100                                         <div class="description">
 101                                             Maintains the local, normalized CustomEvent queue
 102                                         </div>
 103                                     </div>
 104
 105
 106
 107
 108                                     <hr />
 109                                     <h4><a name="initialConfig">initialConfig</a>
 110                                         <code>- private Object</code>
 111                                     </h4>
 112                                     <div class="detail">
 113                                         <div class="description">
 114                                             Maintains the local collection of configuration property objects as they were initially applied.
 115 This object is used when resetting a property.
 116                                         </div>
 117                                     </div>
 118
 119
 120
 121
 122                                     <hr />
 123                                     <h4><a name="owner">owner</a>
 124                                         <code>- Object</code>
 125                                     </h4>
 126                                     <div class="detail">
 127                                         <div class="description">
 128                                             Object reference to the owner of this Config Object
 129                                         </div>
 130                                     </div>
 131
 132
 133
 134
 135                                     <hr />
 136                                     <h4><a name="queueInProgress">queueInProgress</a>
 137                                         <code>- Boolean</code>
 138                                     </h4>
 139                                     <div class="detail">
 140                                         <div class="description">
 141                                             Boolean flag that specifies whether a queue is currently being executed
 142                                         </div>
 143                                     </div>
 144
 145
 146
 147
 148                                     <hr />
 149
 150
 151                             </div>
 152                         </div>
 153
 154
 155                         <div class="section method details">
 156                             <h3><a name="methodDetails">Methods</a></h3>
 157                             <div class="content">
 158                                     <h4>
 159                                         <a name="addProperty">addProperty</a></h4>
 160                                     <div class="detail">
 161                                         <code>
 162
 163
 164
 165                                         void
 166                                             <strong>addProperty</strong>
 167                                            (
 168
 169
 170                                                          key
 171
 172
 173                                                         ,
 174                                                          propertyObject
 175
 176
 177                                             )
 178                                         </code>
 179
 180                                         <div class="description">
 181                                             Adds a property to the Config Object's private config hash.
 182                                         </div>
 183
 184                                         <div class="description">
 185
 186                                                 <dl>
 187                                                     <dt>Parameters:</dt>
 188                                                         <dd>
 189                                                             <code>key &lt;String&gt;</code>
 190                                                                 The configuration property's name
 191                                                         </dd>
 192                                                         <dd>
 193                                                             <code>propertyObject &lt;Object&gt;</code>
 194                                                                 The Object containing all of this property's arguments
 195                                                         </dd>
 196                                                 </dl>
 197
 198                                                 <dl>
 199                                                     <dt>Returns:
 200                                                     <code>
 201                                                         void
 202                                                     </code></dt>
 203                                                     <dd></dd>
 204                                                 </dl>
 205
 206                                         </div>
 207
 208                                     </div>
 209                                     <hr />
 210                                     <h4>
 211                                         <a name="applyConfig">applyConfig</a></h4>
 212                                     <div class="detail">
 213                                         <code>
 214
 215
 216
 217                                         void
 218                                             <strong>applyConfig</strong>
 219                                            (
 220
 221
 222                                                          userConfig
 223
 224
 225                                                         ,
 226                                                          init
 227
 228
 229                                             )
 230                                         </code>
 231
 232                                         <div class="description">
 233                                             Applies a key-value Object literal to the configuration, replacing any existing values, and queueing the property events.
 234 Although the values will be set, fireQueue() must be called for their associated events to execute.
 235                                         </div>
 236
 237                                         <div class="description">
 238
 239                                                 <dl>
 240                                                     <dt>Parameters:</dt>
 241                                                         <dd>
 242                                                             <code>userConfig &lt;Object&gt;</code>
 243                                                                 The configuration Object literal
 244                                                         </dd>
 245                                                         <dd>
 246                                                             <code>init &lt;Boolean&gt;</code>
 247                                                                         When set to true, the initialConfig will be set to the userConfig passed in, so that calling a reset will reset the properties to the passed values.
 248                                                         </dd>
 249                                                 </dl>
 250
 251                                                 <dl>
 252                                                     <dt>Returns:
 253                                                     <code>
 254                                                         void
 255                                                     </code></dt>
 256                                                     <dd></dd>
 257                                                 </dl>
 258
 259                                         </div>
 260
 261                                     </div>
 262                                     <hr />
 263                                     <h4>
 264                                         <a name="checkBoolean">checkBoolean</a></h4>
 265                                     <div class="detail">
 266                                         <code>
 267
 268
 269
 270                                         Boolean
 271                                             <strong>checkBoolean</strong>
 272                                            (
 273
 274
 275                                                          val
 276
 277
 278                                             )
 279                                         </code>
 280
 281                                         <div class="description">
 282                                             Validates that the value passed in is a Boolean.
 283                                         </div>
 284
 285                                         <div class="description">
 286
 287                                                 <dl>
 288                                                     <dt>Parameters:</dt>
 289                                                         <dd>
 290                                                             <code>val &lt;Object&gt;</code>
 291                                                                 The value to validate
 292                                                         </dd>
 293                                                 </dl>
 294
 295                                                 <dl>
 296                                                     <dt>Returns:
 297                                                     <code>
 298                                                         Boolean
 299                                                     </code></dt>
 300                                                     <dd>true, if the value is valid</dd>
 301                                                 </dl>
 302
 303                                         </div>
 304
 305                                     </div>
 306                                     <hr />
 307                                     <h4>
 308                                         <a name="checkNumber">checkNumber</a></h4>
 309                                     <div class="detail">
 310                                         <code>
 311
 312
 313
 314                                         Boolean
 315                                             <strong>checkNumber</strong>
 316                                            (
 317
 318
 319                                                          val
 320
 321
 322                                             )
 323                                         </code>
 324
 325                                         <div class="description">
 326                                             Validates that the value passed in is a number.
 327                                         </div>
 328
 329                                         <div class="description">
 330
 331                                                 <dl>
 332                                                     <dt>Parameters:</dt>
 333                                                         <dd>
 334                                                             <code>val &lt;Object&gt;</code>
 335                                                                 The value to validate
 336                                                         </dd>
 337                                                 </dl>
 338
 339                                                 <dl>
 340                                                     <dt>Returns:
 341                                                     <code>
 342                                                         Boolean
 343                                                     </code></dt>
 344                                                     <dd>true, if the value is valid</dd>
 345                                                 </dl>
 346
 347                                         </div>
 348
 349                                     </div>
 350                                     <hr />
 351                                     <h4>
 352                                         <a name="fireEvent">fireEvent</a></h4>
 353                                     <div class="detail">
 354                                         <code>
 355                                          private
 356
 357
 358                                         void
 359                                             <strong>fireEvent</strong>
 360                                            (
 361
 362
 363                                                          key
 364
 365
 366                                                         ,
 367                                                          Object
 368
 369
 370                                             )
 371                                         </code>
 372
 373                                         <div class="description">
 374                                             Fires a configuration property event using the specified value.
 375                                         </div>
 376
 377                                         <div class="description">
 378
 379                                                 <dl>
 380                                                     <dt>Parameters:</dt>
 381                                                         <dd>
 382                                                             <code>key &lt;String&gt;</code>
 383                                                                                 The configuration property's name
 384                                                         </dd>
 385                                                         <dd>
 386                                                             <code>Object &lt;value&gt;</code>
 387                                                                         The value of the correct type for the property
 388                                                         </dd>
 389                                                 </dl>
 390
 391                                                 <dl>
 392                                                     <dt>Returns:
 393                                                     <code>
 394                                                         void
 395                                                     </code></dt>
 396                                                     <dd></dd>
 397                                                 </dl>
 398
 399                                         </div>
 400
 401                                     </div>
 402                                     <hr />
 403                                     <h4>
 404                                         <a name="fireQueue">fireQueue</a></h4>
 405                                     <div class="detail">
 406                                         <code>
 407
 408
 409
 410                                         void
 411                                             <strong>fireQueue</strong>
 412                                            (
 413                                             )
 414                                         </code>
 415
 416                                         <div class="description">
 417                                             Fires the normalized list of queued property change events
 418                                         </div>
 419
 420                                         <div class="description">
 421
 422
 423                                                 <dl>
 424                                                     <dt>Returns:
 425                                                     <code>
 426                                                         void
 427                                                     </code></dt>
 428                                                     <dd></dd>
 429                                                 </dl>
 430
 431                                         </div>
 432
 433                                     </div>
 434                                     <hr />
 435                                     <h4>
 436                                         <a name="getConfig">getConfig</a></h4>
 437                                     <div class="detail">
 438                                         <code>
 439
 440
 441
 442                                         Object
 443                                             <strong>getConfig</strong>
 444                                            (
 445                                             )
 446                                         </code>
 447
 448                                         <div class="description">
 449                                             Returns a key-value configuration map of the values currently set in the Config Object.
 450                                         </div>
 451
 452                                         <div class="description">
 453
 454
 455                                                 <dl>
 456                                                     <dt>Returns:
 457                                                     <code>
 458                                                         Object
 459                                                     </code></dt>
 460                                                     <dd>The current config, represented in a key-value map</dd>
 461                                                 </dl>
 462
 463                                         </div>
 464
 465                                     </div>
 466                                     <hr />
 467                                     <h4>
 468                                         <a name="getProperty">getProperty</a></h4>
 469                                     <div class="detail">
 470                                         <code>
 471
 472
 473
 474                                         Object
 475                                             <strong>getProperty</strong>
 476                                            (
 477
 478
 479                                                          key
 480
 481
 482                                             )
 483                                         </code>
 484
 485                                         <div class="description">
 486                                             Returns the value of specified property.
 487                                         </div>
 488
 489                                         <div class="description">
 490
 491                                                 <dl>
 492                                                     <dt>Parameters:</dt>
 493                                                         <dd>
 494                                                             <code>key &lt;String&gt;</code>
 495                                                                 The name of the property
 496                                                         </dd>
 497                                                 </dl>
 498
 499                                                 <dl>
 500                                                     <dt>Returns:
 501                                                     <code>
 502                                                         Object
 503                                                     </code></dt>
 504                                                     <dd>The value of the specified property</dd>
 505                                                 </dl>
 506
 507                                         </div>
 508
 509                                     </div>
 510                                     <hr />
 511                                     <h4>
 512                                         <a name="init">init</a></h4>
 513                                     <div class="detail">
 514                                         <code>
 515
 516
 517
 518                                         void
 519                                             <strong>init</strong>
 520                                            (
 521
 522
 523                                                          owner
 524
 525
 526                                             )
 527                                         </code>
 528
 529                                         <div class="description">
 530                                             Initializes the configuration Object and all of its local members.
 531                                         </div>
 532
 533                                         <div class="description">
 534
 535                                                 <dl>
 536                                                     <dt>Parameters:</dt>
 537                                                         <dd>
 538                                                             <code>owner &lt;Object&gt;</code>
 539                                                                 The owner Object to which this Config Object belongs
 540                                                         </dd>
 541                                                 </dl>
 542
 543                                                 <dl>
 544                                                     <dt>Returns:
 545                                                     <code>
 546                                                         void
 547                                                     </code></dt>
 548                                                     <dd></dd>
 549                                                 </dl>
 550
 551                                         </div>
 552
 553                                     </div>
 554                                     <hr />
 555                                     <h4>
 556                                         <a name="outputEventQueue">outputEventQueue</a></h4>
 557                                     <div class="detail">
 558                                         <code>
 559
 560
 561
 562                                         String
 563                                             <strong>outputEventQueue</strong>
 564                                            (
 565                                             )
 566                                         </code>
 567
 568                                         <div class="description">
 569                                             Returns a string representation of the Config object's current CustomEvent queue
 570                                         </div>
 571
 572                                         <div class="description">
 573
 574
 575                                                 <dl>
 576                                                     <dt>Returns:
 577                                                     <code>
 578                                                         String
 579                                                     </code></dt>
 580                                                     <dd>The string list of CustomEvents currently queued for execution</dd>
 581                                                 </dl>
 582
 583                                         </div>
 584
 585                                     </div>
 586                                     <hr />
 587                                     <h4>
 588                                         <a name="queueProperty">queueProperty</a></h4>
 589                                     <div class="detail">
 590                                         <code>
 591
 592
 593
 594                                         Boolean
 595                                             <strong>queueProperty</strong>
 596                                            (
 597
 598
 599                                                          key
 600
 601
 602                                                         ,
 603                                                          value
 604
 605
 606                                             )
 607                                         </code>
 608
 609                                         <div class="description">
 610                                             Sets the value of a property and queues its event to execute. If the event is already scheduled to execute, it is
 611 moved from its current position to the end of the queue.
 612                                         </div>
 613
 614                                         <div class="description">
 615
 616                                                 <dl>
 617                                                     <dt>Parameters:</dt>
 618                                                         <dd>
 619                                                             <code>key &lt;String&gt;</code>
 620                                                                 The name of the property
 621                                                         </dd>
 622                                                         <dd>
 623                                                             <code>value &lt;String&gt;</code>
 624                                                                 The value to set the property to
 625                                                         </dd>
 626                                                 </dl>
 627
 628                                                 <dl>
 629                                                     <dt>Returns:
 630                                                     <code>
 631                                                         Boolean
 632                                                     </code></dt>
 633                                                     <dd>true, if the set was successful, false if it failed.</dd>
 634                                                 </dl>
 635
 636                                         </div>
 637
 638                                     </div>
 639                                     <hr />
 640                                     <h4>
 641                                         <a name="refireEvent">refireEvent</a></h4>
 642                                     <div class="detail">
 643                                         <code>
 644
 645
 646
 647                                         void
 648                                             <strong>refireEvent</strong>
 649                                            (
 650
 651
 652                                                          key
 653
 654
 655                                             )
 656                                         </code>
 657
 658                                         <div class="description">
 659                                             Fires the event for a property using the property's current value.
 660                                         </div>
 661
 662                                         <div class="description">
 663
 664                                                 <dl>
 665                                                     <dt>Parameters:</dt>
 666                                                         <dd>
 667                                                             <code>key &lt;String&gt;</code>
 668                                                                 The name of the property
 669                                                         </dd>
 670                                                 </dl>
 671
 672                                                 <dl>
 673                                                     <dt>Returns:
 674                                                     <code>
 675                                                         void
 676                                                     </code></dt>
 677                                                     <dd></dd>
 678                                                 </dl>
 679
 680                                         </div>
 681
 682                                     </div>
 683                                     <hr />
 684                                     <h4>
 685                                         <a name="refresh">refresh</a></h4>
 686                                     <div class="detail">
 687                                         <code>
 688
 689
 690
 691                                         void
 692                                             <strong>refresh</strong>
 693                                            (
 694                                             )
 695                                         </code>
 696
 697                                         <div class="description">
 698                                             Refires the events for all configuration properties using their current values.
 699                                         </div>
 700
 701                                         <div class="description">
 702
 703
 704                                                 <dl>
 705                                                     <dt>Returns:
 706                                                     <code>
 707                                                         void
 708                                                     </code></dt>
 709                                                     <dd></dd>
 710                                                 </dl>
 711
 712                                         </div>
 713
 714                                     </div>
 715                                     <hr />
 716                                     <h4>
 717                                         <a name="resetProperty">resetProperty</a></h4>
 718                                     <div class="detail">
 719                                         <code>
 720
 721
 722
 723                                         Boolean
 724                                             <strong>resetProperty</strong>
 725                                            (
 726
 727
 728                                                          key
 729
 730
 731                                             )
 732                                         </code>
 733
 734                                         <div class="description">
 735                                             Resets the specified property's value to its initial value.
 736                                         </div>
 737
 738                                         <div class="description">
 739
 740                                                 <dl>
 741                                                     <dt>Parameters:</dt>
 742                                                         <dd>
 743                                                             <code>key &lt;String&gt;</code>
 744                                                                 The name of the property
 745                                                         </dd>
 746                                                 </dl>
 747
 748                                                 <dl>
 749                                                     <dt>Returns:
 750                                                     <code>
 751                                                         Boolean
 752                                                     </code></dt>
 753                                                     <dd>True is the property was reset, false if not</dd>
 754                                                 </dl>
 755
 756                                         </div>
 757
 758                                     </div>
 759                                     <hr />
 760                                     <h4>
 761                                         <a name="setProperty">setProperty</a></h4>
 762                                     <div class="detail">
 763                                         <code>
 764
 765
 766
 767                                         Boolean
 768                                             <strong>setProperty</strong>
 769                                            (
 770
 771
 772                                                          key
 773
 774
 775                                                         ,
 776                                                          value
 777
 778
 779                                                         ,
 780                                                          silent
 781
 782
 783                                             )
 784                                         </code>
 785
 786                                         <div class="description">
 787                                             Sets the value of a property. If the silent property is passed as true, the property's event will not be fired.
 788                                         </div>
 789
 790                                         <div class="description">
 791
 792                                                 <dl>
 793                                                     <dt>Parameters:</dt>
 794                                                         <dd>
 795                                                             <code>key &lt;String&gt;</code>
 796                                                                         The name of the property
 797                                                         </dd>
 798                                                         <dd>
 799                                                             <code>value &lt;String&gt;</code>
 800                                                                         The value to set the property to
 801                                                         </dd>
 802                                                         <dd>
 803                                                             <code>silent &lt;Boolean&gt;</code>
 804                                                                 Whether the value should be set silently, without firing the property event.
 805                                                         </dd>
 806                                                 </dl>
 807
 808                                                 <dl>
 809                                                     <dt>Returns:
 810                                                     <code>
 811                                                         Boolean
 812                                                     </code></dt>
 813                                                     <dd>True, if the set was successful, false if it failed.</dd>
 814                                                 </dl>
 815
 816                                         </div>
 817
 818                                     </div>
 819                                     <hr />
 820                                     <h4>
 821                                         <a name="subscribeToConfigEvent">subscribeToConfigEvent</a></h4>
 822                                     <div class="detail">
 823                                         <code>
 824
 825
 826
 827                                         Boolean
 828                                             <strong>subscribeToConfigEvent</strong>
 829                                            (
 830
 831
 832                                                          key
 833
 834
 835                                                         ,
 836                                                          handler
 837
 838
 839                                                         ,
 840                                                          obj
 841
 842
 843                                                         ,
 844                                                          override
 845
 846
 847                                             )
 848                                         </code>
 849
 850                                         <div class="description">
 851                                             Subscribes an external handler to the change event for any given property.
 852                                         </div>
 853
 854                                         <div class="description">
 855
 856                                                 <dl>
 857                                                     <dt>Parameters:</dt>
 858                                                         <dd>
 859                                                             <code>key &lt;String&gt;</code>
 860                                                                                 The property name
 861                                                         </dd>
 862                                                         <dd>
 863                                                             <code>handler &lt;Function&gt;</code>
 864                                                                         The handler function to use subscribe to the property's event
 865                                                         </dd>
 866                                                         <dd>
 867                                                             <code>obj &lt;Object&gt;</code>
 868                                                                                 The Object to use for scoping the event handler (see CustomEvent documentation)
 869                                                         </dd>
 870                                                         <dd>
 871                                                             <code>override &lt;Boolean&gt;</code>
 872                                                                 Optional. If true, will override "this" within the handler to map to the scope Object passed into the method.
 873                                                         </dd>
 874                                                 </dl>
 875
 876                                                 <dl>
 877                                                     <dt>Returns:
 878                                                     <code>
 879                                                         Boolean
 880                                                     </code></dt>
 881                                                     <dd>True, if the subscription was successful, otherwise false.</dd>
 882                                                 </dl>
 883
 884                                         </div>
 885
 886                                     </div>
 887                                     <hr />
 888                                     <h4>
 889                                         <a name="toString">toString</a></h4>
 890                                     <div class="detail">
 891                                         <code>
 892
 893
 894
 895                                         String
 896                                             <strong>toString</strong>
 897                                            (
 898                                             )
 899                                         </code>
 900
 901                                         <div class="description">
 902                                             Returns a string representation of the Config object
 903                                         </div>
 904
 905                                         <div class="description">
 906
 907
 908                                                 <dl>
 909                                                     <dt>Returns:
 910                                                     <code>
 911                                                         String
 912                                                     </code></dt>
 913                                                     <dd>The Config object in string format.</dd>
 914                                                 </dl>
 915
 916                                         </div>
 917
 918                                     </div>
 919                                     <hr />
 920                                     <h4>
 921                                         <a name="unsubscribeFromConfigEvent">unsubscribeFromConfigEvent</a></h4>
 922                                     <div class="detail">
 923                                         <code>
 924
 925
 926
 927                                         Boolean
 928                                             <strong>unsubscribeFromConfigEvent</strong>
 929                                            (
 930
 931
 932                                                          key
 933
 934
 935                                                         ,
 936                                                          handler
 937
 938
 939                                                         ,
 940                                                          obj
 941
 942
 943                                             )
 944                                         </code>
 945
 946                                         <div class="description">
 947                                             Unsubscribes an external handler from the change event for any given property.
 948                                         </div>
 949
 950                                         <div class="description">
 951
 952                                                 <dl>
 953                                                     <dt>Parameters:</dt>
 954                                                         <dd>
 955                                                             <code>key &lt;String&gt;</code>
 956                                                                                 The property name
 957                                                         </dd>
 958                                                         <dd>
 959                                                             <code>handler &lt;Function&gt;</code>
 960                                                                         The handler function to use subscribe to the property's event
 961                                                         </dd>
 962                                                         <dd>
 963                                                             <code>obj &lt;Object&gt;</code>
 964                                                                                 The Object to use for scoping the event handler (see CustomEvent documentation)
 965                                                         </dd>
 966                                                 </dl>
 967
 968                                                 <dl>
 969                                                     <dt>Returns:
 970                                                     <code>
 971                                                         Boolean
 972                                                     </code></dt>
 973                                                     <dd>True, if the unsubscription was successful, otherwise false.</dd>
 974                                                 </dl>
 975
 976                                         </div>
 977
 978                                     </div>
 979                                     <hr />
 980                                     <h4>
 981                                         <a name="YAHOO.util.Config.alreadySubscribed">YAHOO.util.Config.alreadySubscribed</a></h4>
 982                                     <div class="detail">
 983                                         <code>
 984
 985                                          static
 986
 987                                         Boolean
 988                                             <strong>YAHOO.util.Config.alreadySubscribed</strong>
 989                                            (
 990
 991
 992                                                          evt
 993
 994
 995                                                         ,
 996                                                          fn
 997
 998
 999                                                         ,
1000                                                          obj
1001
1002
1003                                             )
1004                                         </code>
1005
1006                                         <div class="description">
1007                                             Checks to determine if a particular function/Object pair are already subscribed to the specified CustomEvent
1008                                         </div>
1009
1010                                         <div class="description">
1011
1012                                                 <dl>
1013                                                     <dt>Parameters:</dt>
1014                                                         <dd>
1015                                                             <code>evt &lt;YAHOO.util.CustomEvent&gt;</code>
1016                                                                 The CustomEvent for which to check the subscriptions
1017                                                         </dd>
1018                                                         <dd>
1019                                                             <code>fn &lt;Function&gt;</code>
1020                                                                 The function to look for in the subscribers list
1021                                                         </dd>
1022                                                         <dd>
1023                                                             <code>obj &lt;Object&gt;</code>
1024                                                                 The execution scope Object for the subscription
1025                                                         </dd>
1026                                                 </dl>
1027
1028                                                 <dl>
1029                                                     <dt>Returns:
1030                                                     <code>
1031                                                         Boolean
1032                                                     </code></dt>
1033                                                     <dd>true, if the function/Object pair is already subscribed to the CustomEvent passed in</dd>
1034                                                 </dl>
1035
1036                                         </div>
1037
1038                                     </div>
1039                                     <hr />
1040                             </div>
1041                         </div>
1042
1043
1044                         <div class="section method details">
1045                             <h3><a name="methodDetails">Events</a></h3>
1046                             <div class="content">
1047                                     <h4>
1048                                         <a name="configChangedEvent">configChangedEvent</a></h4>
1049                                     <div class="detail">
1050                                         <code>
1051
1052
1053
1054                                             <strong>configChangedEvent</strong>
1055
1056                                             (
1057                                             )
1058
1059                                         </code>
1060
1061                                         <div class="description">
1062                                             Object reference to the owner of this Config Object
1063                                         </div>
1064
1065                                         <div class="description">
1066
1067
1068
1069
1070                                         </div>
1071
1072                                     </div>
1073                                     <hr />
1074                             </div>
1075                         </div>
1076
1077
1078
1079
1080
1081                         </div>
1082                 </div>
1083                 <div class="yui-b">
1084             <div class="nav">
1085
1086                     <div class="module">
1087                         <h4>Modules</h4>
1088                         <ul class="content">
1089
1090                                 <li class=""><a href="module_animation.html">animation</a></li>
1091
1092                                 <li class=""><a href="module_autocomplete.html">autocomplete</a></li>
1093
1094                                 <li class=""><a href="module_button.html">button</a></li>
1095
1096                                 <li class=""><a href="module_calendar.html">calendar</a></li>
1097
1098                                 <li class=""><a href="module_connection.html">connection</a></li>
1099
1100                                 <li class="selected"><a href="module_container.html">container</a></li>
1101
1102                                 <li class=""><a href="module_datasource.html">datasource</a></li>
1103
1104                                 <li class=""><a href="module_datatable.html">datatable</a></li>
1105
1106                                 <li class=""><a href="module_dom.html">dom</a></li>
1107
1108                                 <li class=""><a href="module_dragdrop.html">dragdrop</a></li>
1109
1110                                 <li class=""><a href="module_element.html">element</a></li>
1111
1112                                 <li class=""><a href="module_event.html">event</a></li>
1113
1114                                 <li class=""><a href="module_history.html">history</a></li>
1115
1116                                 <li class=""><a href="module_logger.html">logger</a></li>
1117
1118                                 <li class=""><a href="module_menu.html">menu</a></li>
1119
1120                                 <li class=""><a href="module_slider.html">slider</a></li>
1121
1122                                 <li class=""><a href="module_tabview.html">tabview</a></li>
1123
1124                                 <li class=""><a href="module_treeview.html">treeview</a></li>
1125
1126                                 <li class=""><a href="module_yahoo.html">yahoo</a></li>
1127                         </ul>
1128                     </div>
1129
1130                     <div class="module">
1131                         <h4>Classes</h4>
1132                         <ul class="content">
1133                                 <li class="selected"><a href="YAHOO.util.Config.html">YAHOO.util.Config</a></li>
1134                                 <li class=""><a href="YAHOO.util.KeyListener.html">YAHOO.util.KeyListener</a></li>
1135                                 <li class=""><a href="YAHOO.widget.ContainerEffect.html">YAHOO.widget.ContainerEffect</a></li>
1136                                 <li class=""><a href="YAHOO.widget.Dialog.html">YAHOO.widget.Dialog</a></li>
1137                                 <li class=""><a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a></li>
1138                                 <li class=""><a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a></li>
1139                                 <li class=""><a href="YAHOO.widget.OverlayManager.html">YAHOO.widget.OverlayManager</a></li>
1140                                 <li class=""><a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a></li>
1141                                 <li class=""><a href="YAHOO.widget.SimpleDialog.html">YAHOO.widget.SimpleDialog</a></li>
1142                                 <li class=""><a href="YAHOO.widget.Tooltip.html">YAHOO.widget.Tooltip</a></li>
1143                         </ul>
1144                     </div>
1145
1146                     <div class="module">
1147                         <h4>Files</h4>
1148                         <ul class="content">
1149                                 <li class=""><a href="Config.js.html">Config.js</a></li>
1150                                 <li class=""><a href="ContainerEffect.js.html">ContainerEffect.js</a></li>
1151                                 <li class=""><a href="Dialog.js.html">Dialog.js</a></li>
1152                                 <li class=""><a href="KeyListener.js.html">KeyListener.js</a></li>
1153                                 <li class=""><a href="Module.js.html">Module.js</a></li>
1154                                 <li class=""><a href="Overlay.js.html">Overlay.js</a></li>
1155                                 <li class=""><a href="OverlayManager.js.html">OverlayManager.js</a></li>
1156                                 <li class=""><a href="Panel.js.html">Panel.js</a></li>
1157                                 <li class=""><a href="SimpleDialog.js.html">SimpleDialog.js</a></li>
1158                                 <li class=""><a href="Tooltip.js.html">Tooltip.js</a></li>
1159                         </ul>
1160                     </div>
1161
1162                     <div class="module">
1163                         <h4>Properties</h4>
1164                         <ul class="content">
1165                                 <li><a href="#config">config</a>
1166                                         <!--<code>&lt;Boolean&gt;</code>-->
1167                                 </li>
1168                                 <li><a href="#eventQueue">eventQueue</a>
1169                                         <!--<code>&lt;Boolean&gt;</code>-->
1170                                 </li>
1171                                 <li><a href="#initialConfig">initialConfig</a>
1172                                         <!--<code>&lt;Boolean&gt;</code>-->
1173                                 </li>
1174                                 <li><a href="#owner">owner</a>
1175                                         <!--<code>&lt;Boolean&gt;</code>-->
1176                                 </li>
1177                                 <li><a href="#queueInProgress">queueInProgress</a>
1178                                         <!--<code>&lt;Boolean&gt;</code>-->
1179                                 </li>
1180                         </ul>
1181                     </div>
1182
1183                     <div class="module">
1184                         <h4>Methods</h4>
1185                         <ul class="content">
1186                                 <li><!--<code>void</code>-->
1187                                 <a href="#addProperty">addProperty</a>
1188                                 </li>
1189                                 <li><!--<code>void</code>-->
1190                                 <a href="#applyConfig">applyConfig</a>
1191                                 </li>
1192                                 <li><!--<code>Boolean</code>-->
1193                                 <a href="#checkBoolean">checkBoolean</a>
1194                                 </li>
1195                                 <li><!--<code>Boolean</code>-->
1196                                 <a href="#checkNumber">checkNumber</a>
1197                                 </li>
1198                                 <li><!--<code>void</code>-->
1199                                 <a href="#fireEvent">fireEvent</a>
1200                                 </li>
1201                                 <li><!--<code>void</code>-->
1202                                 <a href="#fireQueue">fireQueue</a>
1203                                 </li>
1204                                 <li><!--<code>Object</code>-->
1205                                 <a href="#getConfig">getConfig</a>
1206                                 </li>
1207                                 <li><!--<code>Object</code>-->
1208                                 <a href="#getProperty">getProperty</a>
1209                                 </li>
1210                                 <li><!--<code>void</code>-->
1211                                 <a href="#init">init</a>
1212                                 </li>
1213                                 <li><!--<code>String</code>-->
1214                                 <a href="#outputEventQueue">outputEventQueue</a>
1215                                 </li>
1216                                 <li><!--<code>Boolean</code>-->
1217                                 <a href="#queueProperty">queueProperty</a>
1218                                 </li>
1219                                 <li><!--<code>void</code>-->
1220                                 <a href="#refireEvent">refireEvent</a>
1221                                 </li>
1222                                 <li><!--<code>void</code>-->
1223                                 <a href="#refresh">refresh</a>
1224                                 </li>
1225                                 <li><!--<code>Boolean</code>-->
1226                                 <a href="#resetProperty">resetProperty</a>
1227                                 </li>
1228                                 <li><!--<code>Boolean</code>-->
1229                                 <a href="#setProperty">setProperty</a>
1230                                 </li>
1231                                 <li><!--<code>Boolean</code>-->
1232                                 <a href="#subscribeToConfigEvent">subscribeToConfigEvent</a>
1233                                 </li>
1234                                 <li><!--<code>String</code>-->
1235                                 <a href="#toString">toString</a>
1236                                 </li>
1237                                 <li><!--<code>Boolean</code>-->
1238                                 <a href="#unsubscribeFromConfigEvent">unsubscribeFromConfigEvent</a>
1239                                 </li>
1240                                 <li><!--<code>Boolean</code>-->
1241                                 <a href="#YAHOO.util.Config.alreadySubscribed">YAHOO.util.Config.alreadySubscribed</a>
1242                                 </li>
1243                         </ul>
1244                     </div>
1245
1246                     <div class="module">
1247                         <h4>Events</h4>
1248                         <ul class="content">
1249                                 <li>
1250                                 <a href="#configChangedEvent">configChangedEvent</a>
1251                                 </li>
1252                         </ul>
1253                     </div>
1254
1255
1256             </div>
1257                 </div>
1258         </div>
1259         <div id="ft">
1260         <hr />
1261         Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
1262         </div>
1263 </div>
1264 </body>
1265 </html>