Content of file PropertyBinder.html

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Mon Apr 24 06:17:21 UTC 2023 -->
<title>PropertyBinder (Zephyr - UI Content Editor 1.2-ALPHA-4-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-04-24">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="PropertyBinder (Zephyr - UI Content Editor 1.2-ALPHA-4-SNAPSHOT API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PropertyBinder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">it.tidalwave.northernwind.rca.ui.contenteditor.spi</a></div>
<h2 title="Interface PropertyBinder" class="title">Interface PropertyBinder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<object type="image/svg+xml" data="PropertyBinder.svg"  style="max-width:60%;float:right;"></object>
<pre style="white-space:pre-wrap;">public interface <span class="typeNameLabel">PropertyBinder</span></pre>
<div class="block">A role that allows to bind items of <code>ResourceProperties</code> to other objects, typically for managing a User
 Interface.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Fabrizio Giudici</dd>
<dt><span class="simpleTagLabel">Stereotype:</span></dt>
<dd>role</dd>
</dl>
</li>
</ul>
</div>
<div class="summary" style="clear:right;">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PropertyBinder.UpdateCallback.html" title="interface in it.tidalwave.northernwind.rca.ui.contenteditor.spi">PropertyBinder.UpdateCallback</a></span></code></th>
<td class="colLast">
<div class="block">A callback that notifies when an item has been updated.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Class&lt;<a href="PropertyBinder.html" title="interface in it.tidalwave.northernwind.rca.ui.contenteditor.spi">PropertyBinder</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_PropertyBinder_">_PropertyBinder_</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bind(it.tidalwave.util.Key,it.tidalwave.role.ui.BoundProperty,it.tidalwave.northernwind.rca.ui.contenteditor.spi.PropertyBinder.UpdateCallback)">bind</a></span>&#8203;(it.tidalwave.util.Key&lt;T&gt;&nbsp;propertyName,
    it.tidalwave.role.ui.BoundProperty&lt;T&gt;&nbsp;boundProperty,
    <a href="PropertyBinder.UpdateCallback.html" title="interface in it.tidalwave.northernwind.rca.ui.contenteditor.spi">PropertyBinder.UpdateCallback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Binds a given property to a <code>BoundProperty</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://tidalwave.it/projects/northernwind-rca/northernwind-rca-modules/it-tidalwave-northernwind-rca-embeddedserver/apidocs/it/tidalwave/northernwind/rca/embeddedserver/EmbeddedServer.Document.html?is-external=true" title="class or interface in it.tidalwave.northernwind.rca.embeddedserver" class="externalLink">EmbeddedServer.Document</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createBoundDocument(it.tidalwave.util.Key,it.tidalwave.northernwind.rca.ui.contenteditor.spi.PropertyBinder.UpdateCallback)">createBoundDocument</a></span>&#8203;(it.tidalwave.util.Key&lt;java.lang.String&gt;&nbsp;propertyName,
                   <a href="PropertyBinder.UpdateCallback.html" title="interface in it.tidalwave.northernwind.rca.ui.contenteditor.spi">PropertyBinder.UpdateCallback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Creates a Document bound to the given property.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a id="_PropertyBinder_">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_PropertyBinder_</h4>
<pre>static final&nbsp;java.lang.Class&lt;<a href="PropertyBinder.html" title="interface in it.tidalwave.northernwind.rca.ui.contenteditor.spi">PropertyBinder</a>&gt; _PropertyBinder_</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a id="bind(it.tidalwave.util.Key,it.tidalwave.role.ui.BoundProperty,it.tidalwave.northernwind.rca.ui.contenteditor.spi.PropertyBinder.UpdateCallback)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bind</h4>
<pre class="methodSignature">&lt;T&gt;&nbsp;void&nbsp;bind&#8203;(@Nonnull
              it.tidalwave.util.Key&lt;T&gt;&nbsp;propertyName,
              @Nonnull
              it.tidalwave.role.ui.BoundProperty&lt;T&gt;&nbsp;boundProperty,
              @Nonnull
              <a href="PropertyBinder.UpdateCallback.html" title="interface in it.tidalwave.northernwind.rca.ui.contenteditor.spi">PropertyBinder.UpdateCallback</a>&nbsp;callback)</pre>
<div class="block">Binds a given property to a <code>BoundProperty</code>. This is useful for any kind of property types, with the
 exception of HTML documents.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>propertyName</code> - the property name in <code>ResourceProperties</code></dd>
<dd><code>boundProperty</code> - the object to bind</dd>
<dd><code>callback</code> - the callback that will notify updates</dd>
</dl>
</li>
</ul>
<a id="createBoundDocument(it.tidalwave.util.Key,it.tidalwave.northernwind.rca.ui.contenteditor.spi.PropertyBinder.UpdateCallback)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createBoundDocument</h4>
<pre class="methodSignature">@Nonnull
<a href="http://tidalwave.it/projects/northernwind-rca/northernwind-rca-modules/it-tidalwave-northernwind-rca-embeddedserver/apidocs/it/tidalwave/northernwind/rca/embeddedserver/EmbeddedServer.Document.html?is-external=true" title="class or interface in it.tidalwave.northernwind.rca.embeddedserver" class="externalLink">EmbeddedServer.Document</a>&nbsp;createBoundDocument&#8203;(@Nonnull
                                            it.tidalwave.util.Key&lt;java.lang.String&gt;&nbsp;propertyName,
                                            @Nonnull
                                            <a href="PropertyBinder.UpdateCallback.html" title="interface in it.tidalwave.northernwind.rca.ui.contenteditor.spi">PropertyBinder.UpdateCallback</a>&nbsp;callback)</pre>
<div class="block">Creates a Document bound to the given property. This is useful for HTML documents, since they undergo a special
 processing for being edited in a HTML viewer (CSS and JavaScript resources are inserted in the head).

 FIXME: I don't like the asymmetry with bind(), that accepts a BoundProperty. This is due to the fact that
I don't like the asymmetry with bind(), that accepts a BoundProperty. This is due to the fact that
BoundProperty is mutable, while Document is immutable. Actually, a mutable Document would be acceptable.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>propertyName</code> - the property name in <code>ResourceProperties</code></dd> <dd><code>callback</code> - the callback that will notify updates</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the bound document</dd> </dl> </li> </ul> </li> </ul> </section> </li> </ul> </div> </div> </main> <!-- ========= END OF CLASS DATA ========= --> <footer role="contentinfo"> <nav role="navigation"> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a id="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/PropertyBinder.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../../../index-all.html">Index</a></li> <li><a href="../../../../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary:&nbsp;</li> <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li> <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </nav> <p class="legalCopy"><small>Copyright &#169; 2013&#x2013;2023 <a href="http://tidalwave.it">Tidalwave s.a.s.</a>. All rights reserved.</small></p> </footer> </body> </html>