update for linux

This commit is contained in:
bruno-ds
2021-09-28 16:29:12 +02:00
parent 513b671c4e
commit c02f3202d9
148 changed files with 18895 additions and 29089 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<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 src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="CollapsibleSection" href="../CollapsibleSection/CollapsibleSection.html" />
<link rel="prev" title="Button" href="../Button/Button.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -127,71 +77,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../Component.html">UI Components</a> &raquo;</li>
<li>ButtonGroup</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/generated/Component/ButtonGroup/ButtonGroup.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class ButtonGroup</p>
@@ -203,132 +113,147 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 40%" />
<col style="width: 60%" />
<col width="40%" />
<col width="60%" />
</colgroup>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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>
<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>
<tr class="row-even"><td><p>oMenu</p></td>
<td><p>PopoverMenu</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="35%" />
<col width="30%" />
<col width="5%" />
<col width="5%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>oButton</td>
<td>Button</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>oMenu</td>
<td>PopoverMenu</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 class="docutils align-default">
<table border="1" class="docutils">
<colgroup>
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>AddButton</p></td>
<td><p>Button</p></td>
<td></td>
<tbody valign="top">
<tr class="row-odd"><td>AddButton</td>
<td>Button</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddButtons</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddButtons</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
</tr>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddExtraBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-even"><td>AddExtraBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>Buttons</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>Buttons</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
<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><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
<tr class="row-even"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
</tbody>
</table>
@@ -343,58 +268,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../CollapsibleSection/CollapsibleSection.html" class="btn btn-neutral float-right" title="CollapsibleSection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../Button/Button.html" class="btn btn-neutral float-left" title="Button" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../Button/Button.html" class="btn btn-neutral float-left" title="Button" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../CollapsibleSection/CollapsibleSection.html" class="btn btn-neutral float-right" title="CollapsibleSection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<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 src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="DataTable" href="../DataTable/DataTable.html" />
<link rel="prev" title="ButtonGroup" href="../ButtonGroup/ButtonGroup.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -127,71 +77,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../Component.html">UI Components</a> &raquo;</li>
<li>CollapsibleSection</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/generated/Component/CollapsibleSection/CollapsibleSection.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class CollapsibleSection</p>
@@ -203,140 +113,155 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 79%" />
<col style="width: 21%" />
<col width="79%" />
<col width="21%" />
</colgroup>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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>
<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>
<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>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="23%" />
<col width="23%" />
<col width="31%" />
<col width="17%" />
<col 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>
</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="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">
<table border="1" class="docutils">
<colgroup>
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<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 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><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
<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><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>OpenedByDefault</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-even"><td>OpenedByDefault</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
@@ -351,58 +276,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../DataTable/DataTable.html" class="btn btn-neutral float-right" title="DataTable" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../ButtonGroup/ButtonGroup.html" class="btn btn-neutral float-left" title="ButtonGroup" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../ButtonGroup/ButtonGroup.html" class="btn btn-neutral float-left" title="ButtonGroup" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../DataTable/DataTable.html" class="btn btn-neutral float-right" title="DataTable" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<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 src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Alert" href="Alert/Alert.html" />
<link rel="prev" title="Twig Base Reference" href="../../TwigBaseReference/TwigBaseReference.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -118,69 +68,30 @@
<li class="toctree-l1"><a class="reference internal" href="../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li>UI Components</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/generated/Component/Component.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>A UI component is a unitary block used to display information in iTop console.</p>
@@ -211,58 +122,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Alert/Alert.html" class="btn btn-neutral float-right" title="Alert" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../../TwigBaseReference/TwigBaseReference.html" class="btn btn-neutral float-left" title="Twig Base Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../../TwigBaseReference/TwigBaseReference.html" class="btn btn-neutral float-left" title="Twig Base Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Alert/Alert.html" class="btn btn-neutral float-right" title="Alert" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<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 src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="FieldBadge" href="../FieldBadge/FieldBadge.html" />
<link rel="prev" title="DataTable" href="../DataTable/DataTable.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -131,463 +81,477 @@
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../Component.html">UI Components</a> &raquo;</li>
<li>Field</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/generated/Component/Field/Field.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Example Fields</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
<img alt="../../../_images/Field.png" src="../../../_images/Field.png" />
</div>
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 76%" />
<col style="width: 24%" />
<col width="76%" />
<col width="24%" />
</colgroup>
<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>
<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>
</tr>
<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 class="row-even"><td><a class="reference internal" href="#fieldfromobject"><span class="std std-ref">FromObject</span></a></td>
<td>No comment</td>
</tr>
<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 class="row-odd"><td><a class="reference internal" href="#fieldlarge"><span class="std std-ref">Large</span></a></td>
<td>No comment</td>
</tr>
<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 class="row-even"><td><a class="reference internal" href="#fieldsmall"><span class="std std-ref">Small</span></a></td>
<td>No comment</td>
</tr>
<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 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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 35%" />
<col style="width: 8%" />
<col style="width: 42%" />
<col style="width: 8%" />
<col style="width: 8%" />
<col width="35%" />
<col width="8%" />
<col width="42%" />
<col width="8%" />
<col width="8%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>aParams</p></td>
<td></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 24%" />
<col style="width: 24%" />
<col style="width: 30%" />
<col style="width: 16%" />
<col style="width: 5%" />
<col width="24%" />
<col width="24%" />
<col width="30%" />
<col width="16%" />
<col 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>
<tbody valign="top">
<tr class="row-odd"><td>sLabel</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>oInput</p></td>
<td><p>UIBlock</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
<tr class="row-even"><td>oInput</td>
<td>UIBlock</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<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 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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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: 32%" />
<col style="width: 22%" />
<col style="width: 30%" />
<col style="width: 11%" />
<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>
<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>
<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>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="32%" />
<col width="22%" />
<col width="30%" />
<col width="11%" />
<col 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>
</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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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: 32%" />
<col style="width: 22%" />
<col style="width: 30%" />
<col style="width: 11%" />
<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>
<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>
<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>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="32%" />
<col width="22%" />
<col width="30%" />
<col width="11%" />
<col 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>
</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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 24%" />
<col style="width: 21%" />
<col style="width: 26%" />
<col style="width: 24%" />
<col style="width: 5%" />
<col width="24%" />
<col width="21%" />
<col width="26%" />
<col width="24%" />
<col 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>
<tbody valign="top">
<tr class="row-odd"><td>sLabel</td>
<td>string</td>
<td>optional</td>
<td></td>
<td>&#160;</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 class="row-even"><td>sLayout</td>
<td>string</td>
<td>optional</td>
<td>small</td>
<td>&#160;</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 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="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">
<table border="1" class="docutils">
<colgroup>
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AttCode</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AttCode</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AttLabel</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AttLabel</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AttType</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AttType</td>
<td>string</td>
<td>&#160;</td>
</tr>
<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 class="row-odd"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-even"><td><p>Comments</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>Comments</td>
<td>string</td>
<td>&#160;</td>
</tr>
<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 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><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>InputId</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>InputId</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>InputType</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>InputType</td>
<td>string</td>
<td>&#160;</td>
</tr>
<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 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><p>IsMandatory</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-even"><td>IsMandatory</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>IsReadOnly</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-odd"><td>IsReadOnly</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>IsSlave</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-even"><td>IsSlave</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>Label</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>Label</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>Layout</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>Layout</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>MustChange</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-odd"><td>MustChange</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>MustPrompt</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-even"><td>MustPrompt</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>Value</p></td>
<td><p>UIBlock</p></td>
<td></td>
<tr class="row-even"><td>Value</td>
<td>UIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>ValueId</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>ValueId</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>ValueRaw</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>ValueRaw</td>
<td>string</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
<hr class="docutils" />
<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>
<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>
<hr class="docutils" />
@@ -606,58 +570,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../FieldBadge/FieldBadge.html" class="btn btn-neutral float-right" title="FieldBadge" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../DataTable/DataTable.html" class="btn btn-neutral float-left" title="DataTable" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../DataTable/DataTable.html" class="btn btn-neutral float-left" title="DataTable" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../FieldBadge/FieldBadge.html" class="btn btn-neutral float-right" title="FieldBadge" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<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 src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="FieldSet" href="../FieldSet/FieldSet.html" />
<link rel="prev" title="Field" href="../Field/Field.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -127,71 +77,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../Component.html">UI Components</a> &raquo;</li>
<li>FieldBadge</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/generated/Component/FieldBadge/FieldBadge.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class FieldBadge</p>
@@ -203,136 +113,151 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 62%" />
<col style="width: 38%" />
<col width="62%" />
<col width="38%" />
</colgroup>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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>
<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>
<tr class="row-even"><td><p>oStyle</p></td>
<td><p>ormStyle</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="30%" />
<col width="33%" />
<col width="6%" />
<col width="6%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sValue</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>oStyle</td>
<td>ormStyle</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 class="docutils align-default">
<table border="1" class="docutils">
<colgroup>
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<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 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><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
<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><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
@@ -347,58 +272,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../FieldSet/FieldSet.html" class="btn btn-neutral float-right" title="FieldSet" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../Field/Field.html" class="btn btn-neutral float-left" title="Field" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../Field/Field.html" class="btn btn-neutral float-left" title="Field" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../FieldSet/FieldSet.html" class="btn btn-neutral float-right" title="FieldSet" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<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 src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Form" href="../Form/Form.html" />
<link rel="prev" title="FieldBadge" href="../FieldBadge/FieldBadge.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -127,225 +77,208 @@
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../Component.html">UI Components</a> &raquo;</li>
<li>FieldSet</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/generated/Component/FieldSet/FieldSet.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Example FieldSets</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
<img alt="../../../_images/FieldSet.png" src="../../../_images/FieldSet.png" />
</div>
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 75%" />
<col style="width: 25%" />
<col width="75%" />
<col width="25%" />
</colgroup>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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>
<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>
<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>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="22%" />
<col width="31%" />
<col width="17%" />
<col width="6%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sLegend</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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="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">
<table border="1" class="docutils">
<colgroup>
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<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 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><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
<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><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
<hr class="docutils" />
<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>
<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>
<hr class="docutils" />
@@ -365,58 +298,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../Form/Form.html" class="btn btn-neutral float-right" title="Form" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../FieldBadge/FieldBadge.html" class="btn btn-neutral float-left" title="FieldBadge" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../FieldBadge/FieldBadge.html" class="btn btn-neutral float-left" title="FieldBadge" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../Form/Form.html" class="btn btn-neutral float-right" title="Form" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<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 src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="FileSelect" href="../Input/FileSelect/FileSelect.html" />
<link rel="prev" title="FieldSet" href="../FieldSet/FieldSet.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -127,71 +77,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../Component.html">UI Components</a> &raquo;</li>
<li>Form</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/generated/Component/Form/Form.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class Form</p>
@@ -203,138 +113,153 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 73%" />
<col style="width: 27%" />
<col width="73%" />
<col width="27%" />
</colgroup>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 16%" />
<col style="width: 26%" />
<col style="width: 32%" />
<col style="width: 19%" />
<col style="width: 6%" />
<col width="16%" />
<col width="26%" />
<col width="32%" />
<col width="19%" />
<col 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>
<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="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">
<table border="1" class="docutils">
<colgroup>
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>Action</p></td>
<td><p>string</p></td>
<td></td>
<tbody valign="top">
<tr class="row-odd"><td>Action</td>
<td>string</td>
<td>&#160;</td>
</tr>
<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 class="row-even"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
</tr>
<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 class="row-odd"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-even"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-odd"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-even"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<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 class="row-odd"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<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 class="row-even"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
</tr>
<tr class="row-odd"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>OnSubmitJsCode</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>OnSubmitJsCode</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
@@ -349,58 +274,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../Input/FileSelect/FileSelect.html" class="btn btn-neutral float-right" title="FileSelect" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../FieldSet/FieldSet.html" class="btn btn-neutral float-left" title="FieldSet" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../FieldSet/FieldSet.html" class="btn btn-neutral float-left" title="FieldSet" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../Input/FileSelect/FileSelect.html" class="btn btn-neutral float-right" title="FileSelect" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
<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 src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<link rel="next" title="Input" href="../Input.html" />
<link rel="prev" title="Form" href="../../Form/Form.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -127,71 +77,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../Component.html">UI Components</a> &raquo;</li>
<li>FileSelect</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../_sources/generated/Component/Input/FileSelect/FileSelect.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class FileSelect</p>
@@ -203,128 +113,143 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 76%" />
<col style="width: 24%" />
<col width="76%" />
<col width="24%" />
</colgroup>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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>
<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>
<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>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="24%" />
<col width="32%" />
<col width="18%" />
<col 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>
</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="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">
<table border="1" class="docutils">
<colgroup>
<col style="width: 30%" />
<col style="width: 8%" />
<col style="width: 62%" />
<col width="30%" />
<col width="8%" />
<col width="62%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>ButtonText</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>ButtonText</td>
<td>string</td>
<td>&#160;</td>
</tr>
<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 class="row-odd"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<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 class="row-even"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
</tr>
<tr class="row-odd"><td><p>FileName</p></td>
<td></td>
<td></td>
<tr class="row-odd"><td>FileName</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<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 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><p>ShowFilename</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-odd"><td>ShowFilename</td>
<td>bool</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
@@ -339,58 +264,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../Input.html" class="btn btn-neutral float-right" title="Input" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../../Form/Form.html" class="btn btn-neutral float-left" title="Form" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../../Form/Form.html" class="btn btn-neutral float-left" title="Form" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../Input.html" class="btn btn-neutral float-right" title="Input" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<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 src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Select" href="Select/Select.html" />
<link rel="prev" title="FileSelect" href="FileSelect/FileSelect.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -129,71 +79,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../Component.html">UI Components</a> &raquo;</li>
<li>Input</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/generated/Component/Input/Input.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class Input</p>
@@ -205,260 +115,295 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 38%" />
<col style="width: 62%" />
<col width="38%" />
<col width="62%" />
</colgroup>
<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>
<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>
</tr>
<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 class="row-even"><td><a class="reference internal" href="#inputstandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
</tr>
<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 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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 23%" />
<col style="width: 23%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
<col width="23%" />
<col width="23%" />
<col width="31%" />
<col width="17%" />
<col 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>
<tbody valign="top">
<tr class="row-odd"><td>sName</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>sValue</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
<tr class="row-even"><td>sValue</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 23%" />
<col style="width: 23%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
<col width="23%" />
<col width="23%" />
<col width="31%" />
<col width="17%" />
<col width="6%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sType</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
<tbody valign="top">
<tr class="row-odd"><td>sType</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>sName</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
<tr class="row-even"><td>sName</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>sValue</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
<tr class="row-odd"><td>sValue</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 31%" />
<col style="width: 19%" />
<col style="width: 26%" />
<col style="width: 19%" />
<col style="width: 5%" />
<col width="31%" />
<col width="19%" />
<col width="26%" />
<col width="19%" />
<col 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>
<tbody valign="top">
<tr class="row-odd"><td>sLabel</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 class="row-even"><td>sInputName</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 class="row-odd"><td>sInputValue</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</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 class="row-even"><td>sInputId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</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 class="row-odd"><td>sInputType</td>
<td>string</td>
<td>optional</td>
<td>type</td>
<td>&#160;</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 class="docutils align-default">
<table border="1" class="docutils">
<colgroup>
<col style="width: 30%" />
<col style="width: 8%" />
<col style="width: 62%" />
<col width="30%" />
<col width="8%" />
<col width="62%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
<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><p>IsChecked</p></td>
<td></td>
<td></td>
<tr class="row-even"><td>IsChecked</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>IsDisabled</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-odd"><td>IsDisabled</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<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 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><p>IsReadonly</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-odd"><td>IsReadonly</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>Name</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>Label</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>Placeholder</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>Name</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>Type</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>Placeholder</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>Value</p></td>
<td><p>string</p></td>
<td></td>
<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>
</tbody>
</table>
@@ -473,58 +418,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Select/Select.html" class="btn btn-neutral float-right" title="Select" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="FileSelect/FileSelect.html" class="btn btn-neutral float-left" title="FileSelect" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="FileSelect/FileSelect.html" class="btn btn-neutral float-left" title="FileSelect" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Select/Select.html" class="btn btn-neutral float-right" title="Select" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
<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 src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<link rel="next" title="SelectOption" href="SelectOption.html" />
<link rel="prev" title="Input" href="../Input.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -128,71 +78,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../Component.html">UI Components</a> &raquo;</li>
<li>Select</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../_sources/generated/Component/Input/Select/Select.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class Select</p>
@@ -204,208 +114,231 @@
<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>
<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>
<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>
<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>
<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 style="width: 60%" />
<col style="width: 40%" />
</colgroup>
<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>
<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>
<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>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="60%" />
<col 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>
</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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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: 12%" />
<col style="width: 14%" />
<col style="width: 19%" />
<col style="width: 11%" />
<col style="width: 44%" />
</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>
<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>
<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>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="12%" />
<col width="14%" />
<col width="19%" />
<col width="11%" />
<col 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>
</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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 9%" />
<col style="width: 9%" />
<col style="width: 13%" />
<col style="width: 7%" />
<col style="width: 62%" />
<col width="9%" />
<col width="9%" />
<col width="13%" />
<col width="7%" />
<col 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>
<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>
</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 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>
<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 class="row-odd"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>$sId</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 class="docutils align-default">
<table border="1" class="docutils">
<colgroup>
<col style="width: 28%" />
<col style="width: 14%" />
<col style="width: 58%" />
<col width="28%" />
<col width="14%" />
<col width="58%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddOption</p></td>
<td><p>SelectOption</p></td>
<td><p>Select option UIBlock</p></td>
<tr class="row-odd"><td>AddOption</td>
<td>SelectOption</td>
<td>Select option UIBlock</td>
</tr>
<tr class="row-even"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-even"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<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 class="row-odd"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<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 class="row-even"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [name =&gt; value]</td>
</tr>
<tr class="row-odd"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>IsLabelBefore</p></td>
<td><p>bool</p></td>
<td><p>If true the label will be positioned before the input</p></td>
<tr class="row-odd"><td>IsLabelBefore</td>
<td>bool</td>
<td>If true the label will be positioned before the input</td>
</tr>
<tr class="row-even"><td><p>IsMultiple</p></td>
<td><p>bool</p></td>
<td><p>Allow multiple selection</p></td>
<tr class="row-even"><td>IsMultiple</td>
<td>bool</td>
<td>Allow multiple selection</td>
</tr>
<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 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><p>Name</p></td>
<td><p>string</p></td>
<td><p>Input name for the form</p></td>
<tr class="row-even"><td>Name</td>
<td>string</td>
<td>Input name for the form</td>
</tr>
<tr class="row-odd"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 class="row-even"><td>SubmitOnChange</td>
<td>bool</td>
<td>if true submit the form as soon as a change is detected</td>
</tr>
</tbody>
</table>
@@ -420,58 +353,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="SelectOption.html" class="btn btn-neutral float-right" title="SelectOption" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../Input.html" class="btn btn-neutral float-left" title="Input" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../Input.html" class="btn btn-neutral float-left" title="Input" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="SelectOption.html" class="btn btn-neutral float-right" title="SelectOption" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
<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 src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<link rel="next" title="Panel" href="../../Panel/Panel.html" />
<link rel="prev" title="Select" href="Select.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -127,71 +77,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../Component.html">UI Components</a> &raquo;</li>
<li>SelectOption</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../_sources/generated/Component/Input/Select/SelectOption.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class SelectOption</p>
@@ -203,144 +113,159 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 82%" />
<col style="width: 18%" />
<col width="82%" />
<col width="18%" />
</colgroup>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 29%" />
<col style="width: 21%" />
<col style="width: 29%" />
<col style="width: 16%" />
<col style="width: 5%" />
<col width="29%" />
<col width="21%" />
<col width="29%" />
<col width="16%" />
<col 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>
<tbody valign="top">
<tr class="row-odd"><td>sValue</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 class="row-even"><td>sLabel</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 class="row-odd"><td>bSelected</td>
<td>bool</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 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="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">
<table border="1" class="docutils">
<colgroup>
<col style="width: 30%" />
<col style="width: 8%" />
<col style="width: 62%" />
<col width="30%" />
<col width="8%" />
<col width="62%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
<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><p>Disabled</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-even"><td>Disabled</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<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 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><p>Label</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>Label</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>Selected</p></td>
<td><p>bool</p></td>
<td></td>
<tr class="row-odd"><td>Selected</td>
<td>bool</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>Value</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>Value</td>
<td>string</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
@@ -355,58 +280,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../../Panel/Panel.html" class="btn btn-neutral float-right" title="Panel" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Select.html" class="btn btn-neutral float-left" title="Select" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Select.html" class="btn btn-neutral float-left" title="Select" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../../Panel/Panel.html" class="btn btn-neutral float-right" title="Panel" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

File diff suppressed because it is too large Load Diff

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<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 src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Title" href="../Title/Title.html" />
<link rel="prev" title="Panel" href="../Panel/Panel.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -127,71 +77,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../Component.html">UI Components</a> &raquo;</li>
<li>Spinner</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/generated/Component/Spinner/Spinner.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class Spinner</p>
@@ -203,110 +113,125 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 74%" />
<col style="width: 26%" />
<col width="74%" />
<col width="26%" />
</colgroup>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 16%" />
<col style="width: 26%" />
<col style="width: 32%" />
<col style="width: 19%" />
<col style="width: 6%" />
<col width="16%" />
<col width="26%" />
<col width="32%" />
<col width="19%" />
<col 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>
<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="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">
<table border="1" class="docutils">
<colgroup>
<col style="width: 30%" />
<col style="width: 8%" />
<col style="width: 62%" />
<col width="30%" />
<col width="8%" />
<col width="62%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
<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><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
<tr class="row-even"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
</tbody>
</table>
@@ -321,58 +246,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../Title/Title.html" class="btn btn-neutral float-right" title="Title" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../Panel/Panel.html" class="btn btn-neutral float-left" title="Panel" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../Panel/Panel.html" class="btn btn-neutral float-left" title="Panel" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../Title/Title.html" class="btn btn-neutral float-right" title="Title" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<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 src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Toolbar" href="../Toolbar/Toolbar.html" />
<link rel="prev" title="Spinner" href="../Spinner/Spinner.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -130,71 +80,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../Component.html">UI Components</a> &raquo;</li>
<li>Title</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/generated/Component/Title/Title.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class Title</p>
@@ -206,292 +116,331 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 80%" />
<col style="width: 20%" />
<col width="80%" />
<col width="20%" />
</colgroup>
<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>
<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>
</tr>
<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 class="row-even"><td><a class="reference internal" href="#titleforpagewithicon"><span class="std std-ref">ForPageWithIcon</span></a></td>
<td>No comment</td>
</tr>
<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 class="row-odd"><td><a class="reference internal" href="#titleneutral"><span class="std std-ref">Neutral</span></a></td>
<td>No comment</td>
</tr>
<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 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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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>
<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>
<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>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="23%" />
<col width="23%" />
<col width="31%" />
<col width="17%" />
<col 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>
</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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 36%" />
<col style="width: 16%" />
<col style="width: 22%" />
<col style="width: 22%" />
<col style="width: 4%" />
<col width="36%" />
<col width="16%" />
<col width="22%" />
<col width="22%" />
<col width="4%" />
</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>
<tbody valign="top">
<tr class="row-odd"><td>sTitle</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>sIconUrl</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
<tr class="row-even"><td>sIconUrl</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<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 class="row-odd"><td>sIconCoverMethod</td>
<td>string</td>
<td>optional</td>
<td>contain</td>
<td>&#160;</td>
</tr>
<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 class="row-even"><td>bIsMedallion</td>
<td>bool</td>
<td>optional</td>
<td>true</td>
<td>&#160;</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 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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 23%" />
<col style="width: 23%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
<col width="23%" />
<col width="23%" />
<col width="31%" />
<col width="17%" />
<col 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>
<tbody valign="top">
<tr class="row-odd"><td>sTitle</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 class="row-even"><td>iLevel</td>
<td>int</td>
<td>optional</td>
<td>1</td>
<td>&#160;</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 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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 22%" />
<col style="width: 25%" />
<col style="width: 31%" />
<col style="width: 17%" />
<col style="width: 6%" />
<col width="22%" />
<col width="25%" />
<col width="31%" />
<col width="17%" />
<col 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>
<tbody valign="top">
<tr class="row-odd"><td>oTitle</td>
<td>UIBlock</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</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 class="row-even"><td>iLevel</td>
<td>int</td>
<td>optional</td>
<td>1</td>
<td>&#160;</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 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-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">
<table border="1" class="docutils">
<colgroup>
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<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 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><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
<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><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
@@ -500,75 +449,59 @@
</div>
<div class="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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Will display</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
<img alt="../../../_images/Title.png" src="../../../_images/Title.png" />
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../Toolbar/Toolbar.html" class="btn btn-neutral float-right" title="Toolbar" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../Spinner/Spinner.html" class="btn btn-neutral float-left" title="Spinner" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../Spinner/Spinner.html" class="btn btn-neutral float-left" title="Spinner" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../Toolbar/Toolbar.html" class="btn btn-neutral float-right" title="Toolbar" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<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 src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="ToolbarSpacer" href="ToolbarSpacer/ToolbarSpacer.html" />
<link rel="prev" title="Title" href="../Title/Title.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -129,71 +79,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../Component.html">UI Components</a> &raquo;</li>
<li>Toolbar</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/generated/Component/Toolbar/Toolbar.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class Toolbar</p>
@@ -205,214 +115,245 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 76%" />
<col style="width: 24%" />
<col width="76%" />
<col width="24%" />
</colgroup>
<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>
<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>
</tr>
<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 class="row-even"><td><a class="reference internal" href="#toolbarstandard"><span class="std std-ref">Standard</span></a></td>
<td>No comment</td>
</tr>
<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 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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 16%" />
<col style="width: 26%" />
<col style="width: 32%" />
<col style="width: 19%" />
<col style="width: 6%" />
<col width="16%" />
<col width="26%" />
<col width="32%" />
<col width="19%" />
<col 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>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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>
<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>
<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>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="39%" />
<col width="16%" />
<col width="20%" />
<col width="20%" />
<col 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>
</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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<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>
<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>
<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>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="39%" />
<col width="16%" />
<col width="20%" />
<col width="20%" />
<col 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>
</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-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">
<table border="1" class="docutils">
<colgroup>
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
</tr>
<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 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><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
<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><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
@@ -427,58 +368,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="ToolbarSpacer/ToolbarSpacer.html" class="btn btn-neutral float-right" title="ToolbarSpacer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../Title/Title.html" class="btn btn-neutral float-left" title="Title" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../Title/Title.html" class="btn btn-neutral float-left" title="Title" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="ToolbarSpacer/ToolbarSpacer.html" class="btn btn-neutral float-right" title="ToolbarSpacer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>

View File

@@ -1,72 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<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" />
<link rel="stylesheet" href="../../../../_static/css/ui-doc.css" type="text/css" />
<meta charset="utf-8" />
<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" />
<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 type="text/javascript" id="documentation_options" data-url_root="../../../../" 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/language_data.js"></script>
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
<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 src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<link rel="next" title="UI Layouts" href="../../../Layout/Layout.html" />
<link rel="prev" title="Toolbar" href="../Toolbar.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<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" alt="Documentation 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">
<input type="text" name="q" placeholder="Search docs" />
@@ -74,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
@@ -127,71 +77,31 @@
<li class="toctree-l1"><a class="reference internal" href="../../../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../Component.html">UI Components</a> &raquo;</li>
<li>ToolbarSpacer</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../_sources/generated/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<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>
<p>Class ButtonToolbarSpacer</p>
@@ -203,110 +113,125 @@
<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>
<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>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 62%" />
<col style="width: 38%" />
<col width="62%" />
<col width="38%" />
</colgroup>
<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>
<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>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<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>
</tbody>
</table>
<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>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<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">
<colgroup>
<col style="width: 16%" />
<col style="width: 26%" />
<col style="width: 32%" />
<col style="width: 19%" />
<col style="width: 6%" />
<col width="16%" />
<col width="26%" />
<col width="32%" />
<col width="19%" />
<col 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>
<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="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">
<table border="1" class="docutils">
<colgroup>
<col style="width: 30%" />
<col style="width: 8%" />
<col style="width: 62%" />
<col width="30%" />
<col width="8%" />
<col width="62%" />
</colgroup>
<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>
<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>
<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 class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[ibo-is-hidden, ibo-alertbody]&lt;/code&gt;</td>
</tr>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-even"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
<tr class="row-odd"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-even"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
<tr class="row-odd"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
</tr>
<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 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><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [name =&gt; value]</p></td>
<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><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
<tr class="row-even"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
</tbody>
</table>
@@ -321,58 +246,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../../../Layout/Layout.html" class="btn btn-neutral float-right" title="UI Layouts" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../Toolbar.html" class="btn btn-neutral float-left" title="Toolbar" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../Toolbar.html" class="btn btn-neutral float-left" title="Toolbar" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../../../Layout/Layout.html" class="btn btn-neutral float-right" title="UI Layouts" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Combodo
</p>
<p>&#169; Copyright 2021, Combodo.</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>