<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>itc-ng documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">itc-ng documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content class">
<div class="content-data">
<ol class="breadcrumb">
<li>Classes</li>
<li>BookletConfig</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#readme" role="tab" id="readme-tab" data-toggle="tab" data-link="readme">README</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/config/booklet-config.ts</code>
</p>
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#force_presentation_complete">force_presentation_complete</a>
</li>
<li>
<a href="#force_responses_complete">force_responses_complete</a>
</li>
<li>
<a href="#loading_mode">loading_mode</a>
</li>
<li>
<a href="#logPolicy">logPolicy</a>
</li>
<li>
<a href="#page_navibuttons">page_navibuttons</a>
</li>
<li>
<a href="#pagingMode">pagingMode</a>
</li>
<li>
<a href="#stateReportPolicy">stateReportPolicy</a>
</li>
<li>
<a href="#unit_menu">unit_menu</a>
</li>
<li>
<a href="#unit_navibuttons">unit_navibuttons</a>
</li>
<li>
<a href="#unit_screenheader">unit_screenheader</a>
</li>
<li>
<a href="#unit_show_time_left">unit_show_time_left</a>
</li>
<li>
<a href="#unit_title">unit_title</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Public</span>
<a href="#setFromKeyValuePairs">setFromKeyValuePairs</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#setFromXml">setFromXml</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="force_presentation_complete"></a>
<span class="name">
<b>
force_presentation_complete</b>
<a href="#force_presentation_complete"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"OFF" | "ON"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"OFF"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="12" class="link-to-prism">src/app/config/booklet-config.ts:12</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="force_responses_complete"></a>
<span class="name">
<b>
force_responses_complete</b>
<a href="#force_responses_complete"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"OFF" | "SOME" | "COMPLETE" | "COMPLETE_AND_VALID"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"OFF"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="13" class="link-to-prism">src/app/config/booklet-config.ts:13</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="loading_mode"></a>
<span class="name">
<b>
loading_mode</b>
<a href="#loading_mode"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"LAZY" | "EAGER"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"LAZY"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="5" class="link-to-prism">src/app/config/booklet-config.ts:5</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="logPolicy"></a>
<span class="name">
<b>
logPolicy</b>
<a href="#logPolicy"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"disabled" | "lean" | "rich" | "debug"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"rich"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="6" class="link-to-prism">src/app/config/booklet-config.ts:6</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="page_navibuttons"></a>
<span class="name">
<b>
page_navibuttons</b>
<a href="#page_navibuttons"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"OFF" | "MERGED" | "SEPARATE_TOP" | "SEPARATE_BOTTOM"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"SEPARATE_BOTTOM"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="9" class="link-to-prism">src/app/config/booklet-config.ts:9</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="pagingMode"></a>
<span class="name">
<b>
pagingMode</b>
<a href="#pagingMode"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"separate" | "concat-scroll" | "concat-scroll-snap"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"separate"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="7" class="link-to-prism">src/app/config/booklet-config.ts:7</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="stateReportPolicy"></a>
<span class="name">
<b>
stateReportPolicy</b>
<a href="#stateReportPolicy"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"none" | "eager" | "on-demand"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"eager"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="8" class="link-to-prism">src/app/config/booklet-config.ts:8</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="unit_menu"></a>
<span class="name">
<b>
unit_menu</b>
<a href="#unit_menu"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"OFF" | "ENABLED_ONLY" | "FULL"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"OFF"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">src/app/config/booklet-config.ts:11</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="unit_navibuttons"></a>
<span class="name">
<b>
unit_navibuttons</b>
<a href="#unit_navibuttons"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"OFF" | "ARROWS_ONLY" | "FULL"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"FULL"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="10" class="link-to-prism">src/app/config/booklet-config.ts:10</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="unit_screenheader"></a>
<span class="name">
<b>
unit_screenheader</b>
<a href="#unit_screenheader"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"OFF" | "WITH_UNIT_TITLE" | "WITH_BOOKLET_TITLE" | "EMPTY"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"EMPTY"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="14" class="link-to-prism">src/app/config/booklet-config.ts:14</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="unit_show_time_left"></a>
<span class="name">
<b>
unit_show_time_left</b>
<a href="#unit_show_time_left"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"OFF" | "ON"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"OFF"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="16" class="link-to-prism">src/app/config/booklet-config.ts:16</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="unit_title"></a>
<span class="name">
<b>
unit_title</b>
<a href="#unit_title"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"OFF" | "ON"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"ON"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/app/config/booklet-config.ts:15</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="setFromKeyValuePairs"></a>
<span class="name">
<b>
<span class="modifier">Public</span>
setFromKeyValuePairs
</b>
<a href="#setFromKeyValuePairs"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>setFromKeyValuePairs(config)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="18"
class="link-to-prism">src/app/config/booklet-config.ts:18</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>config</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="setFromXml"></a>
<span class="name">
<b>
<span class="modifier">Public</span>
setFromXml
</b>
<a href="#setFromXml"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>setFromXml(bookletConfigElement: Element)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="35"
class="link-to-prism">src/app/config/booklet-config.ts:35</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>bookletConfigElement</td>
<td>
<code>Element</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade " id="c-readme">
<p><h1 id="booklet-config">Booklet config</h1>
<p>There are some configuration parameters for adjusting the behaviour during the test.This
document describes the ways to bring the parameters to the application and lists
all possible keys.</p>
<h3 id="configuration-file-on-the-server">Configuration file on the server</h3>
<p>There is one file on the server where the application looks for booklet definitions:</p>
<div><pre class="line-numbers"><code class="language-none">/config/bookletDefintions.json</code></pre></div><p>This configuration is loaded at (re)start of the application and is applied for
all booklets, if no other configuration is found. This is a simple JSON file with
key value pairs. Example:</p>
<div><pre class="line-numbers"><code class="language-none">{
"force_responses_complete": "OFF",
"unit_navibuttons": "ARROWS_ONLY",
...
}</code></pre></div><p>The adminstrator of the server can upload this file. We aim at providing an
administration feature of the super-admin section of the application to manage
this configuration.</p>
<h3 id="configuration-via-booklet-xml">Configuration via booklet XML</h3>
<p>The configuration can be set for every single booklet. You need to add one XML-Element
into the booklet-file. Example:</p>
<div><pre class="line-numbers"><code class="language-none">...
</Metadata>
<BookletConfig>
<Config key="force_responses_complete">OFF</CustomText>
<Config key="unit_navibuttons">ARROWS_ONLY</CustomText>
...
</BookletConfig></code></pre></div><h3 id="list-of-parameters">List of parameters</h3>
</p>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">export class BookletConfig {
// this file is generated by 'generateBookletConfigClass' script from 'app/config/booklet-config.json'
// do not change anything here directly!
loading_mode: "LAZY" | "EAGER" = "LAZY";
logPolicy: "disabled" | "lean" | "rich" | "debug" = "rich";
pagingMode: "separate" | "concat-scroll" | "concat-scroll-snap" = "separate";
stateReportPolicy: "none" | "eager" | "on-demand" = "eager";
page_navibuttons: "OFF" | "MERGED" | "SEPARATE_TOP" | "SEPARATE_BOTTOM" = "SEPARATE_BOTTOM";
unit_navibuttons: "OFF" | "ARROWS_ONLY" | "FULL" = "FULL";
unit_menu: "OFF" | "ENABLED_ONLY" | "FULL" = "OFF";
force_presentation_complete: "OFF" | "ON" = "OFF";
force_responses_complete: "OFF" | "SOME" | "COMPLETE" | "COMPLETE_AND_VALID" = "OFF";
unit_screenheader: "OFF" | "WITH_UNIT_TITLE" | "WITH_BOOKLET_TITLE" | "EMPTY" = "EMPTY";
unit_title: "OFF" | "ON" = "ON";
unit_show_time_left: "OFF" | "ON" = "OFF";
public setFromKeyValuePairs(config) {
if (config) {
if (config['loading_mode']) { this.loading_mode = config['loading_mode']}
if (config['logPolicy']) { this.logPolicy = config['logPolicy']}
if (config['pagingMode']) { this.pagingMode = config['pagingMode']}
if (config['stateReportPolicy']) { this.stateReportPolicy = config['stateReportPolicy']}
if (config['page_navibuttons']) { this.page_navibuttons = config['page_navibuttons']}
if (config['unit_navibuttons']) { this.unit_navibuttons = config['unit_navibuttons']}
if (config['unit_menu']) { this.unit_menu = config['unit_menu']}
if (config['force_presentation_complete']) { this.force_presentation_complete = config['force_presentation_complete']}
if (config['force_responses_complete']) { this.force_responses_complete = config['force_responses_complete']}
if (config['unit_screenheader']) { this.unit_screenheader = config['unit_screenheader']}
if (config['unit_title']) { this.unit_title = config['unit_title']}
if (config['unit_show_time_left']) { this.unit_show_time_left = config['unit_show_time_left']}
}
}
public setFromXml(bookletConfigElement: Element) {
if (bookletConfigElement) {
const bookletConfigs = Array.prototype.slice.call(bookletConfigElement.childNodes).filter(function (e) { return e.nodeType === 1; });
for (let childIndex = 0; childIndex < bookletConfigs.length; childIndex++) {
const configKey = bookletConfigs[childIndex].getAttribute('key');
const configValue = bookletConfigs[childIndex].textContent;
switch (configKey) {
case 'loading_mode':
this.loading_mode = configValue;
break;
case 'logPolicy':
this.logPolicy = configValue;
break;
case 'pagingMode':
this.pagingMode = configValue;
break;
case 'stateReportPolicy':
this.stateReportPolicy = configValue;
break;
case 'page_navibuttons':
this.page_navibuttons = configValue;
break;
case 'unit_navibuttons':
this.unit_navibuttons = configValue;
break;
case 'unit_menu':
this.unit_menu = configValue;
break;
case 'force_presentation_complete':
this.force_presentation_complete = configValue;
break;
case 'force_responses_complete':
this.force_responses_complete = configValue;
break;
case 'unit_screenheader':
this.unit_screenheader = configValue;
break;
case 'unit_title':
this.unit_title = configValue;
break;
case 'unit_show_time_left':
this.unit_show_time_left = configValue;
break;
}
}
}
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'BookletConfig.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
<script src="../js/menu-wc.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>