src/cm/media/js/lib/yui/yui_3.10.3/docs/attribute/attribute-rw.html
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 525 89ef5ed3c48b
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
525
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     1
<!DOCTYPE html>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     2
<html lang="en">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     3
<head>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     4
    <meta charset="utf-8">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     5
    <title>Example: Read-Only and Write-Once Attributes</title>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     6
    <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     7
    <link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     8
    <link rel="stylesheet" href="../assets/css/main.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     9
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    10
    <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    11
    <script src="../../build/yui/yui-min.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    12
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    13
</head>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    14
<body>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    15
<!--
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    16
<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    17
-->
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    18
<div id="doc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    19
    <div id="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    20
        <h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    21
    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    22
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    23
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    24
            <h1>Example: Read-Only and Write-Once Attributes</h1>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    25
    <div class="yui3-g">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    26
        <div class="yui3-u-3-4">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    27
            <div id="main">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    28
                <div class="content"><style type="text/css" scoped>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    29
    .example-out .myclass-attrs {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    30
        font-family:courier;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    31
        margin-top:2px;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    32
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    33
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    34
    .example-out .myclass-title {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    35
        font-weight:bold;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    36
        font-family:arial;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    37
        color:#8dd5e7;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    38
        margin-top:5px;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    39
        margin-bottom:3px;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    40
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    41
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    42
    .example-out {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    43
        overflow:auto;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    44
        border:1px solid #000;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    45
        color:#ffffff;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    46
        background-color:#004C6D;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    47
        margin-top:5px;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    48
        margin-bottom:20px;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    49
        height:8em;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    50
        padding:2px 2px 2px 5px;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    51
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    52
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    53
    #writeInitial label, #writeAgain label, #writeInternally label {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    54
        font-weight:900;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    55
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    56
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    57
    #writeInitial .fooVal, #writeAgain .fooVal, #writeInternally .fooVal {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    58
        width:9em;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    59
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    60
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    61
    #writeInitial .barVal, #writeAgain .barVal, #writeInternally .barVal {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    62
        width:9em;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    63
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    64
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    65
    #writeInitial p, #writeAgain p, #writeInternally p {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    66
        margin-top:0.2em;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    67
        margin-bottom:0.2em;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    68
        color:#004C6D;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    69
        font-size:108%;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    70
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    71
</style>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    72
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    73
<div class="intro">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    74
    <p>Attributes can be configured to be <code>readOnly</code>, stopping them from being modified by the end user, or <code>writeOnce</code> allowing them to be set by the end user, but only once. This example demonstrates how to setup attributes for your class as <code>readOnly</code> or <code>writeOnce</code> attributes, and shows how their behavior differs when the end user attempts to set their values.</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    75
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    76
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    77
<div class="example">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    78
    <form id="writeInitial" action="#">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    79
    <p>Construct o1, setting initial values for both foo and bar in the constructor: </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    80
    <label>foo: <input type="text" value="Initial Foo" class="fooVal"></label>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    81
    <label>bar: <input type="text" value="Initial Bar" class="barVal"></label>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    82
    <button type="submit" class="do">Initial Values</button>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    83
    <div class="example-out"></div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    84
</form>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    85
<form id="writeAgain" action="#">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    86
    <p>Try setting values again, after they've been set once: </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    87
    <label>foo: <input type="text" value="Set Foo Again" class="fooVal"></label>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    88
    <label>bar: <input type="text" value="Set Bar Again" class="barVal"></label>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    89
    <button type="submit" class="do">Set Again</button>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    90
    <div class="example-out"></div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    91
</form>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    92
<form id="writeInternally" action="#">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    93
    <p>Call a MyClass method, which sets foo internally (using _set): </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    94
    <label>foo: <input type="text" value="Set Foo Internally" class="fooVal"></label>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    95
    <button type="submit" class="do">Set Internal</button>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    96
    <div class="example-out"></div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    97
</form>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    98
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    99
<script type="text/javascript">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   100
YUI().use("node", "attribute", "escape", function(Y) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   101
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   102
    // Setup a custom class with attribute support
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   103
    function MyClass(cfg) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   104
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   105
        var attrs = {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   106
            "foo" : {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   107
                value: "Default Foo",
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   108
                readOnly: true
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   109
            },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   110
     
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   111
            "bar" : {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   112
                value: "Default Bar",
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   113
                writeOnce: true
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   114
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   115
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   116
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   117
        this.addAttrs(attrs, cfg);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   118
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   119
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   120
    MyClass.prototype.doSomething = function(val) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   121
        // ... Do something which requires
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   122
        // MyClass to change the value
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   123
        // of foo ...
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   124
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   125
        // Host code can reset value of 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   126
        // readOnly attributes interally,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   127
        // by working with the private _set
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   128
        // property
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   129
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   130
        this._set("foo", val);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   131
    };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   132
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   133
    Y.augment(MyClass, Y.Attribute);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   134
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   135
    function displayValues(o, title, node) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   136
        var str = 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   137
            '<div class="myclass"><div class="myclass-title">' 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   138
            + title + 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   139
            '</div><ul class="myclass-attrs"><li>foo (readOnly): ' 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   140
            + Y.Escape.html(o.get("foo")) 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   141
            + '</li><li>bar (writeOnce): '
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   142
            + Y.Escape.html(o.get("bar"))
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   143
            + '</li></ul></div>';
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   144
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   145
        Y.one(node).set("innerHTML", str);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   146
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   147
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   148
    var o1;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   149
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   150
    Y.on("submit", function(e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   151
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   152
        e.preventDefault();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   153
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   154
        var fooVal = Y.one("#writeInitial .fooVal").get("value");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   155
        var barVal = Y.one("#writeInitial .barVal").get("value");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   156
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   157
        o1 = new MyClass({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   158
            foo: fooVal,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   159
            bar: barVal
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   160
        });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   161
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   162
        displayValues(o1, "Attempt to set initial values in constructor", "#writeInitial .example-out");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   163
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   164
    }, "#writeInitial");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   165
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   166
    Y.on("submit", function(e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   167
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   168
        e.preventDefault();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   169
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   170
        if (o1) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   171
            var fooVal = Y.one("#writeAgain .fooVal").get("value");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   172
            var barVal = Y.one("#writeAgain .barVal").get("value");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   173
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   174
            // Attempt to reset values:
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   175
            o1.set("foo", fooVal);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   176
            o1.set("bar", barVal);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   177
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   178
            displayValues(o1, "Attempt to set values again, using set", "#writeAgain .example-out");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   179
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   180
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   181
    }, "#writeAgain");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   182
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   183
    Y.on("submit", function(e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   184
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   185
        e.preventDefault();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   186
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   187
        if (o1) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   188
            var val = Y.one("#writeInternally .fooVal").get("value");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   189
            // Call method, which sets foo internally...
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   190
            o1.doSomething(val);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   191
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   192
            displayValues(o1, "Set the value of foo (readOnly) internally", "#writeInternally .example-out");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   193
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   194
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   195
    }, "#writeInternally");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   196
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   197
</script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   198
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   199
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   200
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   201
<h2>ReadOnly And WriteOnce</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   202
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   203
<p>Attribute supports the ability to configure attributes to be <code>readOnly</code> or <code>writeOnce</code>. <code>readOnly</code> attributes cannot be set by the end user, either through initial values passed to the constructor, or by invoking the <code>set</code> method. <code>writeOnce</code> attributes on the other hand, can be set by the user, but only once, either during initialization or through a call to <code>set</code>. Once a value is established for a <code>writeOnce</code> attribute, it cannot be reset to another value by the user.</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   204
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   205
<h2>Configuring ReadOnly And WriteOnce Attributes</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   206
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   207
<p>This example sets up a custom class, <code>MyClass</code>, with two attributes, <code>foo</code> and <code>bar</code>. <code>foo</code> is configured to be a <code>readOnly</code> attribute, and <code>bar</code> is configured to be a <code>writeOnce</code> attribute:</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   208
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   209
<pre class="code prettyprint">&#x2F;&#x2F; Setup a custom class with attribute support
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   210
function MyClass(cfg) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   211
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   212
    &#x2F;&#x2F; Attribute configuration
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   213
    var attrs = {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   214
        &quot;foo&quot; : {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   215
            value: &quot;Default Foo&quot;,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   216
            readOnly: true
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   217
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   218
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   219
        &quot;bar&quot; : {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   220
            value: &quot;Default Bar&quot;,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   221
            writeOnce: true
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   222
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   223
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   224
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   225
    this.addAttrs(attrs, cfg);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   226
}</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   227
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   228
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   229
<h2>Attempting To Set Values</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   230
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   231
<p>We first attempt to set values for both attributes in the constructor (used to intialize the attributes) and see that only <code>bar</code>, the <code>writeOnce</code> attribute, gets set to the user provided value:</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   232
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   233
<pre class="code prettyprint">var fooVal = Y.one(&quot;#writeInitial .fooVal&quot;).get(&quot;value&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   234
var barVal = Y.one(&quot;#writeInitial .barVal&quot;).get(&quot;value&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   235
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   236
o1 = new MyClass({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   237
    foo: fooVal,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   238
    bar: barVal
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   239
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   240
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   241
displayValues(o1, &quot;Attempt to set initial values in constructor&quot;, 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   242
                &quot;#writeInitial .example-out&quot;);</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   243
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   244
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   245
<p>We then attempt to set values for both attributes again, using <code>set</code>, and see that niether of the values are modified:</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   246
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   247
<pre class="code prettyprint">var fooVal = Y.one(&quot;#writeAgain .fooVal&quot;).get(&quot;value&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   248
var barVal = Y.one(&quot;#writeAgain .barVal&quot;).get(&quot;value&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   249
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   250
&#x2F;&#x2F; Attempt to reset values:
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   251
o1.set(&quot;foo&quot;, fooVal);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   252
o1.set(&quot;bar&quot;, barVal);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   253
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   254
displayValues(o1, &quot;Attempt to set values again, using set&quot;, 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   255
                &quot;#writeAgain .example-out&quot;);</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   256
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   257
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   258
<h2>Setting The State Of ReadOnly Values Internally</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   259
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   260
<p>Although the user cannot update the value of <code>readOnly</code> attributes, it maybe neccessary for the host object to update it's value internally. The example shows how this can be done, using the private <code>_set</code> property on the host:</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   261
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   262
<pre class="code prettyprint">MyClass.prototype.doSomething = function(val) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   263
    &#x2F;&#x2F; ... Do something which requires
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   264
    &#x2F;&#x2F; MyClass to change the value
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   265
    &#x2F;&#x2F; of foo ...
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   266
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   267
    &#x2F;&#x2F; Host code can reset value of 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   268
    &#x2F;&#x2F; readOnly attributes interally,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   269
    &#x2F;&#x2F; by working with the private _set
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   270
    &#x2F;&#x2F; property
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   271
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   272
    this._set(&quot;foo&quot;, val);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   273
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   274
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   275
...
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   276
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   277
var val = Y.one(&quot;#writeInternally .fooVal&quot;).get(&quot;value&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   278
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   279
&#x2F;&#x2F; Call method, which sets foo internally...
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   280
o1.doSomething(val);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   281
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   282
displayValues(o1, &quot;Set value of foo (readOnly) interally&quot;, 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   283
                &quot;#writeInternally .example-out&quot;);</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   284
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   285
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   286
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   287
<h2>Complete Example Source</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   288
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   289
<pre class="code prettyprint">&lt;form id=&quot;writeInitial&quot; action=&quot;#&quot;&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   290
    &lt;p&gt;Construct o1, setting initial values for both foo and bar in the constructor: &lt;&#x2F;p&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   291
    &lt;label&gt;foo: &lt;input type=&quot;text&quot; value=&quot;Initial Foo&quot; class=&quot;fooVal&quot;&gt;&lt;&#x2F;label&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   292
    &lt;label&gt;bar: &lt;input type=&quot;text&quot; value=&quot;Initial Bar&quot; class=&quot;barVal&quot;&gt;&lt;&#x2F;label&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   293
    &lt;button type=&quot;submit&quot; class=&quot;do&quot;&gt;Initial Values&lt;&#x2F;button&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   294
    &lt;div class=&quot;example-out&quot;&gt;&lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   295
&lt;&#x2F;form&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   296
&lt;form id=&quot;writeAgain&quot; action=&quot;#&quot;&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   297
    &lt;p&gt;Try setting values again, after they&#x27;ve been set once: &lt;&#x2F;p&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   298
    &lt;label&gt;foo: &lt;input type=&quot;text&quot; value=&quot;Set Foo Again&quot; class=&quot;fooVal&quot;&gt;&lt;&#x2F;label&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   299
    &lt;label&gt;bar: &lt;input type=&quot;text&quot; value=&quot;Set Bar Again&quot; class=&quot;barVal&quot;&gt;&lt;&#x2F;label&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   300
    &lt;button type=&quot;submit&quot; class=&quot;do&quot;&gt;Set Again&lt;&#x2F;button&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   301
    &lt;div class=&quot;example-out&quot;&gt;&lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   302
&lt;&#x2F;form&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   303
&lt;form id=&quot;writeInternally&quot; action=&quot;#&quot;&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   304
    &lt;p&gt;Call a MyClass method, which sets foo internally (using _set): &lt;&#x2F;p&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   305
    &lt;label&gt;foo: &lt;input type=&quot;text&quot; value=&quot;Set Foo Internally&quot; class=&quot;fooVal&quot;&gt;&lt;&#x2F;label&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   306
    &lt;button type=&quot;submit&quot; class=&quot;do&quot;&gt;Set Internal&lt;&#x2F;button&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   307
    &lt;div class=&quot;example-out&quot;&gt;&lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   308
&lt;&#x2F;form&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   309
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   310
&lt;script type=&quot;text&#x2F;javascript&quot;&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   311
YUI().use(&quot;node&quot;, &quot;attribute&quot;, &quot;escape&quot;, function(Y) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   312
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   313
    &#x2F;&#x2F; Setup a custom class with attribute support
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   314
    function MyClass(cfg) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   315
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   316
        var attrs = {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   317
            &quot;foo&quot; : {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   318
                value: &quot;Default Foo&quot;,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   319
                readOnly: true
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   320
            },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   321
     
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   322
            &quot;bar&quot; : {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   323
                value: &quot;Default Bar&quot;,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   324
                writeOnce: true
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   325
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   326
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   327
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   328
        this.addAttrs(attrs, cfg);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   329
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   330
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   331
    MyClass.prototype.doSomething = function(val) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   332
        &#x2F;&#x2F; ... Do something which requires
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   333
        &#x2F;&#x2F; MyClass to change the value
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   334
        &#x2F;&#x2F; of foo ...
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   335
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   336
        &#x2F;&#x2F; Host code can reset value of 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   337
        &#x2F;&#x2F; readOnly attributes interally,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   338
        &#x2F;&#x2F; by working with the private _set
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   339
        &#x2F;&#x2F; property
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   340
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   341
        this._set(&quot;foo&quot;, val);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   342
    };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   343
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   344
    Y.augment(MyClass, Y.Attribute);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   345
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   346
    function displayValues(o, title, node) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   347
        var str = 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   348
            &#x27;&lt;div class=&quot;myclass&quot;&gt;&lt;div class=&quot;myclass-title&quot;&gt;&#x27; 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   349
            + title + 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   350
            &#x27;&lt;&#x2F;div&gt;&lt;ul class=&quot;myclass-attrs&quot;&gt;&lt;li&gt;foo (readOnly): &#x27; 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   351
            + Y.Escape.html(o.get(&quot;foo&quot;)) 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   352
            + &#x27;&lt;&#x2F;li&gt;&lt;li&gt;bar (writeOnce): &#x27;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   353
            + Y.Escape.html(o.get(&quot;bar&quot;))
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   354
            + &#x27;&lt;&#x2F;li&gt;&lt;&#x2F;ul&gt;&lt;&#x2F;div&gt;&#x27;;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   355
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   356
        Y.one(node).set(&quot;innerHTML&quot;, str);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   357
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   358
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   359
    var o1;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   360
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   361
    Y.on(&quot;submit&quot;, function(e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   362
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   363
        e.preventDefault();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   364
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   365
        var fooVal = Y.one(&quot;#writeInitial .fooVal&quot;).get(&quot;value&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   366
        var barVal = Y.one(&quot;#writeInitial .barVal&quot;).get(&quot;value&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   367
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   368
        o1 = new MyClass({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   369
            foo: fooVal,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   370
            bar: barVal
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   371
        });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   372
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   373
        displayValues(o1, &quot;Attempt to set initial values in constructor&quot;, &quot;#writeInitial .example-out&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   374
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   375
    }, &quot;#writeInitial&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   376
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   377
    Y.on(&quot;submit&quot;, function(e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   378
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   379
        e.preventDefault();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   380
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   381
        if (o1) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   382
            var fooVal = Y.one(&quot;#writeAgain .fooVal&quot;).get(&quot;value&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   383
            var barVal = Y.one(&quot;#writeAgain .barVal&quot;).get(&quot;value&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   384
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   385
            &#x2F;&#x2F; Attempt to reset values:
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   386
            o1.set(&quot;foo&quot;, fooVal);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   387
            o1.set(&quot;bar&quot;, barVal);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   388
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   389
            displayValues(o1, &quot;Attempt to set values again, using set&quot;, &quot;#writeAgain .example-out&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   390
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   391
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   392
    }, &quot;#writeAgain&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   393
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   394
    Y.on(&quot;submit&quot;, function(e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   395
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   396
        e.preventDefault();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   397
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   398
        if (o1) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   399
            var val = Y.one(&quot;#writeInternally .fooVal&quot;).get(&quot;value&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   400
            &#x2F;&#x2F; Call method, which sets foo internally...
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   401
            o1.doSomething(val);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   402
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   403
            displayValues(o1, &quot;Set the value of foo (readOnly) internally&quot;, &quot;#writeInternally .example-out&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   404
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   405
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   406
    }, &quot;#writeInternally&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   407
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   408
&lt;&#x2F;script&gt;</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   409
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   410
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   411
            </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   412
        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   413
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   414
        <div class="yui3-u-1-4">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   415
            <div class="sidebar">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   416
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   417
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   418
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   419
                    <div class="sidebox">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   420
                        <div class="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   421
                            <h2 class="no-toc">Examples</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   422
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   423
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   424
                        <div class="bd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   425
                            <ul class="examples">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   426
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   427
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   428
                                        <li data-description="Use the Attribute API to define, set and get attribute values.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   429
                                            <a href="attribute-basic.html">Basic Attribute Configuration</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   430
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   431
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   432
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   433
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   434
                                        <li data-description="Configure attributes to be readOnly or writeOnce.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   435
                                            <a href="attribute-rw.html">Read-Only and Write-Once Attributes</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   436
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   437
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   438
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   439
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   440
                                        <li data-description="How to listen for changes in attribute values.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   441
                                            <a href="attribute-event.html">Attribute Change Events</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   442
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   443
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   444
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   445
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   446
                                        <li data-description="Create a basic SpeedDater class, with Attribute support.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   447
                                            <a href="attribute-basic-speeddate.html">Attribute Based Speed Dating</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   448
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   449
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   450
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   451
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   452
                                        <li data-description="Refactors the basic Speed Dating example, to use attribute change events to update rendered elements, and have two instances react to another.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   453
                                            <a href="attribute-event-speeddate.html">Attribute Event Based Speed Dating</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   454
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   455
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   456
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   457
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   458
                                        <li data-description="Add custom methods to get and set attribute values and provide validation support.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   459
                                            <a href="attribute-getset.html">Attribute Getters, Setters and Validators</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   460
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   461
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   462
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   463
                            </ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   464
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   465
                    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   466
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   467
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   468
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   469
            </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   470
        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   471
    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   472
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   473
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   474
<script src="../assets/vendor/prettify/prettify-min.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   475
<script>prettyPrint();</script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   476
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   477
<script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   478
YUI.Env.Tests = {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   479
    examples: [],
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   480
    project: '../assets',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   481
    assets: '../assets/attribute',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   482
    name: 'attribute-rw',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   483
    title: 'Read-Only and Write-Once Attributes',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   484
    newWindow: '',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   485
    auto:  false 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   486
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   487
YUI.Env.Tests.examples.push('attribute-basic');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   488
YUI.Env.Tests.examples.push('attribute-rw');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   489
YUI.Env.Tests.examples.push('attribute-event');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   490
YUI.Env.Tests.examples.push('attribute-basic-speeddate');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   491
YUI.Env.Tests.examples.push('attribute-event-speeddate');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   492
YUI.Env.Tests.examples.push('attribute-getset');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   493
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   494
</script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   495
<script src="../assets/yui/test-runner.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   496
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   497
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   498
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   499
</body>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   500
</html>