RubyGems - rmobio - Versions diffs - 1.1.8 → 1.1.9 - Mend

rmobio 1.1.8 → 1.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (457) hide show

data/lib/rmobio/doc/classes/Rmobio/Rxml/BaseTransformer.html ADDED Viewed

@@ -0,0 +1,733 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Rmobio::Rxml::BaseTransformer</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Rmobio::Rxml::BaseTransformer</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/rxml/base_transformer_rb.html">
+                rxml/base_transformer.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Builder::XmlMarkup
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Provide a base transformer to translate rxml document to xhtml markup. It
+subclasses the builder library XmlMarkup class so method not defined in
+this transformer class will inherit methods or method missing from
+XmlMarkup class. See XmlMarkup for documentation.
+</p>
+<p>
+Example: In the controller, get the proper transformer class by passing a
+client type, See TransformerFactory class for supported client types:
+</p>
+<pre>
+  require 'rmobio/rxml/transformer_factory'
+  @xml = TransformerFactory.get_transformer('xhtml')
+</pre>
+<p>
+Here is the view that uses methods to output xhtml document header, an <a
+href="BaseTransformer.html#M000034">image</a> and some <a
+href="BaseTransformer.html#M000025">text</a>:
+</p>
+<pre>
+    @xml.doctype(xml) do |x|
+      @xml.body(x, 'mobio') do|body|
+        @xml.image(body, &quot;img1&quot;, 'http://localhost:3000/images/rails.png')
+        @xml.softBr(body)
+        body.b do |y|
+          @xml.text(y, 'My test app')
+        end
+      end
+    end
+</pre>
+<p>
+The above code generates the following xhtml in Firefox:
+</p>
+<pre>
+     &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;
+     &lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Transitional//EN&quot; &quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd&quot;&gt;
+     &lt;html xmlns=&quot;http://www.w3.org/1999/xhtml&quot; xml:lang=&quot;en&quot; lang=&quot;en&quot;&gt;
+     &lt;head&gt;&lt;title&gt;mobio&lt;/title&gt;&lt;/head&gt;&lt;body&gt;
+     &lt;img id=&quot;img1&quot; src=&quot;http://localhost:3000/images/rails.png&quot; /&gt;&lt;br/&gt;
+     &lt;b&gt;
+     My test app&lt;/b&gt;
+     &lt;/body&gt;&lt;/html&gt;
+</pre>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000024">body</a>&nbsp;&nbsp;
+      <a href="#M000021">cattr_accessor</a>&nbsp;&nbsp;
+      <a href="#M000019">cattr_reader</a>&nbsp;&nbsp;
+      <a href="#M000020">cattr_writer</a>&nbsp;&nbsp;
+      <a href="#M000023">doctype</a>&nbsp;&nbsp;
+      <a href="#M000029">form</a>&nbsp;&nbsp;
+      <a href="#M000034">image</a>&nbsp;&nbsp;
+      <a href="#M000027">input</a>&nbsp;&nbsp;
+      <a href="#M000035">instance_tag</a>&nbsp;&nbsp;
+      <a href="#M000030">link</a>&nbsp;&nbsp;
+      <a href="#M000031">model_tag</a>&nbsp;&nbsp;
+      <a href="#M000018">new</a>&nbsp;&nbsp;
+      <a href="#M000033">softBr</a>&nbsp;&nbsp;
+      <a href="#M000028">submit_tag</a>&nbsp;&nbsp;
+      <a href="#M000036">table</a>&nbsp;&nbsp;
+      <a href="#M000038">table_cell</a>&nbsp;&nbsp;
+      <a href="#M000037">table_row</a>&nbsp;&nbsp;
+      <a href="#M000025">text</a>&nbsp;&nbsp;
+      <a href="#M000026">textarea</a>&nbsp;&nbsp;
+      <a href="#M000022">transform</a>&nbsp;&nbsp;
+      <a href="#M000032">view_tag</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+      <div id="includes-list">
+        <span class="include-name">Singleton</span>
+      </div>
+    </div>
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000018" class="method-detail">
+        <a name="M000018"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000018.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000018.html');return false;">
+          <span class="method-name">new</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Create a base rxml transformer to <a
+href="BaseTransformer.html#M000022">transform</a> rxml document to xhtml
+markup
+</p>
+<table>
+<tr><td valign="top">out:</td><td>Object receiving the markup in xhtml
+</td></tr>
+<tr><td valign="top">@view_buffer:</td><td>buffer to hold the view part of the document
+</td></tr>
+<tr><td valign="top">@model_buffer:</td><td>buffer to hold the model data of the document
+</td></tr>
+</table>
+<p>
+Final document is view_buffer + model_buffer for some subclass transformer
+(<a href="XformsTransformer.html">XformsTransformer</a>)
+</p>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000024" class="method-detail">
+        <a name="M000024"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000024.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000024.html');return false;">
+          <span class="method-name">body</span><span class="method-args">(doc, title=&quot;&quot;,style=nil) {|doc| ...}</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Generate xthml head and <a href="BaseTransformer.html#M000024">body</a>
+tag. The document title and style src are optional.
+</p>
+<h4>Examples</h4>
+<pre>
+  @xml.body(x, 'mobio', &quot;../stylesheets/css/mobio_twitter.css&quot;)
+</pre>
+<p>
+Xhtml output:
+</p>
+<pre>
+  &lt;head&gt;&lt;meta http-equiv=&quot;Content-Type&quot; content=&quot;text/xhtml; charset=UTF-8&quot; /&gt;
+  &lt;link href=&quot;../stylesheets/css/mobio_twitter.css&quot; rel=&quot;stylesheet&quot; type=&quot;text/css&quot; /&gt;
+  &lt;title&gt;mobio&lt;/title&gt;&lt;/head&gt;&lt;body&gt;
+  &lt;/body&gt;
+</pre>
+        </div>
+      </div>
+      <div id="method-M000021" class="method-detail">
+        <a name="M000021"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000021.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000021.html');return false;">
+          <span class="method-name">cattr_accessor</span><span class="method-args">(*syms)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000019" class="method-detail">
+        <a name="M000019"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000019.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000019.html');return false;">
+          <span class="method-name">cattr_reader</span><span class="method-args">(*syms)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000020" class="method-detail">
+        <a name="M000020"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000020.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000020.html');return false;">
+          <span class="method-name">cattr_writer</span><span class="method-args">(*syms)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000023" class="method-detail">
+        <a name="M000023"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000023.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000023.html');return false;">
+          <span class="method-name">doctype</span><span class="method-args">(xml) {|xml| ...}</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Generate standdard xhtml document header
+</p>
+        </div>
+      </div>
+      <div id="method-M000029" class="method-detail">
+        <a name="M000029"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000029.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000029.html');return false;">
+          <span class="method-name">form</span><span class="method-args">(doc, id, action, method) {|doc| ...}</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Create <a href="BaseTransformer.html#M000029">form</a> tag for submission
+</p>
+<ol>
+<li>id: name of the <a href="BaseTransformer.html#M000029">form</a>
+</li>
+<li>action: the action url that is invoked
+</li>
+<li>method: http &#8216;get&#8217; or &#8216;post&#8216;
+</li>
+<li>req_id: not used in html client
+</li>
+<li>replace_id: not used in html client
+</li>
+</ol>
+        </div>
+      </div>
+      <div id="method-M000034" class="method-detail">
+        <a name="M000034"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000034.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000034.html');return false;">
+          <span class="method-name">image</span><span class="method-args">(doc, id, src, options={})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Create html img tag.
+</p>
+<ol>
+<li>id: name of the widget
+</li>
+<li>src: the url of the <a href="BaseTransformer.html#M000034">image</a>
+</li>
+</ol>
+<h4>Options</h4>
+<ul>
+<li><tt>:style</tt> &#8212; specifies html, xhtml style attributes as a string
+</li>
+<li><tt>:alt</tt> &#8212; html alt attribute
+</li>
+</ul>
+        </div>
+      </div>
+      <div id="method-M000027" class="method-detail">
+        <a name="M000027"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000027.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000027.html');return false;">
+          <span class="method-name">input</span><span class="method-args">(doc, id, value, type, options={})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Create user <a href="BaseTransformer.html#M000027">input</a> field.
+</p>
+<ol>
+<li>id: not used in xhtml client
+</li>
+<li>value: initial value that will be displayed when ui is loaded
+</li>
+<li>type: html <a href="BaseTransformer.html#M000027">input</a> type attriute,
+&quot;<a href="BaseTransformer.html#M000025">text</a>&quot;,
+&quot;password&quot;, &quot;submit&quot;, etc.
+</li>
+</ol>
+<h4>Options</h4>
+<ul>
+<li><tt>:xstyle</tt> &#8212; specifies xforms style attributes as a string
+</li>
+<li><tt>:xpath</tt> &#8212; specifies the xpath of the <a
+href="BaseTransformer.html#M000027">input</a> data in the model
+</li>
+</ul>
+<h4>Examples</h4>
+<ul>
+<li>a <a href="BaseTransformer.html#M000025">text</a> <a
+href="BaseTransformer.html#M000027">input</a> box
+<pre>
+   @xml.input(f, &quot;name&quot;, &quot;john&quot;, &quot;text&quot;)
+</pre>
+</li>
+</ul>
+<p>
+generates the xhtml:
+</p>
+<pre>
+     &lt;input  type=&quot;text&quot; name=&quot;name&quot; value=&quot;john&quot;/&gt;
+</pre>
+<ul>
+<li>a password <a href="BaseTransformer.html#M000027">input</a> box
+<pre>
+   @xml.input(f, &quot;password&quot;, &quot;&quot;, &quot;password&quot;)
+</pre>
+</li>
+</ul>
+<p>
+generates the xhtml:
+</p>
+<pre>
+     &lt;input  type=&quot;password&quot; name=&quot;password&quot; value=&quot;&quot;/&gt;
+</pre>
+<ul>
+<li>a submit button
+<pre>
+   @xml.input(f, &quot;submit&quot;, &quot;Login&quot;, &quot;submit&quot;)
+</pre>
+</li>
+</ul>
+<p>
+generates a submit button:
+</p>
+<pre>
+     &lt;input  type=&quot;submit&quot; name=&quot;submit&quot; value=&quot;Login&quot;/&gt;
+</pre>
+        </div>
+      </div>
+      <div id="method-M000035" class="method-detail">
+        <a name="M000035"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000035.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000035.html');return false;">
+          <span class="method-name">instance_tag</span><span class="method-args">(doc, id)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Not implemented for html client
+</p>
+        </div>
+      </div>
+      <div id="method-M000030" class="method-detail">
+        <a name="M000030"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000030.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000030.html');return false;">
+          <span class="method-name">link</span><span class="method-args">(doc, href, txt=&quot;&quot;, options={}, &amp;block)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Create a html <a href="BaseTransformer.html#M000030">link</a>
+</p>
+<ol>
+<li>href: the <a href="BaseTransformer.html#M000030">link</a> url
+</li>
+<li>txt: <a href="BaseTransformer.html#M000025">text</a> displayed in the <a
+href="BaseTransformer.html#M000030">link</a>
+</li>
+</ol>
+<h4>Options</h4>
+<ul>
+<li><tt>:style</tt> &#8212; specifies html, xhtml style attributes as a string
+</li>
+</ul>
+        </div>
+      </div>
+      <div id="method-M000031" class="method-detail">
+        <a name="M000031"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000031.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000031.html');return false;">
+          <span class="method-name">model_tag</span><span class="method-args">(doc, txt)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Not implemented for xhtml client
+</p>
+        </div>
+      </div>
+      <div id="method-M000033" class="method-detail">
+        <a name="M000033"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000033.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000033.html');return false;">
+          <span class="method-name">softBr</span><span class="method-args">(doc)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Line break
+</p>
+        </div>
+      </div>
+      <div id="method-M000028" class="method-detail">
+        <a name="M000028"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000028.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000028.html');return false;">
+          <span class="method-name">submit_tag</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000036" class="method-detail">
+        <a name="M000036"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000036.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000036.html');return false;">
+          <span class="method-name">table</span><span class="method-args">(doc, style=&quot;&quot;, xstyle=&quot;&quot;) {|doc| ...}</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Create <a href="BaseTransformer.html#M000036">table</a> tag
+</p>
+<ol>
+<li>style: html styles
+</li>
+<li>xstyle: xforms styles
+</li>
+</ol>
+        </div>
+      </div>
+      <div id="method-M000038" class="method-detail">
+        <a name="M000038"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000038.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000038.html');return false;">
+          <span class="method-name">table_cell</span><span class="method-args">(doc, style=&quot;&quot;, xstyle=&quot;&quot;) {|doc| ...}</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000037" class="method-detail">
+        <a name="M000037"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000037.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000037.html');return false;">
+          <span class="method-name">table_row</span><span class="method-args">(doc, style=&quot;&quot;, xstyle=&quot;&quot;) {|doc| ...}</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000025" class="method-detail">
+        <a name="M000025"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000025.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000025.html');return false;">
+          <span class="method-name">text</span><span class="method-args">(doc, txt=&quot;&quot;, options={})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Produce a <a href="BaseTransformer.html#M000025">text</a> string. To apply
+style for <a href="BaseTransformer.html#M000025">text</a>, wrap the tag
+with xml tag:
+</p>
+<h4>Examples</h4>
+<pre>
+  xml.i do |y|
+      @xml.text(y, &quot;my italic example&quot;)
+  end
+</pre>
+<p>
+Generates the following xhtml code:
+</p>
+<pre>
+ &lt;i&gt;
+ my italic example
+ &lt;/i&gt;
+</pre>
+        </div>
+      </div>
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000026.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000026.html');return false;">
+          <span class="method-name">textarea</span><span class="method-args">(doc, txt=&quot;&quot;, options={})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Create a <a href="BaseTransformer.html#M000025">text</a> box. To apply
+style for <a href="BaseTransformer.html#M000025">text</a>, wrap the tag
+with xml tag. Extra html style (cols, rows, etc.) can be specified in the
+hash variable options.
+</p>
+<h5>Options</h5>
+<ul>
+<li><tt>:style</tt> &#8212; specifies html, xhtml style attributes like cols,
+rows, etc. as a string
+</li>
+<li><tt>:xstyle</tt> &#8212; specifies xforms style attributes like height,
+width, etc. as a string.
+</li>
+</ul>
+<h4>Examples</h4>
+<pre>
+  @xml.textare(body, &quot;some text&quot;,
+     :style=&gt;'class=&quot;white&quot;', :xstyle=&gt;'height=&quot;3ex&quot; style=&quot;white&quot;')
+</pre>
+<p>
+generates the following xhtml code:
+</p>
+<pre>
+    &lt;textarea class=&quot;white&quot; name=&quot;&quot;&gt;some text&lt;/textarea&gt;
+</pre>
+        </div>
+      </div>
+      <div id="method-M000022" class="method-detail">
+        <a name="M000022"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000022.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000022.html');return false;">
+          <span class="method-name">transform</span><span class="method-args">(xml, client=nil)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+To be implemented.
+</p>
+        </div>
+      </div>
+      <div id="method-M000032" class="method-detail">
+        <a name="M000032"></a>
+        <div class="method-heading">
+          <a href="BaseTransformer.src/M000032.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseTransformer.src/M000032.html');return false;">
+          <span class="method-name">view_tag</span><span class="method-args">(doc, txt)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Not implemented for xhtml client
+</p>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>