Doc update

This commit is contained in:
Eric Espie
2021-09-28 17:35:33 +02:00
parent c02f3202d9
commit 6e9c6eeb23
86 changed files with 6314 additions and 18756 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ButtonGroup &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>ButtonGroup &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -102,169 +105,154 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="buttongroup">
<span id="id1"></span><h1>ButtonGroup<a class="headerlink" href="#buttongroup" title="Permalink to this headline"></a></h1>
<section id="buttongroup">
<span id="id1"></span><h1>ButtonGroup<a class="headerlink" href="#buttongroup" title="Permalink to this headline"></a></h1>
<p>Class ButtonGroup</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIButtonGroup</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIButtonGroup</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIButtonGroup</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="40%" />
<col width="60%" />
<col style="width: 40%" />
<col style="width: 60%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#buttongroupbuttonwithoptionsmenu"><span class="std std-ref">ButtonWithOptionsMenu</span></a></td>
<td>Make a button that has a primary action ($oButton) but also an options menu ($oMenu) on the side</td>
</tr>
</tbody>
</table>
<div class="section" id="buttongroup-buttonwithoptionsmenu">
<span id="buttongroupbuttonwithoptionsmenu"></span><h3>ButtonGroup ButtonWithOptionsMenu<a class="headerlink" href="#buttongroup-buttonwithoptionsmenu" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#buttongroupbuttonwithoptionsmenu"><span class="std std-ref">ButtonWithOptionsMenu</span></a></p></td>
<td><p>Make a button that has a primary action ($oButton) but also an options menu ($oMenu) on the side</p></td>
</tr>
</tbody>
</table>
<section id="buttongroup-buttonwithoptionsmenu">
<span id="buttongroupbuttonwithoptionsmenu"></span><h3>ButtonGroup ButtonWithOptionsMenu<a class="headerlink" href="#buttongroup-buttonwithoptionsmenu" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIButtonGroup</span> <span class="p">B</span><span class="nv">uttonWithOptionsMenu</span> <span class="o">{</span><span class="nv">oButton</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">oMenu</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 24%" />
<col style="width: 35%" />
<col style="width: 30%" />
<col style="width: 5%" />
<col style="width: 5%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>oButton</p></td>
<td><p>Button</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>oMenu</p></td>
<td><p>PopoverMenu</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="buttongroup-common-parameters">
<h3>ButtonGroup common parameters<a class="headerlink" href="#buttongroup-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="24%" />
<col width="35%" />
<col width="30%" />
<col width="5%" />
<col width="5%" />
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>oButton</td>
<td>Button</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddButton</p></td>
<td><p>Button</p></td>
<td></td>
</tr>
<tr class="row-even"><td>oMenu</td>
<td>PopoverMenu</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddButtons</p></td>
<td><p>array</p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="buttongroup-common-parameters">
<h3>ButtonGroup common parameters<a class="headerlink" href="#buttongroup-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddButton</td>
<td>Button</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>AddButtons</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>AddExtraBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddExtraBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>Buttons</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>Buttons</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
</tr>
<tr class="row-even"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
<tr class="row-even"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CollapsibleSection &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>CollapsibleSection &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -102,177 +105,162 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="collapsiblesection">
<span id="id1"></span><h1>CollapsibleSection<a class="headerlink" href="#collapsiblesection" title="Permalink to this headline"></a></h1>
<section id="collapsiblesection">
<span id="id1"></span><h1>CollapsibleSection<a class="headerlink" href="#collapsiblesection" title="Permalink to this headline"></a></h1>
<p>Class CollapsibleSection</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UICollapsibleSection</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UICollapsibleSection</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UICollapsibleSection</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUICollapsibleSection</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="79%" />
<col width="21%" />
<col style="width: 79%" />
<col style="width: 21%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#collapsiblesectionstandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
</tr>
</tbody>
</table>
<div class="section" id="collapsiblesection-standard">
<span id="collapsiblesectionstandard"></span><h3>CollapsibleSection Standard<a class="headerlink" href="#collapsiblesection-standard" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#collapsiblesectionstandard"><span class="std std-ref">Standard</span></a></p></td>
<td><p>No comment</p></td>
</tr>
</tbody>
</table>
<section id="collapsiblesection-standard">
<span id="collapsiblesectionstandard"></span><h3>CollapsibleSection Standard<a class="headerlink" href="#collapsiblesection-standard" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UICollapsibleSection</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUICollapsibleSection</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 23%" />
<col style="width: 23%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sTitle</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="collapsiblesection-common-parameters">
<h3>CollapsibleSection common parameters<a class="headerlink" href="#collapsiblesection-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="23%" />
<col width="23%" />
<col width="31%" />
<col width="17%" />
<col width="6%" />
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sTitle</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="collapsiblesection-common-parameters">
<h3>CollapsibleSection common parameters<a class="headerlink" href="#collapsiblesection-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-odd"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>OpenedByDefault</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
<tr class="row-even"><td>OpenedByDefault</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>UI Components &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<title>UI Components &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> iTop UI<img src="../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../index.html" class="icon icon-home"> iTop UI
<img src="../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">UI Components</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Alert/Alert.html">Alert</a></li>
@@ -92,11 +95,11 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="ui-components">
<span id="components"></span><h1>UI Components<a class="headerlink" href="#ui-components" title="Permalink to this headline"></a></h1>
<section id="ui-components">
<span id="components"></span><h1>UI Components<a class="headerlink" href="#ui-components" title="Permalink to this headline"></a></h1>
<p>A UI component is a unitary block used to display information in iTop console.</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Components:</span></p>
<p class="caption" role="heading"><span class="caption-text">Components:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Alert/Alert.html">Alert</a></li>
<li class="toctree-l1"><a class="reference internal" href="Button/Button.html">Button</a></li>
@@ -118,7 +121,7 @@
<li class="toctree-l1"><a class="reference internal" href="Toolbar/ToolbarSpacer/ToolbarSpacer.html">ToolbarSpacer</a></li>
</ul>
</div>
</div>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>DataTable &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>DataTable &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -107,547 +110,492 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="datatable">
<span id="id1"></span><h1>DataTable<a class="headerlink" href="#datatable" title="Permalink to this headline"></a></h1>
<section id="datatable">
<span id="id1"></span><h1>DataTable<a class="headerlink" href="#datatable" title="Permalink to this headline"></a></h1>
<p>Class DataTable</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>Dynamic DataTable</p>
<img alt="../../../_images/Datatable.png" src="../../../_images/Datatable.png" />
<p>Static DataTable</p>
<img alt="../../../_images/DatatableStatic.png" src="../../../_images/DatatableStatic.png" />
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIDataTable</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIDataTable</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="66%" />
<col width="34%" />
<col style="width: 66%" />
<col style="width: 34%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#datatableforresult"><span class="std std-ref">ForResult</span></a></td>
<td>&#64;param WebPage $oPage</td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datatableforresult"><span class="std std-ref">ForResult</span></a></p></td>
<td><p>&#64;param WebPage $oPage</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#datatableforobject"><span class="std std-ref">ForObject</span></a></td>
<td>&#64;param WebPage $oPage</td>
<tr class="row-even"><td><p><a class="reference internal" href="#datatableforobject"><span class="std std-ref">ForObject</span></a></p></td>
<td><p>&#64;param WebPage $oPage</p></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#datatableforrendering"><span class="std std-ref">ForRendering</span></a></td>
<td>Make a basis Panel component</td>
<tr class="row-odd"><td><p><a class="reference internal" href="#datatableforrendering"><span class="std std-ref">ForRendering</span></a></p></td>
<td><p>Make a basis Panel component</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#datatableforrenderingobject"><span class="std std-ref">ForRenderingObject</span></a></td>
<td>&#64;param string $sListId</td>
<tr class="row-even"><td><p><a class="reference internal" href="#datatableforrenderingobject"><span class="std std-ref">ForRenderingObject</span></a></p></td>
<td><p>&#64;param string $sListId</p></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#datatableforstaticdata"><span class="std std-ref">ForStaticData</span></a></td>
<td>&#64;param string $sTitle</td>
<tr class="row-odd"><td><p><a class="reference internal" href="#datatableforstaticdata"><span class="std std-ref">ForStaticData</span></a></p></td>
<td><p>&#64;param string $sTitle</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#datatableforform"><span class="std std-ref">ForForm</span></a></td>
<td>&#64;param string $sRef</td>
</tr>
</tbody>
</table>
<div class="section" id="datatable-forresult">
<span id="datatableforresult"></span><h3>DataTable ForResult<a class="headerlink" href="#datatable-forresult" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p><a class="reference internal" href="#datatableforform"><span class="std std-ref">ForForm</span></a></p></td>
<td><p>&#64;param string $sRef</p></td>
</tr>
</tbody>
</table>
<section id="datatable-forresult">
<span id="datatableforresult"></span><h3>DataTable ForResult<a class="headerlink" href="#datatable-forresult" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orResult</span> <span class="o">{</span><span class="nv">oPage</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sListId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="28%" />
<col width="26%" />
<col width="22%" />
<col width="20%" />
<col width="4%" />
<col style="width: 28%" />
<col style="width: 26%" />
<col style="width: 22%" />
<col style="width: 20%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>oPage</td>
<td>WebPage</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>oPage</p></td>
<td><p>WebPage</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sListId</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>sListId</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>oSet</td>
<td>DBObjectSet</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>oSet</p></td>
<td><p>DBObjectSet</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>aExtraParams</td>
<td>&#160;</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-forobject">
<span id="datatableforobject"></span><h3>DataTable ForObject<a class="headerlink" href="#datatable-forobject" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p>aExtraParams</p></td>
<td></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="datatable-forobject">
<span id="datatableforobject"></span><h3>DataTable ForObject<a class="headerlink" href="#datatable-forobject" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orObject</span> <span class="o">{</span><span class="nv">oPage</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sListId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="28%" />
<col width="26%" />
<col width="22%" />
<col width="20%" />
<col width="4%" />
<col style="width: 28%" />
<col style="width: 26%" />
<col style="width: 22%" />
<col style="width: 20%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>oPage</td>
<td>WebPage</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>oPage</p></td>
<td><p>WebPage</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sListId</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>sListId</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>oSet</td>
<td>DBObjectSet</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>oSet</p></td>
<td><p>DBObjectSet</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>aExtraParams</td>
<td>&#160;</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-forrendering">
<span id="datatableforrendering"></span><h3>DataTable ForRendering<a class="headerlink" href="#datatable-forrendering" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p>aExtraParams</p></td>
<td></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="datatable-forrendering">
<span id="datatableforrendering"></span><h3>DataTable ForRendering<a class="headerlink" href="#datatable-forrendering" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orRendering</span> <span class="o">{</span><span class="nv">sListId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="28%" />
<col width="26%" />
<col width="22%" />
<col width="20%" />
<col width="4%" />
<col style="width: 28%" />
<col style="width: 26%" />
<col style="width: 22%" />
<col style="width: 20%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sListId</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sListId</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>oSet</td>
<td>DBObjectSet</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>oSet</p></td>
<td><p>DBObjectSet</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>aExtraParams</td>
<td>&#160;</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-forrenderingobject">
<span id="datatableforrenderingobject"></span><h3>DataTable ForRenderingObject<a class="headerlink" href="#datatable-forrenderingobject" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p>aExtraParams</p></td>
<td></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="datatable-forrenderingobject">
<span id="datatableforrenderingobject"></span><h3>DataTable ForRenderingObject<a class="headerlink" href="#datatable-forrenderingobject" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orRenderingObject</span> <span class="o">{</span><span class="nv">sListId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="28%" />
<col width="26%" />
<col width="22%" />
<col width="20%" />
<col width="4%" />
<col style="width: 28%" />
<col style="width: 26%" />
<col style="width: 22%" />
<col style="width: 20%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sListId</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sListId</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>oSet</td>
<td>DBObjectSet</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>oSet</p></td>
<td><p>DBObjectSet</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>aExtraParams</td>
<td>&#160;</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-forstaticdata">
<span id="datatableforstaticdata"></span><h3>DataTable ForStaticData<a class="headerlink" href="#datatable-forstaticdata" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p>aExtraParams</p></td>
<td></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="datatable-forstaticdata">
<span id="datatableforstaticdata"></span><h3>DataTable ForStaticData<a class="headerlink" href="#datatable-forstaticdata" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orStaticData</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">aColumns</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">aData</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">sFilter</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">aOptions</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">}}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="31%" />
<col width="18%" />
<col width="24%" />
<col width="22%" />
<col width="4%" />
<col style="width: 31%" />
<col style="width: 18%" />
<col style="width: 24%" />
<col style="width: 22%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sTitle</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sTitle</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>aColumns</td>
<td>array</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>aColumns</p></td>
<td><p>array</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>aData</td>
<td>array</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>aData</p></td>
<td><p>array</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tr class="row-even"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>aExtraParams</td>
<td>array</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>aExtraParams</p></td>
<td><p>array</p></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
<tr class="row-even"><td>sFilter</td>
<td>string</td>
<td>optional</td>
<td></td>
<td>&#160;</td>
<tr class="row-even"><td><p>sFilter</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p></p></td>
<td></td>
</tr>
<tr class="row-odd"><td>aOptions</td>
<td>array</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-forform">
<span id="datatableforform"></span><h3>DataTable ForForm<a class="headerlink" href="#datatable-forform" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p>aOptions</p></td>
<td><p>array</p></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="datatable-forform">
<span id="datatableforform"></span><h3>DataTable ForForm<a class="headerlink" href="#datatable-forform" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orForm</span> <span class="o">{</span><span class="nv">sRef</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">aColumns</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">aData</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">sFilter</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 24%" />
<col style="width: 20%" />
<col style="width: 27%" />
<col style="width: 24%" />
<col style="width: 5%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sRef</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>aColumns</p></td>
<td><p>array</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>aData</p></td>
<td><p>array</p></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>sFilter</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p></p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="datatable-common-parameters">
<h3>DataTable common parameters<a class="headerlink" href="#datatable-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="24%" />
<col width="20%" />
<col width="27%" />
<col width="24%" />
<col width="5%" />
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sRef</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>aColumns</td>
<td>array</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>aData</td>
<td>array</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>sFilter</td>
<td>string</td>
<td>optional</td>
<td></td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-common-parameters">
<h3>DataTable common parameters<a class="headerlink" href="#datatable-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AjaxData</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AjaxUrl</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-even"><td>AjaxData</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AjaxUrl</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DisplayColumns</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>InitDisplayData</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-odd"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>JSRefresh</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DisplayColumns</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>Options</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>InitDisplayData</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>ResultColumns</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
<tr class="row-even"><td>JSRefresh</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>Options</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>ResultColumns</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
<p>The columns (<em>aColumns</em>) have the following format:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">[</span>
<span class="x"> &#39;nameField1&#39; =&gt; [&#39;label&#39; =&gt; labelField1, &#39;description&#39; =&gt; descriptionField1],</span>
<span class="x"> ...</span>
<span class="x">]</span>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
<span class="s1">&#39;nameField1&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;label&#39;</span> <span class="o">=&gt;</span> <span class="nx">labelField1</span><span class="p">,</span> <span class="s1">&#39;description&#39;</span> <span class="o">=&gt;</span> <span class="nx">descriptionField1</span><span class="p">],</span>
<span class="o">...</span>
<span class="p">]</span>
</pre></div>
</div>
<p>The data (<em>aData</em>) format has to be:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">[</span>
<span class="x"> [&#39;nameField1&#39; =&gt; valueField1, &#39;nameField2&#39; =&gt; valueField2, ...],</span>
<span class="x"> ...</span>
<span class="x">]</span>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
<span class="p">[</span><span class="s1">&#39;nameField1&#39;</span> <span class="o">=&gt;</span> <span class="nx">valueField1</span><span class="p">,</span> <span class="s1">&#39;nameField2&#39;</span> <span class="o">=&gt;</span> <span class="nx">valueField2</span><span class="p">,</span> <span class="o">...</span><span class="p">],</span>
<span class="o">...</span>
<span class="p">]</span>
</pre></div>
</div>
</div>
</div>
</section>
</section>
<hr class="docutils" />
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Field &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>Field &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -106,457 +109,403 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="field">
<span id="id1"></span><h1>Field<a class="headerlink" href="#field" title="Permalink to this headline"></a></h1>
<section id="field">
<span id="id1"></span><h1>Field<a class="headerlink" href="#field" title="Permalink to this headline"></a></h1>
<p>Class Field</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Example Fields:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Example Fields</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<img alt="../../../_images/Field.png" src="../../../_images/Field.png" />
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIField</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIField</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="76%" />
<col width="24%" />
<col style="width: 76%" />
<col style="width: 24%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#fieldfromparams"><span class="std std-ref">FromParams</span></a></td>
<td>No comment</td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#fieldfromparams"><span class="std std-ref">FromParams</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#fieldfromobject"><span class="std std-ref">FromObject</span></a></td>
<td>No comment</td>
<tr class="row-even"><td><p><a class="reference internal" href="#fieldfromobject"><span class="std std-ref">FromObject</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#fieldlarge"><span class="std std-ref">Large</span></a></td>
<td>No comment</td>
<tr class="row-odd"><td><p><a class="reference internal" href="#fieldlarge"><span class="std std-ref">Large</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#fieldsmall"><span class="std std-ref">Small</span></a></td>
<td>No comment</td>
<tr class="row-even"><td><p><a class="reference internal" href="#fieldsmall"><span class="std std-ref">Small</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#fieldstandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
</tr>
</tbody>
</table>
<div class="section" id="field-fromparams">
<span id="fieldfromparams"></span><h3>Field FromParams<a class="headerlink" href="#field-fromparams" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#fieldstandard"><span class="std std-ref">Standard</span></a></p></td>
<td><p>No comment</p></td>
</tr>
</tbody>
</table>
<section id="field-fromparams">
<span id="fieldfromparams"></span><h3>Field FromParams<a class="headerlink" href="#field-fromparams" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">F</span><span class="nv">romParams</span> <span class="o">{</span><span class="nv">aParams</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="35%" />
<col width="8%" />
<col width="42%" />
<col width="8%" />
<col width="8%" />
<col style="width: 35%" />
<col style="width: 8%" />
<col style="width: 42%" />
<col style="width: 8%" />
<col style="width: 8%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>aParams</td>
<td>&#160;</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="field-fromobject">
<span id="fieldfromobject"></span><h3>Field FromObject<a class="headerlink" href="#field-fromobject" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p>aParams</p></td>
<td></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="field-fromobject">
<span id="fieldfromobject"></span><h3>Field FromObject<a class="headerlink" href="#field-fromobject" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">F</span><span class="nv">romObject</span> <span class="o">{</span><span class="nv">sLabel</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">oInput</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sLayout</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="24%" />
<col width="24%" />
<col width="30%" />
<col width="16%" />
<col width="5%" />
<col style="width: 24%" />
<col style="width: 24%" />
<col style="width: 30%" />
<col style="width: 16%" />
<col style="width: 5%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sLabel</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sLabel</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>oInput</td>
<td>UIBlock</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>oInput</p></td>
<td><p>UIBlock</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>sLayout</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="field-large">
<span id="fieldlarge"></span><h3>Field Large<a class="headerlink" href="#field-large" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p>sLayout</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="field-large">
<span id="fieldlarge"></span><h3>Field Large<a class="headerlink" href="#field-large" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">L</span><span class="nv">arge</span> <span class="o">{</span><span class="nv">sLabel</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sValueHtml</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="32%" />
<col width="22%" />
<col width="30%" />
<col width="11%" />
<col width="5%" />
<col style="width: 32%" />
<col style="width: 22%" />
<col style="width: 30%" />
<col style="width: 11%" />
<col style="width: 5%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sLabel</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sLabel</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sValueHtml</td>
<td>string</td>
<td>optional</td>
<td></td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="field-small">
<span id="fieldsmall"></span><h3>Field Small<a class="headerlink" href="#field-small" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p>sValueHtml</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p></p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="field-small">
<span id="fieldsmall"></span><h3>Field Small<a class="headerlink" href="#field-small" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">S</span><span class="nv">mall</span> <span class="o">{</span><span class="nv">sLabel</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sValueHtml</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="32%" />
<col width="22%" />
<col width="30%" />
<col width="11%" />
<col width="5%" />
<col style="width: 32%" />
<col style="width: 22%" />
<col style="width: 30%" />
<col style="width: 11%" />
<col style="width: 5%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sLabel</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sLabel</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sValueHtml</td>
<td>string</td>
<td>optional</td>
<td></td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="field-standard">
<span id="fieldstandard"></span><h3>Field Standard<a class="headerlink" href="#field-standard" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p>sValueHtml</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p></p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="field-standard">
<span id="fieldstandard"></span><h3>Field Standard<a class="headerlink" href="#field-standard" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sLabel</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sLayout</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIField</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 24%" />
<col style="width: 21%" />
<col style="width: 26%" />
<col style="width: 24%" />
<col style="width: 5%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sLabel</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>sLayout</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>small</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="field-common-parameters">
<h3>Field common parameters<a class="headerlink" href="#field-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="24%" />
<col width="21%" />
<col width="26%" />
<col width="24%" />
<col width="5%" />
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sLabel</td>
<td>string</td>
<td>optional</td>
<td></td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>sLayout</td>
<td>string</td>
<td>optional</td>
<td>small</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="field-common-parameters">
<h3>Field common parameters<a class="headerlink" href="#field-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AttCode</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AttLabel</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AttType</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AttCode</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AttLabel</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>Comments</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AttType</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-odd"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>Comments</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>InputId</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-even"><td><p>InputType</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-odd"><td>InputId</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>IsMandatory</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-even"><td>InputType</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>IsReadOnly</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
<tr class="row-even"><td><p>IsSlave</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-even"><td>IsMandatory</td>
<td>bool</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>Label</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>IsReadOnly</td>
<td>bool</td>
<td>&#160;</td>
<tr class="row-even"><td><p>Layout</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>IsSlave</td>
<td>bool</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>MustChange</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>Label</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>MustPrompt</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-even"><td>Layout</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>MustChange</td>
<td>bool</td>
<td>&#160;</td>
<tr class="row-even"><td><p>Value</p></td>
<td><p>UIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>MustPrompt</td>
<td>bool</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>ValueId</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>Value</td>
<td>UIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>ValueId</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>ValueRaw</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>ValueRaw</p></td>
<td><p>string</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Related Tag:</th><td class="field-body"><a class="reference internal" href="../FieldSet/FieldSet.html#fieldset"><span class="std std-ref">FieldSet</span></a></td>
</tr>
</tbody>
</table>
</div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Related Tag</dt>
<dd class="field-odd"><p><a class="reference internal" href="../FieldSet/FieldSet.html#fieldset"><span class="std std-ref">FieldSet</span></a></p>
</dd>
</dl>
</section>
</section>
<hr class="docutils" />
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>Example to generate a Field</p>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIField</span> <span class="p">S</span><span class="nv">mall</span> <span class="o">{</span><span class="nv">sLabel</span><span class="o">:</span> <span class="s2">&quot;Product&quot;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> iTop</span>
@@ -565,8 +514,8 @@
</div>
<p>The result:</p>
<img alt="../../../_images/Field.png" src="../../../_images/Field.png" />
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>FieldBadge &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>FieldBadge &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -102,173 +105,158 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="fieldbadge">
<span id="id1"></span><h1>FieldBadge<a class="headerlink" href="#fieldbadge" title="Permalink to this headline"></a></h1>
<section id="fieldbadge">
<span id="id1"></span><h1>FieldBadge<a class="headerlink" href="#fieldbadge" title="Permalink to this headline"></a></h1>
<p>Class FieldBadge</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIFieldBadge</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIFieldBadge</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFieldBadge</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIFieldBadge</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="62%" />
<col width="38%" />
<col style="width: 62%" />
<col style="width: 38%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#fieldbadgeforfield"><span class="std std-ref">ForField</span></a></td>
<td>&#64;param string $sValue</td>
</tr>
</tbody>
</table>
<div class="section" id="fieldbadge-forfield">
<span id="fieldbadgeforfield"></span><h3>FieldBadge ForField<a class="headerlink" href="#fieldbadge-forfield" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#fieldbadgeforfield"><span class="std std-ref">ForField</span></a></p></td>
<td><p>&#64;param string $sValue</p></td>
</tr>
</tbody>
</table>
<section id="fieldbadge-forfield">
<span id="fieldbadgeforfield"></span><h3>FieldBadge ForField<a class="headerlink" href="#fieldbadge-forfield" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFieldBadge</span> <span class="p">F</span><span class="nv">orField</span> <span class="o">{</span><span class="nv">sValue</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">oStyle</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIFieldBadge</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 24%" />
<col style="width: 30%" />
<col style="width: 33%" />
<col style="width: 6%" />
<col style="width: 6%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sValue</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>oStyle</p></td>
<td><p>ormStyle</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="fieldbadge-common-parameters">
<h3>FieldBadge common parameters<a class="headerlink" href="#fieldbadge-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="24%" />
<col width="30%" />
<col width="33%" />
<col width="6%" />
<col width="6%" />
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sValue</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>oStyle</td>
<td>ormStyle</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="fieldbadge-common-parameters">
<h3>FieldBadge common parameters<a class="headerlink" href="#fieldbadge-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-odd"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
<tr class="row-even"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>FieldSet &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>FieldSet &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -102,199 +105,176 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="fieldset">
<span id="id1"></span><h1>FieldSet<a class="headerlink" href="#fieldset" title="Permalink to this headline"></a></h1>
<section id="fieldset">
<span id="id1"></span><h1>FieldSet<a class="headerlink" href="#fieldset" title="Permalink to this headline"></a></h1>
<p>Class FieldSet</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name" colspan="2">Example FieldSets:</th></tr>
<tr class="field-odd field"><td>&#160;</td><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Example FieldSets</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<img alt="../../../_images/FieldSet.png" src="../../../_images/FieldSet.png" />
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIFieldSet</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIFieldSet</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFieldSet</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIFieldSet</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="75%" />
<col width="25%" />
<col style="width: 75%" />
<col style="width: 25%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#fieldsetstandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
</tr>
</tbody>
</table>
<div class="section" id="fieldset-standard">
<span id="fieldsetstandard"></span><h3>FieldSet Standard<a class="headerlink" href="#fieldset-standard" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#fieldsetstandard"><span class="std std-ref">Standard</span></a></p></td>
<td><p>No comment</p></td>
</tr>
</tbody>
</table>
<section id="fieldset-standard">
<span id="fieldsetstandard"></span><h3>FieldSet Standard<a class="headerlink" href="#fieldset-standard" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFieldSet</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sLegend</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIFieldSet</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 25%" />
<col style="width: 22%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sLegend</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="fieldset-common-parameters">
<h3>FieldSet common parameters<a class="headerlink" href="#fieldset-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="25%" />
<col width="22%" />
<col width="31%" />
<col width="17%" />
<col width="6%" />
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sLegend</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="fieldset-common-parameters">
<h3>FieldSet common parameters<a class="headerlink" href="#fieldset-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-odd"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
<tr class="row-even"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Related Tag:</th><td class="field-body"><a class="reference internal" href="../Field/Field.html#field"><span class="std std-ref">Field</span></a></td>
</tr>
</tbody>
</table>
</div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Related Tag</dt>
<dd class="field-odd"><p><a class="reference internal" href="../Field/Field.html#field"><span class="std std-ref">Field</span></a></p>
</dd>
</dl>
</section>
</section>
<hr class="docutils" />
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>Example to generate a FieldSet:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">{% UIFieldSet Standard {sLegend: &quot;iTop environment&quot;} %}</span>
<span class="x"> {% UIField ... %}</span>
<span class="x"> ...</span>
<span class="x">{% EndUIFieldSet %}</span>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="o">%</span> <span class="nx">UIFieldSet</span> <span class="nx">Standard</span> <span class="p">{</span><span class="nx">sLegend</span><span class="o">:</span> <span class="s2">&quot;iTop environment&quot;</span><span class="p">}</span> <span class="o">%</span><span class="p">}</span>
<span class="p">{</span><span class="o">%</span> <span class="nx">UIField</span> <span class="o">...</span> <span class="o">%</span><span class="p">}</span>
<span class="o">...</span>
<span class="p">{</span><span class="o">%</span> <span class="nx">EndUIFieldSet</span> <span class="o">%</span><span class="p">}</span>
</pre></div>
</div>
<p>The result:</p>
<img alt="../../../_images/FieldSet-explained.png" src="../../../_images/FieldSet-explained.png" />
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Form &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>Form &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -102,175 +105,160 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="form">
<span id="id1"></span><h1>Form<a class="headerlink" href="#form" title="Permalink to this headline"></a></h1>
<section id="form">
<span id="id1"></span><h1>Form<a class="headerlink" href="#form" title="Permalink to this headline"></a></h1>
<p>Class Form</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIForm</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIForm</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIForm</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIForm</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="73%" />
<col width="27%" />
<col style="width: 73%" />
<col style="width: 27%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#formstandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
</tr>
</tbody>
</table>
<div class="section" id="form-standard">
<span id="formstandard"></span><h3>Form Standard<a class="headerlink" href="#form-standard" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#formstandard"><span class="std std-ref">Standard</span></a></p></td>
<td><p>No comment</p></td>
</tr>
</tbody>
</table>
<section id="form-standard">
<span id="formstandard"></span><h3>Form Standard<a class="headerlink" href="#form-standard" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIForm</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIForm</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 16%" />
<col style="width: 26%" />
<col style="width: 32%" />
<col style="width: 19%" />
<col style="width: 6%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="form-common-parameters">
<h3>Form common parameters<a class="headerlink" href="#form-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="16%" />
<col width="26%" />
<col width="32%" />
<col width="19%" />
<col width="6%" />
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>Action</p></td>
<td><p>string</p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="form-common-parameters">
<h3>Form common parameters<a class="headerlink" href="#form-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>Action</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-odd"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-even"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-odd"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-even"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
<tr class="row-odd"><td><p>OnSubmitJsCode</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>OnSubmitJsCode</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>FileSelect &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<title>FileSelect &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../../index.html" class="icon icon-home"> iTop UI<img src="../../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../Alert/Alert.html">Alert</a></li>
@@ -102,165 +105,150 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="fileselect">
<span id="id1"></span><h1>FileSelect<a class="headerlink" href="#fileselect" title="Permalink to this headline"></a></h1>
<section id="fileselect">
<span id="id1"></span><h1>FileSelect<a class="headerlink" href="#fileselect" title="Permalink to this headline"></a></h1>
<p>Class FileSelect</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIFileSelect</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIFileSelect</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFileSelect</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="76%" />
<col width="24%" />
<col style="width: 76%" />
<col style="width: 24%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#fileselectstandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
</tr>
</tbody>
</table>
<div class="section" id="fileselect-standard">
<span id="fileselectstandard"></span><h3>FileSelect Standard<a class="headerlink" href="#fileselect-standard" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#fileselectstandard"><span class="std std-ref">Standard</span></a></p></td>
<td><p>No comment</p></td>
</tr>
</tbody>
</table>
<section id="fileselect-standard">
<span id="fileselectstandard"></span><h3>FileSelect Standard<a class="headerlink" href="#fileselect-standard" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIFileSelect</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sName</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 21%" />
<col style="width: 24%" />
<col style="width: 32%" />
<col style="width: 18%" />
<col style="width: 6%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sName</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="fileselect-common-parameters">
<h3>FileSelect common parameters<a class="headerlink" href="#fileselect-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="21%" />
<col width="24%" />
<col width="32%" />
<col width="18%" />
<col width="6%" />
<col style="width: 30%" />
<col style="width: 8%" />
<col style="width: 62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sName</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="fileselect-common-parameters">
<h3>FileSelect common parameters<a class="headerlink" href="#fileselect-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="8%" />
<col width="62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>ButtonText</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-even"><td>ButtonText</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-odd"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>FileName</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-even"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-odd"><td>FileName</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
<tr class="row-odd"><td>ShowFilename</td>
<td>bool</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>ShowFilename</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Input &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>Input &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -104,317 +107,286 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="input">
<span id="id1"></span><h1>Input<a class="headerlink" href="#input" title="Permalink to this headline"></a></h1>
<section id="input">
<span id="id1"></span><h1>Input<a class="headerlink" href="#input" title="Permalink to this headline"></a></h1>
<p>Class Input</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIInput</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIInput</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIInput</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="38%" />
<col width="62%" />
<col style="width: 38%" />
<col style="width: 62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#inputforhidden"><span class="std std-ref">ForHidden</span></a></td>
<td>No comment</td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#inputforhidden"><span class="std std-ref">ForHidden</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#inputstandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
<tr class="row-even"><td><p><a class="reference internal" href="#inputstandard"><span class="std std-ref">Standard</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#inputforinputwithlabel"><span class="std std-ref">ForInputWithLabel</span></a></td>
<td>&#64;see Field component that is better adapter when dealing with a standard iTop form</td>
</tr>
</tbody>
</table>
<div class="section" id="input-forhidden">
<span id="inputforhidden"></span><h3>Input ForHidden<a class="headerlink" href="#input-forhidden" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#inputforinputwithlabel"><span class="std std-ref">ForInputWithLabel</span></a></p></td>
<td><p>&#64;see Field component that is better adapter when dealing with a standard iTop form</p></td>
</tr>
</tbody>
</table>
<section id="input-forhidden">
<span id="inputforhidden"></span><h3>Input ForHidden<a class="headerlink" href="#input-forhidden" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIInput</span> <span class="p">F</span><span class="nv">orHidden</span> <span class="o">{</span><span class="nv">sName</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sValue</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="23%" />
<col width="23%" />
<col width="31%" />
<col width="17%" />
<col width="6%" />
<col style="width: 23%" />
<col style="width: 23%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sName</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sName</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sValue</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>sValue</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="input-standard">
<span id="inputstandard"></span><h3>Input Standard<a class="headerlink" href="#input-standard" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="input-standard">
<span id="inputstandard"></span><h3>Input Standard<a class="headerlink" href="#input-standard" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIInput</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sType</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sName</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sValue</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="23%" />
<col width="23%" />
<col width="31%" />
<col width="17%" />
<col width="6%" />
<col style="width: 23%" />
<col style="width: 23%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sType</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sType</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sName</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>sName</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>sValue</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>sValue</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="input-forinputwithlabel">
<span id="inputforinputwithlabel"></span><h3>Input ForInputWithLabel<a class="headerlink" href="#input-forinputwithlabel" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="input-forinputwithlabel">
<span id="inputforinputwithlabel"></span><h3>Input ForInputWithLabel<a class="headerlink" href="#input-forinputwithlabel" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIInput</span> <span class="p">F</span><span class="nv">orInputWithLabel</span> <span class="o">{</span><span class="nv">sLabel</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sInputName</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sInputValue</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sInputId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sInputType</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 31%" />
<col style="width: 19%" />
<col style="width: 26%" />
<col style="width: 19%" />
<col style="width: 5%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sLabel</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>sInputName</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>sInputValue</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>sInputId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>sInputType</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>type</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="input-common-parameters">
<h3>Input common parameters<a class="headerlink" href="#input-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="31%" />
<col width="19%" />
<col width="26%" />
<col width="19%" />
<col width="5%" />
<col style="width: 30%" />
<col style="width: 8%" />
<col style="width: 62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sLabel</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>sInputName</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>sInputValue</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>sInputId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>sInputType</td>
<td>string</td>
<td>optional</td>
<td>type</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="input-common-parameters">
<h3>Input common parameters<a class="headerlink" href="#input-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="8%" />
<col width="62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>IsChecked</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>IsDisabled</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>IsReadonly</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-even"><td><p>Label</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>IsChecked</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>Name</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>IsDisabled</td>
<td>bool</td>
<td>&#160;</td>
<tr class="row-even"><td><p>Placeholder</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
<tr class="row-odd"><td><p>Type</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>IsReadonly</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>Label</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>Name</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>Placeholder</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>Type</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>Value</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>Value</p></td>
<td><p>string</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Select &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<title>Select &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../../index.html" class="icon icon-home"> iTop UI<img src="../../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../Alert/Alert.html">Alert</a></li>
@@ -103,253 +106,230 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="select">
<span id="id1"></span><h1>Select<a class="headerlink" href="#select" title="Permalink to this headline"></a></h1>
<section id="select">
<span id="id1"></span><h1>Select<a class="headerlink" href="#select" title="Permalink to this headline"></a></h1>
<p>Class Select</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UISelect</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UISelect</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISelect</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUISelect</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="60%" />
<col width="40%" />
<col style="width: 60%" />
<col style="width: 40%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#selectforselect"><span class="std std-ref">ForSelect</span></a></td>
<td>Create a default Select input</td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#selectforselect"><span class="std std-ref">ForSelect</span></a></p></td>
<td><p>Create a default Select input</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#selectforselectwithlabel"><span class="std std-ref">ForSelectWithLabel</span></a></td>
<td>Create a Select input with a label</td>
</tr>
</tbody>
</table>
<div class="section" id="select-forselect">
<span id="selectforselect"></span><h3>Select ForSelect<a class="headerlink" href="#select-forselect" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p><a class="reference internal" href="#selectforselectwithlabel"><span class="std std-ref">ForSelectWithLabel</span></a></p></td>
<td><p>Create a Select input with a label</p></td>
</tr>
</tbody>
</table>
<section id="select-forselect">
<span id="selectforselect"></span><h3>Select ForSelect<a class="headerlink" href="#select-forselect" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISelect</span> <span class="p">F</span><span class="nv">orSelect</span> <span class="o">{</span><span class="nv">sName</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUISelect</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="12%" />
<col width="14%" />
<col width="19%" />
<col width="11%" />
<col width="44%" />
<col style="width: 12%" />
<col style="width: 14%" />
<col style="width: 19%" />
<col style="width: 11%" />
<col style="width: 44%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sName</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>Input name for the form</td>
<tbody>
<tr class="row-odd"><td><p>sName</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td><p>Input name for the form</p></td>
</tr>
<tr class="row-even"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>$sId</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="select-forselectwithlabel">
<span id="selectforselectwithlabel"></span><h3>Select ForSelectWithLabel<a class="headerlink" href="#select-forselectwithlabel" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td><p>$sId</p></td>
</tr>
</tbody>
</table>
</section>
<section id="select-forselectwithlabel">
<span id="selectforselectwithlabel"></span><h3>Select ForSelectWithLabel<a class="headerlink" href="#select-forselectwithlabel" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISelect</span> <span class="p">F</span><span class="nv">orSelectWithLabel</span> <span class="o">{</span><span class="nv">sName</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sLabel</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUISelect</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 9%" />
<col style="width: 9%" />
<col style="width: 13%" />
<col style="width: 7%" />
<col style="width: 62%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sName</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td><p>Input name for the form</p></td>
</tr>
<tr class="row-even"><td><p>sLabel</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td><p>Label to display with the input (null for no label)</p></td>
</tr>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td><p>$sId</p></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="select-common-parameters">
<h3>Select common parameters<a class="headerlink" href="#select-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="9%" />
<col width="9%" />
<col width="13%" />
<col width="7%" />
<col width="62%" />
<col style="width: 28%" />
<col style="width: 14%" />
<col style="width: 58%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sName</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>Input name for the form</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>sLabel</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>Label to display with the input (null for no label)</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>$sId</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="select-common-parameters">
<h3>Select common parameters<a class="headerlink" href="#select-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="28%" />
<col width="14%" />
<col width="58%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddOption</p></td>
<td><p>SelectOption</p></td>
<td><p>Select option UIBlock</p></td>
</tr>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AddOption</td>
<td>SelectOption</td>
<td>Select option UIBlock</td>
<tr class="row-even"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-even"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-even"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-odd"><td><p>IsLabelBefore</p></td>
<td><p>bool</p></td>
<td><p>If true the label will be positioned before the input</p></td>
</tr>
<tr class="row-odd"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>IsMultiple</p></td>
<td><p>bool</p></td>
<td><p>Allow multiple selection</p></td>
</tr>
<tr class="row-even"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
<tr class="row-odd"><td><p>Label</p></td>
<td><p>string</p></td>
<td><p>Label to display with the input (null for no label)</p></td>
</tr>
<tr class="row-odd"><td>IsLabelBefore</td>
<td>bool</td>
<td>If true the label will be positioned before the input</td>
<tr class="row-even"><td><p>Name</p></td>
<td><p>string</p></td>
<td><p>Input name for the form</p></td>
</tr>
<tr class="row-even"><td>IsMultiple</td>
<td>bool</td>
<td>Allow multiple selection</td>
<tr class="row-odd"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>Label</td>
<td>string</td>
<td>Label to display with the input (null for no label)</td>
</tr>
<tr class="row-even"><td>Name</td>
<td>string</td>
<td>Input name for the form</td>
</tr>
<tr class="row-odd"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>SubmitOnChange</td>
<td>bool</td>
<td>if true submit the form as soon as a change is detected</td>
<tr class="row-even"><td><p>SubmitOnChange</p></td>
<td><p>bool</p></td>
<td><p>if true submit the form as soon as a change is detected</p></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>SelectOption &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<title>SelectOption &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../../index.html" class="icon icon-home"> iTop UI<img src="../../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../Alert/Alert.html">Alert</a></li>
@@ -102,181 +105,166 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="selectoption">
<span id="id1"></span><h1>SelectOption<a class="headerlink" href="#selectoption" title="Permalink to this headline"></a></h1>
<section id="selectoption">
<span id="id1"></span><h1>SelectOption<a class="headerlink" href="#selectoption" title="Permalink to this headline"></a></h1>
<p>Class SelectOption</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UISelectOption</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UISelectOption</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISelectOption</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="82%" />
<col width="18%" />
<col style="width: 82%" />
<col style="width: 18%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#selectoptionforselectoption"><span class="std std-ref">ForSelectOption</span></a></td>
<td>No comment</td>
</tr>
</tbody>
</table>
<div class="section" id="selectoption-forselectoption">
<span id="selectoptionforselectoption"></span><h3>SelectOption ForSelectOption<a class="headerlink" href="#selectoption-forselectoption" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#selectoptionforselectoption"><span class="std std-ref">ForSelectOption</span></a></p></td>
<td><p>No comment</p></td>
</tr>
</tbody>
</table>
<section id="selectoption-forselectoption">
<span id="selectoptionforselectoption"></span><h3>SelectOption ForSelectOption<a class="headerlink" href="#selectoption-forselectoption" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISelectOption</span> <span class="p">F</span><span class="nv">orSelectOption</span> <span class="o">{</span><span class="nv">sValue</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sLabel</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">bSelected</span><span class="o">:</span><span class="kp">true</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 29%" />
<col style="width: 21%" />
<col style="width: 29%" />
<col style="width: 16%" />
<col style="width: 5%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sValue</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>sLabel</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>bSelected</p></td>
<td><p>bool</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="selectoption-common-parameters">
<h3>SelectOption common parameters<a class="headerlink" href="#selectoption-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="29%" />
<col width="21%" />
<col width="29%" />
<col width="16%" />
<col width="5%" />
<col style="width: 30%" />
<col style="width: 8%" />
<col style="width: 62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sValue</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>sLabel</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>bSelected</td>
<td>bool</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="selectoption-common-parameters">
<h3>SelectOption common parameters<a class="headerlink" href="#selectoption-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="8%" />
<col width="62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>Disabled</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>Label</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-odd"><td><p>Selected</p></td>
<td><p>bool</p></td>
<td></td>
</tr>
<tr class="row-even"><td>Disabled</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
<tr class="row-even"><td>Label</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>Selected</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>Value</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>Value</p></td>
<td><p>string</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

File diff suppressed because it is too large Load Diff

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Spinner &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>Spinner &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -102,147 +105,132 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="spinner">
<span id="id1"></span><h1>Spinner<a class="headerlink" href="#spinner" title="Permalink to this headline"></a></h1>
<section id="spinner">
<span id="id1"></span><h1>Spinner<a class="headerlink" href="#spinner" title="Permalink to this headline"></a></h1>
<p>Class Spinner</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UISpinner</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UISpinner</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISpinner</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="74%" />
<col width="26%" />
<col style="width: 74%" />
<col style="width: 26%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#spinnerstandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
</tr>
</tbody>
</table>
<div class="section" id="spinner-standard">
<span id="spinnerstandard"></span><h3>Spinner Standard<a class="headerlink" href="#spinner-standard" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#spinnerstandard"><span class="std std-ref">Standard</span></a></p></td>
<td><p>No comment</p></td>
</tr>
</tbody>
</table>
<section id="spinner-standard">
<span id="spinnerstandard"></span><h3>Spinner Standard<a class="headerlink" href="#spinner-standard" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UISpinner</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 16%" />
<col style="width: 26%" />
<col style="width: 32%" />
<col style="width: 19%" />
<col style="width: 6%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="spinner-common-parameters">
<h3>Spinner common parameters<a class="headerlink" href="#spinner-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="16%" />
<col width="26%" />
<col width="32%" />
<col width="19%" />
<col width="6%" />
<col style="width: 30%" />
<col style="width: 8%" />
<col style="width: 62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="spinner-common-parameters">
<h3>Spinner common parameters<a class="headerlink" href="#spinner-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="8%" />
<col width="62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
</tr>
<tr class="row-even"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
<tr class="row-even"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Title &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>Title &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -105,373 +108,325 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="title">
<span id="id1"></span><h1>Title<a class="headerlink" href="#title" title="Permalink to this headline"></a></h1>
<section id="title">
<span id="id1"></span><h1>Title<a class="headerlink" href="#title" title="Permalink to this headline"></a></h1>
<p>Class Title</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<img alt="../../../_images/Title.png" src="../../../_images/Title.png" />
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UITitle</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UITitle</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="80%" />
<col width="20%" />
<col style="width: 80%" />
<col style="width: 20%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#titleforpage"><span class="std std-ref">ForPage</span></a></td>
<td>No comment</td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#titleforpage"><span class="std std-ref">ForPage</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#titleforpagewithicon"><span class="std std-ref">ForPageWithIcon</span></a></td>
<td>No comment</td>
<tr class="row-even"><td><p><a class="reference internal" href="#titleforpagewithicon"><span class="std std-ref">ForPageWithIcon</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#titleneutral"><span class="std std-ref">Neutral</span></a></td>
<td>No comment</td>
<tr class="row-odd"><td><p><a class="reference internal" href="#titleneutral"><span class="std std-ref">Neutral</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#titlestandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
</tr>
</tbody>
</table>
<div class="section" id="title-forpage">
<span id="titleforpage"></span><h3>Title ForPage<a class="headerlink" href="#title-forpage" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p><a class="reference internal" href="#titlestandard"><span class="std std-ref">Standard</span></a></p></td>
<td><p>No comment</p></td>
</tr>
</tbody>
</table>
<section id="title-forpage">
<span id="titleforpage"></span><h3>Title ForPage<a class="headerlink" href="#title-forpage" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</span> <span class="p">F</span><span class="nv">orPage</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="23%" />
<col width="23%" />
<col width="31%" />
<col width="17%" />
<col width="6%" />
<col style="width: 23%" />
<col style="width: 23%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sTitle</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sTitle</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="title-forpagewithicon">
<span id="titleforpagewithicon"></span><h3>Title ForPageWithIcon<a class="headerlink" href="#title-forpagewithicon" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="title-forpagewithicon">
<span id="titleforpagewithicon"></span><h3>Title ForPageWithIcon<a class="headerlink" href="#title-forpagewithicon" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</span> <span class="p">F</span><span class="nv">orPageWithIcon</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sIconUrl</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">sIconCoverMethod</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">bIsMedallion</span><span class="o">:</span><span class="kp">true</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="36%" />
<col width="16%" />
<col width="22%" />
<col width="22%" />
<col width="4%" />
<col style="width: 36%" />
<col style="width: 16%" />
<col style="width: 22%" />
<col style="width: 22%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sTitle</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sTitle</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sIconUrl</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>sIconUrl</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>sIconCoverMethod</td>
<td>string</td>
<td>optional</td>
<td>contain</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>sIconCoverMethod</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>contain</p></td>
<td></td>
</tr>
<tr class="row-even"><td>bIsMedallion</td>
<td>bool</td>
<td>optional</td>
<td>true</td>
<td>&#160;</td>
<tr class="row-even"><td><p>bIsMedallion</p></td>
<td><p>bool</p></td>
<td><p>optional</p></td>
<td><p>true</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="title-neutral">
<span id="titleneutral"></span><h3>Title Neutral<a class="headerlink" href="#title-neutral" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="title-neutral">
<span id="titleneutral"></span><h3>Title Neutral<a class="headerlink" href="#title-neutral" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</span> <span class="p">N</span><span class="nv">eutral</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">iLevel</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="23%" />
<col width="23%" />
<col width="31%" />
<col width="17%" />
<col width="6%" />
<col style="width: 23%" />
<col style="width: 23%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sTitle</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sTitle</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>iLevel</td>
<td>int</td>
<td>optional</td>
<td>1</td>
<td>&#160;</td>
<tr class="row-even"><td><p>iLevel</p></td>
<td><p>int</p></td>
<td><p>optional</p></td>
<td><p>1</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="title-standard">
<span id="titlestandard"></span><h3>Title Standard<a class="headerlink" href="#title-standard" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="title-standard">
<span id="titlestandard"></span><h3>Title Standard<a class="headerlink" href="#title-standard" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">oTitle</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">iLevel</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 22%" />
<col style="width: 25%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>oTitle</p></td>
<td><p>UIBlock</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>iLevel</p></td>
<td><p>int</p></td>
<td><p>optional</p></td>
<td><p>1</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="title-common-parameters">
<h3>Title common parameters<a class="headerlink" href="#title-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="22%" />
<col width="25%" />
<col width="31%" />
<col width="17%" />
<col width="6%" />
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>oTitle</td>
<td>UIBlock</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>iLevel</td>
<td>int</td>
<td>optional</td>
<td>1</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="title-common-parameters">
<h3>Title common parameters<a class="headerlink" href="#title-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-even"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
</tr>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
<tr class="row-even"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name" colspan="2">The following code:</th></tr>
<tr class="field-odd field"><td>&#160;</td><td class="field-body"></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">The following code</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UITitle</span> <span class="p">F</span><span class="nv">orPage</span> <span class="o">{</span><span class="nv">sTitle</span><span class="o">:</span> <span class="s1">&#39;UI:FullTextSearchTitle_Text&#39;</span><span class="o">|</span><span class="nf">dict_format</span><span class="o">(</span><span class="nv">sFullText</span><span class="o">)}</span> <span class="cp">%}{%</span> <span class="k">EndUITitle</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Will display:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<dl class="field-list simple">
<dt class="field-odd">Will display</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<img alt="../../../_images/Title.png" src="../../../_images/Title.png" />
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Toolbar &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>Toolbar &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -104,267 +107,236 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="toolbar">
<span id="id1"></span><h1>Toolbar<a class="headerlink" href="#toolbar" title="Permalink to this headline"></a></h1>
<section id="toolbar">
<span id="id1"></span><h1>Toolbar<a class="headerlink" href="#toolbar" title="Permalink to this headline"></a></h1>
<p>Class Toolbar</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIToolbar</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIToolbar</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbar</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIToolbar</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="76%" />
<col width="24%" />
<col style="width: 76%" />
<col style="width: 24%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#toolbarforaction"><span class="std std-ref">ForAction</span></a></td>
<td>No comment</td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#toolbarforaction"><span class="std std-ref">ForAction</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#toolbarstandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
<tr class="row-even"><td><p><a class="reference internal" href="#toolbarstandard"><span class="std std-ref">Standard</span></a></p></td>
<td><p>No comment</p></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#toolbarforbutton"><span class="std std-ref">ForButton</span></a></td>
<td>No comment</td>
</tr>
</tbody>
</table>
<div class="section" id="toolbar-foraction">
<span id="toolbarforaction"></span><h3>Toolbar ForAction<a class="headerlink" href="#toolbar-foraction" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#toolbarforbutton"><span class="std std-ref">ForButton</span></a></p></td>
<td><p>No comment</p></td>
</tr>
</tbody>
</table>
<section id="toolbar-foraction">
<span id="toolbarforaction"></span><h3>Toolbar ForAction<a class="headerlink" href="#toolbar-foraction" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbar</span> <span class="p">F</span><span class="nv">orAction</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIToolbar</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="16%" />
<col width="26%" />
<col width="32%" />
<col width="19%" />
<col width="6%" />
<col style="width: 16%" />
<col style="width: 26%" />
<col style="width: 32%" />
<col style="width: 19%" />
<col style="width: 6%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="toolbar-standard">
<span id="toolbarstandard"></span><h3>Toolbar Standard<a class="headerlink" href="#toolbar-standard" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="toolbar-standard">
<span id="toolbarstandard"></span><h3>Toolbar Standard<a class="headerlink" href="#toolbar-standard" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbar</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">aContainerClasses</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">}}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIToolbar</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="39%" />
<col width="16%" />
<col width="20%" />
<col width="20%" />
<col width="4%" />
<col style="width: 39%" />
<col style="width: 16%" />
<col style="width: 20%" />
<col style="width: 20%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
<tr class="row-even"><td>aContainerClasses</td>
<td>array</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="toolbar-forbutton">
<span id="toolbarforbutton"></span><h3>Toolbar ForButton<a class="headerlink" href="#toolbar-forbutton" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p>aContainerClasses</p></td>
<td><p>array</p></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="toolbar-forbutton">
<span id="toolbarforbutton"></span><h3>Toolbar ForButton<a class="headerlink" href="#toolbar-forbutton" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbar</span> <span class="p">F</span><span class="nv">orButton</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">aContainerClasses</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">}}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIToolbar</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 39%" />
<col style="width: 16%" />
<col style="width: 20%" />
<col style="width: 20%" />
<col style="width: 4%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>aContainerClasses</p></td>
<td><p>array</p></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="toolbar-common-parameters">
<h3>Toolbar common parameters<a class="headerlink" href="#toolbar-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="39%" />
<col width="16%" />
<col width="20%" />
<col width="20%" />
<col width="4%" />
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>aContainerClasses</td>
<td>array</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="toolbar-common-parameters">
<h3>Toolbar common parameters<a class="headerlink" href="#toolbar-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-even"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
<tr class="row-odd"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
<tr class="row-even"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>

View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ToolbarSpacer &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<title>ToolbarSpacer &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../../index.html" class="icon icon-home"> iTop UI<img src="../../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../Alert/Alert.html">Alert</a></li>
@@ -102,147 +105,132 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="toolbarspacer">
<span id="id1"></span><h1>ToolbarSpacer<a class="headerlink" href="#toolbarspacer" title="Permalink to this headline"></a></h1>
<section id="toolbarspacer">
<span id="id1"></span><h1>ToolbarSpacer<a class="headerlink" href="#toolbarspacer" title="Permalink to this headline"></a></h1>
<p>Class ButtonToolbarSpacer</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>No output provided yet</p>
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIToolbarSpacer</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIToolbarSpacer</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbarSpacer</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="62%" />
<col width="38%" />
<col style="width: 62%" />
<col style="width: 38%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#toolbarspacerstandard"><span class="std std-ref">Standard</span></a></td>
<td>&#64;param string|null $sId</td>
</tr>
</tbody>
</table>
<div class="section" id="toolbarspacer-standard">
<span id="toolbarspacerstandard"></span><h3>ToolbarSpacer Standard<a class="headerlink" href="#toolbarspacer-standard" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#toolbarspacerstandard"><span class="std std-ref">Standard</span></a></p></td>
<td><p>&#64;param string|null $sId</p></td>
</tr>
</tbody>
</table>
<section id="toolbarspacer-standard">
<span id="toolbarspacerstandard"></span><h3>ToolbarSpacer Standard<a class="headerlink" href="#toolbarspacer-standard" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIToolbarSpacer</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 16%" />
<col style="width: 26%" />
<col style="width: 32%" />
<col style="width: 19%" />
<col style="width: 6%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="toolbarspacer-common-parameters">
<h3>ToolbarSpacer common parameters<a class="headerlink" href="#toolbarspacer-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="16%" />
<col width="26%" />
<col width="32%" />
<col width="19%" />
<col width="6%" />
<col style="width: 30%" />
<col style="width: 8%" />
<col style="width: 62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="toolbarspacer-common-parameters">
<h3>ToolbarSpacer common parameters<a class="headerlink" href="#toolbarspacer-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="8%" />
<col width="62%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</p></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
</tr>
<tr class="row-even"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
<tr class="row-even"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>