<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Example: Set and Get Properties</title>
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
<link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="../../build/yui/yui-min.js"></script>
</head>
<body>
<!--
<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>
-->
<div id="doc">
<div id="hd">
<h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
</div>
<h1>Example: Set and Get Properties</h1>
<div class="yui3-g">
<div class="yui3-u-3-4">
<div id="main">
<div class="content"><link href="../assets/node/node.css" rel="stylesheet" type="text/css">
<div class="intro">
<p>This example demonstrates how to retrieve and use a <code>Node</code> instance
and access DOM properties.</p>
<p>Press a button to get or set the <code>offsetWidth</code> of the <code>div</code>
containing the corn image.</p>
</div>
<div class="example">
<style>
.example #corn{
position: relative;
background: url(../assets/node/images/corn.jpg);
width: 232px;
height: 181px;
-moz-box-shadow: 3px 3px 12px rgba(0, 0, 0, 0.4);
-webkit-box-shadow: 3px 3px 12px rgba(0, 0, 0, 0.4);
margin: 2px 0 1em;
border: none;
}
.example #ruler{
width: 650px;
height: 42px;
background: url("../assets/node/images/ruler_ticks.png") repeat-x scroll -1px 24px #DDCEB7;
}
.example .yui3-button {
margin: 0 0.2em;
}
.example .btn-get{
margin-left: 4em;
}
#input {
height: 1.6em;
width: 4em;
}
#output{
position: absolute;
top: -40px;
width: 100px;
height: 40px;
right: -50px;
text-align: center;
cursor: pointer;
}
#corn .ruler-marker{
position: absolute;
top: -20px;
right: 0;
height: 30px;
border-right: solid 1px #f00;
}
</style>
<body>
<div id="ruler"></div>
<div id="corn">
<div class="ruler-marker"></div>
<div id="output">? px</div>
</div>
<label>Width:</label>
<input id="input" size="2" value="550"> px
<button class="yui3-button btn-set">Set</button>
<button class="yui3-button btn-get">Get</button>
<script>
YUI().use('node', 'button', function(Y) {
var corn = Y.one('#corn'),
input = Y.one('.example #input'),
output = Y.one('.example #output');
var getWidth = function(){
var width = corn.get('offsetWidth');
output.setHTML(width + 'px'); // display width near the get button
}
Y.one('.example .btn-get').on('click', getWidth);
output.on('click', getWidth); // also allows getting width by clicking on ruler width label
Y.one('.example .btn-set').on('click', function(e) {
var value = input.get('value'),
width = corn.get('offsetWidth');
if (value == '') {
input.set('value', width);
} else if (!isNaN(parseInt(value))) { // if the value in the input is a number
corn.set('offsetWidth', value);
output.setHTML('? ' + 'px'); // clear out the width label on the ruler
}
});
});
</script>
<div style="color:#aaa; display:block; font-size:90%; margin-top:1em;">Image derived from
<a href="http://www.flickr.com/photos/29278394@N00/3934433763/" target="_blank">
"ear of corn"</a>, by normanack</div>
</div>
<h2>Setting up the HTML</h2>
<pre class="code prettyprint"><div id="ruler"></div>
<div id="corn">
<div class="ruler-marker"></div>
<div id="output">? px</div>
</div>
<label>Width:</label>
<input id="input" size="2" value="550"> px
<button class="yui3-button btn-set">Set</button>
<button class="yui3-button btn-get">Get</button></pre>
<h2>Getting a Node Instance</h2>
<p>The <code>Y.one</code> method accepts a Selector or HTML element and
returns a Node instance. First we'll set up some variables
for the node's representing our HTML.</p>
<pre class="code prettyprint">var corn = Y.one('#corn'),
input = Y.one('.example #input'),
output = Y.one('.example #output');</pre>
<h2>Accessing Node Properties</h2>
<p>The properties of a node can be accessed via its <code>set</code> and
<code>get</code> methods.</p>
<p>In most cases, simple type of properties (strings, numbers, Booleans)
pass directly to/from the underlying DOM node, however properties representing
other DOM nodes return <code>Node</code> or <code>NodeList</code> instances.</p>
<h3>The Get Method</h3>
<p>We can use the <code>get</code> method to read the <code>offsetWidth</code> of the <code>div</code>
containing the corn image,
which includes the style width, padding, and border.</p>
<pre class="code prettyprint">width = corn.get('offsetWidth');</pre>
<h3>The Set Method</h3>
<p>The Set method can be used to set the value of objects
</p>
<pre class="code prettyprint">input.set('value', 237);</pre>
<p>The <code>offsetWidth</code> property of an HTML element is read only, however YUI
makes this writeable. This assures that the final <code>offsetWidth</code>
matches the value that is set, regardless of borders, padding, or box model.</p>
<pre class="code prettyprint">corn.set('offsetWidth', value);</pre>
<h2>Listening for Node Events</h2>
<p>We will update the value <code>offsetWidth</code> property of the <code>div</code>
containing the corn image when the Set button is pressed.
</p>
<pre class="code prettyprint">Y.one('.example .btn-set').on('click', function(e) {
...
corn.set('offsetWidth', value);
...
};</pre>
<h2>Complete Example Source</h2>
<pre class="code prettyprint"><style>
.example #corn{
position: relative;
background: url(../assets/node/images/corn.jpg);
width: 232px;
height: 181px;
-moz-box-shadow: 3px 3px 12px rgba(0, 0, 0, 0.4);
-webkit-box-shadow: 3px 3px 12px rgba(0, 0, 0, 0.4);
margin: 2px 0 1em;
border: none;
}
.example #ruler{
width: 650px;
height: 42px;
background: url("../assets/node/images/ruler_ticks.png") repeat-x scroll -1px 24px #DDCEB7;
}
.example .yui3-button {
margin: 0 0.2em;
}
.example .btn-get{
margin-left: 4em;
}
#input {
height: 1.6em;
width: 4em;
}
#output{
position: absolute;
top: -40px;
width: 100px;
height: 40px;
right: -50px;
text-align: center;
cursor: pointer;
}
#corn .ruler-marker{
position: absolute;
top: -20px;
right: 0;
height: 30px;
border-right: solid 1px #f00;
}
</style>
<body>
<div id="ruler"></div>
<div id="corn">
<div class="ruler-marker"></div>
<div id="output">? px</div>
</div>
<label>Width:</label>
<input id="input" size="2" value="550"> px
<button class="yui3-button btn-set">Set</button>
<button class="yui3-button btn-get">Get</button>
<script>
YUI().use('node', 'button', function(Y) {
var corn = Y.one('#corn'),
input = Y.one('.example #input'),
output = Y.one('.example #output');
var getWidth = function(){
var width = corn.get('offsetWidth');
output.setHTML(width + 'px'); // display width near the get button
}
Y.one('.example .btn-get').on('click', getWidth);
output.on('click', getWidth); // also allows getting width by clicking on ruler width label
Y.one('.example .btn-set').on('click', function(e) {
var value = input.get('value'),
width = corn.get('offsetWidth');
if (value == '') {
input.set('value', width);
} else if (!isNaN(parseInt(value))) { // if the value in the input is a number
corn.set('offsetWidth', value);
output.setHTML('? ' + 'px'); // clear out the width label on the ruler
}
});
});
</script></pre>
</div>
</div>
</div>
<div class="yui3-u-1-4">
<div class="sidebar">
<div class="sidebox">
<div class="hd">
<h2 class="no-toc">Examples</h2>
</div>
<div class="bd">
<ul class="examples">
<li data-description="Using selectors and property accessors with Node.">
<a href="properties.html">Set and Get Properties</a>
</li>
<li data-description="Using DOM methods with Node.">
<a href="dom-node.html">DOM Methods</a>
</li>
<li data-description="Building a simple store and shopping cart.">
<a href="store.html">DOM Methods - Store</a>
</li>
<li data-description="Listening for DOM events with Node instances.">
<a href="events.html">Handling DOM Events</a>
</li>
<li data-description="NodeList provides Node functionality for manipulating multiple nodes at once.">
<a href="nodelist.html">Using NodeList - Simple</a>
</li>
<li data-description="How to use multiple NodeList features to build a simple game.">
<a href="ducks.html">Using NodeList - Ducks Game</a>
</li>
<li data-description="Using a single event listener to handle events on multiple nodes.">
<a href="node-evt-delegation.html">Delegating Node Events</a>
</li>
<li data-description="This example demonstrates how to position an element in page coordinates.">
<a href="node-xy.html">Node Positioning</a>
</li>
<li data-description="This example demonstrates how to set styles and get style information.">
<a href="node-style.html">Node Styling</a>
</li>
<li data-description="This example demonstrates how to insert content into a Node.">
<a href="node-insert.html">Adding Node Content - Burger Builder</a>
</li>
<li data-description="This example demonstrates how to show and hide a Node.">
<a href="node-view.html">Showing and Hiding</a>
</li>
</ul>
</div>
</div>
<div class="sidebox">
<div class="hd">
<h2 class="no-toc">Examples That Use This Component</h2>
</div>
<div class="bd">
<ul class="examples">
<li data-description="Creating an accessible toolbar using the Focus Manager Node Plugin and Node's support for the WAI-ARIA Roles and States.">
<a href="../node-focusmanager/node-focusmanager-toolbar.html">Accessible Toolbar</a>
</li>
<li data-description="Creating an accessible menu button using the Focus Manager Node Plugin, Event's delegation support and mouseenter event, along with the Overlay widget and Node's support for the WAI-ARIA Roles and States.">
<a href="../node-focusmanager/node-focusmanager-button.html">Accessible Menu Button</a>
</li>
<li data-description="Use the Event Utility to attach simple DOM event handlers.">
<a href="../event/basic-example.html">Simple DOM Events</a>
</li>
<li data-description="Example Photo Browser application.">
<a href="../dd/photo-browser.html">Photo Browser</a>
</li>
<li data-description="Portal style example using Drag & Drop Event Bubbling and Animation.">
<a href="../dd/portal-drag.html">Portal Style Example</a>
</li>
<li data-description="Use IO to request XML data from a remote web service.">
<a href="../io/weather.html">Request XML data from Yahoo! Weather</a>
</li>
<li data-description="Use IO to make a cross-domain request to Yahoo! Pipes, returning data from disparate sources.">
<a href="../io/xdr.html">Request JSON using Yahoo! Pipes</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script>
YUI.Env.Tests = {
examples: [],
project: '../assets',
assets: '../assets/node',
name: 'properties',
title: 'Set and Get Properties',
newWindow: '',
auto: false
};
YUI.Env.Tests.examples.push('properties');
YUI.Env.Tests.examples.push('dom-node');
YUI.Env.Tests.examples.push('store');
YUI.Env.Tests.examples.push('events');
YUI.Env.Tests.examples.push('nodelist');
YUI.Env.Tests.examples.push('ducks');
YUI.Env.Tests.examples.push('node-evt-delegation');
YUI.Env.Tests.examples.push('node-xy');
YUI.Env.Tests.examples.push('node-style');
YUI.Env.Tests.examples.push('node-insert');
YUI.Env.Tests.examples.push('node-view');
YUI.Env.Tests.examples.push('node-focusmanager-toolbar');
YUI.Env.Tests.examples.push('node-focusmanager-button');
YUI.Env.Tests.examples.push('basic-example');
YUI.Env.Tests.examples.push('photo-browser');
YUI.Env.Tests.examples.push('portal-drag');
YUI.Env.Tests.examples.push('weather');
YUI.Env.Tests.examples.push('xdr');
</script>
<script src="../assets/yui/test-runner.js"></script>
</body>
</html>