mirror of
https://github.com/Combodo/iTop.git
synced 2026-03-01 15:14:11 +01:00
386 lines
15 KiB
HTML
386 lines
15 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>UIContentBlock — iTop UI iTop 3.1.0 documentation</title>
|
||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="../../_static/css/ui-doc.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="../../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
|
||
<script src="../../_static/jquery.js"></script>
|
||
<script src="../../_static/underscore.js"></script>
|
||
<script src="../../_static/doctools.js"></script>
|
||
<script src="../../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../search.html" />
|
||
<link rel="prev" title="MultiColumn" href="MultiColumn/MultiColumn.html" />
|
||
</head>
|
||
|
||
<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"> 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" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../Component/Component.html">UI Components</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="Layout.html">UI Layouts</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="MultiColumn/Column/Column.html">Column</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="MultiColumn/MultiColumn.html">MultiColumn</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">UIContentBlock</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#output">Output</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#twig-tag">Twig Tag</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#uicontentblock-standard">UIContentBlock Standard</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#uicontentblock-forcode">UIContentBlock ForCode</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#uicontentblock-forpreformatted">UIContentBlock ForPreformatted</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#uicontentblock-common-parameters">UIContentBlock common parameters</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<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="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../../index.html" class="icon icon-home"></a> »</li>
|
||
<li><a href="Layout.html">UI Layouts</a> »</li>
|
||
<li>UIContentBlock</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
|
||
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="uicontentblock">
|
||
<span id="id1"></span><h1>UIContentBlock<a class="headerlink" href="#uicontentblock" title="Permalink to this headline"></a></h1>
|
||
<p>Class UIContentBlock
|
||
Base block containing sub-blocks</p>
|
||
<hr class="docutils" />
|
||
<section id="output">
|
||
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
|
||
<p>No output provided yet</p>
|
||
</section>
|
||
<hr class="docutils" />
|
||
<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>UIContentBlock</strong></p>
|
||
</dd>
|
||
<dt class="field-even">Syntax</dt>
|
||
<dd class="field-even"><p></p></dd>
|
||
</dl>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIContentBlock</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">EndUIContentBlock</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: 31%" />
|
||
<col style="width: 69%" />
|
||
</colgroup>
|
||
<tbody>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#uicontentblockstandard"><span class="std std-ref">Standard</span></a></p></td>
|
||
<td><p>Make an empty UIContentBlock which can be used to embed anything or to surround another block with specific CSS classes.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#uicontentblockforcode"><span class="std std-ref">ForCode</span></a></p></td>
|
||
<td><p>Used to display a block of code like <pre> but allows line break.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#uicontentblockforpreformatted"><span class="std std-ref">ForPreformatted</span></a></p></td>
|
||
<td><p>Used to display a block of preformatted text in a <pre> tag.</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<section id="uicontentblock-standard">
|
||
<span id="uicontentblockstandard"></span><h3>UIContentBlock Standard<a class="headerlink" href="#uicontentblock-standard" title="Permalink to this headline"></a></h3>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">syntax</dt>
|
||
<dd class="field-odd"><p></p></dd>
|
||
</dl>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIContentBlock</span> <span class="p">S</span><span class="nv">tandard</span> <span class="o">{</span><span class="nv">sId</span><span class="s1">:'value'</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">EndUIContentBlock</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>
|
||
</tr>
|
||
<tr class="row-even"><td><p>aContainerClasses</p></td>
|
||
<td><p>array</p></td>
|
||
<td><p>optional</p></td>
|
||
<td><p>array ()</p></td>
|
||
<td></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
<section id="uicontentblock-forcode">
|
||
<span id="uicontentblockforcode"></span><h3>UIContentBlock ForCode<a class="headerlink" href="#uicontentblock-forcode" title="Permalink to this headline"></a></h3>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">syntax</dt>
|
||
<dd class="field-odd"><p></p></dd>
|
||
</dl>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIContentBlock</span> <span class="p">F</span><span class="nv">orCode</span> <span class="o">{</span><span class="nv">sCode</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:'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">EndUIContentBlock</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>sCode</p></td>
|
||
<td><p>string</p></td>
|
||
<td><p>mandatory</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>sId</p></td>
|
||
<td><p>string</p></td>
|
||
<td><p>optional</p></td>
|
||
<td><p>NULL</p></td>
|
||
<td></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
<section id="uicontentblock-forpreformatted">
|
||
<span id="uicontentblockforpreformatted"></span><h3>UIContentBlock ForPreformatted<a class="headerlink" href="#uicontentblock-forpreformatted" title="Permalink to this headline"></a></h3>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">syntax</dt>
|
||
<dd class="field-odd"><p></p></dd>
|
||
</dl>
|
||
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIContentBlock</span> <span class="p">F</span><span class="nv">orPreformatted</span> <span class="o">{</span><span class="nv">sCode</span><span class="s1">:'value'</span><span class="o">,</span> <span class="nv">sId</span><span class="s1">:'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">EndUIContentBlock</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>sCode</p></td>
|
||
<td><p>string</p></td>
|
||
<td><p>mandatory</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>sId</p></td>
|
||
<td><p>string</p></td>
|
||
<td><p>optional</p></td>
|
||
<td><p>NULL</p></td>
|
||
<td></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
<section id="uicontentblock-common-parameters">
|
||
<h3>UIContentBlock common parameters<a class="headerlink" href="#uicontentblock-common-parameters" title="Permalink to this headline"></a></h3>
|
||
<table class="docutils align-default">
|
||
<colgroup>
|
||
<col style="width: 29%" />
|
||
<col style="width: 10%" />
|
||
<col style="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>
|
||
</tr>
|
||
<tr class="row-even"><td><p>AddCSSClasses</p></td>
|
||
<td><p>array</p></td>
|
||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
|
||
<td><p>string</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
|
||
<td><p>iUIBlock</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>AddHtml</p></td>
|
||
<td><p>string</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
|
||
<td><p>string</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
|
||
<td><p>array</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
|
||
<td><p>array</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>AddSubBlock</p></td>
|
||
<td><p>iUIBlock</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>CSSClasses</p></td>
|
||
<td><p>array</p></td>
|
||
<td><p>like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code></p></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’ => ‘value’]</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>DeferredBlocks</p></td>
|
||
<td><p>array</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>HasForcedDiv</p></td>
|
||
<td><p>bool</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>IsHidden</p></td>
|
||
<td><p>bool</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>SubBlocks</p></td>
|
||
<td><p>array</p></td>
|
||
<td></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr class="docutils" />
|
||
</section>
|
||
</section>
|
||
<section id="examples">
|
||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
|
||
<p>No examples provided yet</p>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="MultiColumn/MultiColumn.html" class="btn btn-neutral float-left" title="MultiColumn" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2022, Combodo.</p>
|
||
</div>
|
||
|
||
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>
|
||
|
||
<!--
|
||
~ @copyright Copyright (C) 2010-2022 Combodo SARL
|
||
~ @license http://opensource.org/licenses/AGPL-3.0
|
||
-->
|
||
|
||
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
|
||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||
<span class="fa fa-book"> Other Versions</span>
|
||
v: documentation/3.0
|
||
<span class="fa fa-caret-down"></span>
|
||
</span>
|
||
<div class="rst-other-versions">
|
||
<dl>
|
||
<dt>Branches</dt>
|
||
<dd><a href="UIContentBlock.html">documentation/3.0</a></dd>
|
||
<dd><a href="../../../latest/generated/Layout/UIContentBlock.html">documentation/latest</a></dd>
|
||
</dl>
|
||
</div>
|
||
</div><script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |