com.phloxui
Version:
PhloxUI Ng2+ Framework
836 lines • 48 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>INavigator | com.phloxui</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">com.phloxui</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_component_inavigator_.html">"component/INavigator"</a>
</li>
<li>
<a href="_component_inavigator_.inavigator.html">INavigator</a>
</li>
</ul>
<h1>Interface INavigator<T></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 2em;">
An interface for component class having navigation mechanism. For example, a menu bar having
menu items to navigate through each page should implement this interface.
</p>
</div>
<dl class="tsd-comment-tags">
<dt>author</dt>
<dd><p>shiorin, tee4cute</p>
</dd>
<dt>see</dt>
<dd><p><a href="_component_inavigatee_.inavigatee.html">INavigatee</a></p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="_component_inavigatee_.inavigatee.html" class="tsd-signature-type">INavigatee</a></h4>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A type of <code>navigatee</code> item can be navigated by this <code>navigator</code>.</p>
</div>
</div>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">INavigator</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/_component_abstractnavleftlayout_.abstractnavleftlayout.html" class="tsd-signature-type">AbstractNavLeftLayout</a></li>
<li><a href="../classes/_component_abstractnavmenu_.abstractnavmenu.html" class="tsd-signature-type">AbstractNavMenu</a></li>
<li><a href="../classes/_component_phloxapp_component_.phloxapp.html" class="tsd-signature-type">PhloxApp</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#additem" class="tsd-kind-icon">add<wbr>Item</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#containsitem" class="tsd-kind-icon">contains<wbr>Item</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#getactiveindex" class="tsd-kind-icon">get<wbr>Active<wbr>Index</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#getactiveitem" class="tsd-kind-icon">get<wbr>Active<wbr>Item</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#getitembyindex" class="tsd-kind-icon">get<wbr>Item<wbr>ByIndex</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#getitembyname" class="tsd-kind-icon">get<wbr>Item<wbr>ByName</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#getitemcount" class="tsd-kind-icon">get<wbr>Item<wbr>Count</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#getitemindex" class="tsd-kind-icon">get<wbr>Item<wbr>Index</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#getitemindexbyname" class="tsd-kind-icon">get<wbr>Item<wbr>Index<wbr>ByName</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#getitems" class="tsd-kind-icon">get<wbr>Items</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#navigateto" class="tsd-kind-icon">navigate<wbr>To</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#navigatetoindex" class="tsd-kind-icon">navigate<wbr>ToIndex</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#navigatetoname" class="tsd-kind-icon">navigate<wbr>ToName</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#removeitem" class="tsd-kind-icon">remove<wbr>Item</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#reset" class="tsd-kind-icon">reset</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_inavigator_.inavigator.html#setitems" class="tsd-kind-icon">set<wbr>Items</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="additem" class="tsd-anchor"></a>
<h3>add<wbr>Item</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">add<wbr>Item<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:121</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Add a new <code>navigatee</code> <code><b>item</b></code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) into this <code>navigator</code>. This method will check that there already is the
given <code><b>item</b></code> in this <code>navigator</code> or not. If yes, the <code><b>item</b></code> will not be added and this method
will return <code>false</code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>item: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>A new <code>navigatee</code> item (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) to be added into this <code>navigator</code>.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>Returns <code>true</code> if the given <code><b>item</b></code> is newly added into this <code>navigator</code>. Otherwise, returns
<code>false</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="containsitem" class="tsd-anchor"></a>
<h3>contains<wbr>Item</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">contains<wbr>Item<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:143</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
To check that the given <code>navigatee</code> <code><b>item</b></code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) is currently in this <code>navigator</code> or not.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>item: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>navigatee</code> item to be checked.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>Returns <code>true</code> if the given <code><b>item</b></code> is currently in this <code>navigator</code>. Otherwise, returns <code>false</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getactiveindex" class="tsd-anchor"></a>
<h3>get<wbr>Active<wbr>Index</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Active<wbr>Index<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:55</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get current active <code>navigatee</code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) item's index. The value returned from this method must be an
index of array returning from method <a href="_component_inavigator_.inavigator.html#getitems">getItems</a>.
</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>The index of <code>navigatee</code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) item currently active. Returns <code>-1</code> if there is no
current active item.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getactiveitem" class="tsd-anchor"></a>
<h3>get<wbr>Active<wbr>Item</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Active<wbr>Item<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:44</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get current active <code>navigatee</code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) item. In most scenarios, this method should return the item
representing the component (page) being displayed by this <code>navigator</code>.
</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
<p>The current active <code>navigatee</code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) item being displayed by this <code>navigator</code>.
Returns <code>null</code> if there is no current active item.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getitembyindex" class="tsd-anchor"></a>
<h3>get<wbr>Item<wbr>ByIndex</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Item<wbr>ByIndex<span class="tsd-signature-symbol">(</span>idx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:88</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get the <code>navigatee</code> item (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) by the given <code><b>idx</b></code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>idx: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>navigatee</code> item array index (starting from <code>0</code>).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
<p>The <code>navigatee</code> item (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) at the specified <code><b>idx</b></code>. If the specified <code><b>idx</b></code> is
out of bound, this method will returns <code>null</code> without throwing any exceptions.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getitembyname" class="tsd-anchor"></a>
<h3>get<wbr>Item<wbr>ByName</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Item<wbr>ByName<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:99</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get the <code>navigatee</code> item (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) by the given item <code><b>name</b></code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The name of <code>navigatee</code> item.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
<p>The <code>navigatee</code> item having the name (<a href="_component_inavigatee_.inavigatee.html#getname">INavigatee.getName</a>) matches the <code><b>name</b></code> passed as a parameter.
Returns <code>null</code> if not found.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getitemcount" class="tsd-anchor"></a>
<h3>get<wbr>Item<wbr>Count</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Item<wbr>Count<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:33</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get number of <code>navigatee</code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) items can be navigated by this <code>navigator</code>.
This must be the same value as <a href="_component_inavigator_.inavigator.html#getitems">getItems</a>'s length.
</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>The <code>navigatee</code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) item count.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getitemindex" class="tsd-anchor"></a>
<h3>get<wbr>Item<wbr>Index</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Item<wbr>Index<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:65</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Find the index of the given <code>navigatee</code> <code><b>item</b></code> in the items array returned from method <a href="_component_inavigator_.inavigator.html#getitems">getItems</a>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>item: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>navigatee</code> item to find the index.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>The index of the given <code><b>item</b></code>. Returns <code>-1</code> if not found.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getitemindexbyname" class="tsd-anchor"></a>
<h3>get<wbr>Item<wbr>Index<wbr>ByName</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Item<wbr>Index<wbr>ByName<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:77</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Find the index of <code>navigatee</code> item having <code>item name</code> (<a href="_component_inavigatee_.inavigatee.html#getname">INavigatee.getName</a>) matches the <code><b>name</b></code>
passed as a parameter.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The name of <code>navigatee</code> item to find the index.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>The index of the <code>navigatee</code> item having <code>item name</code> (<a href="_component_inavigatee_.inavigatee.html#getname">INavigatee.getName</a>) matches the <code><b>name</b></code>
passed as a parameter. Returns <code>-1</code> if not found.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getitems" class="tsd-anchor"></a>
<h3>get<wbr>Items</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Items<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:23</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get <code>navigatee</code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) items can be navigated by this <code>navigator</code>.
</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h4>
<p>An array of <code>navigatee</code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) items can be navigated by this <code>navigator</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="navigateto" class="tsd-anchor"></a>
<h3>navigate<wbr>To</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">navigate<wbr>To<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:159</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Navigate this <code>navigator</code> to the given <code><b>item</b></code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>). This method returns <code>Promise</code> to allow the navigation to be
asynchronous. If the <code><b>item</b></code> is not in this <code>navigator</code>, this method will suddenly return resolved <code>Promise</code> having result value
<code>"false"</code>. Otherwise, it'll return a <code>Promise</code> which will be resolved when the navigation is done with result value <code>"true"</code>. The
navigated-to <code><b>item</b></code> will be set <code>active</code> flag to <code>true</code> and all other <code>navigatee</code> items in this <code>navigator</code>
will be set <code>active</code> flag to <code>false</code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>item: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>navigatee</code> item to be navigated to.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>options</code> object used for the navigation. This will depend on each navigator implementation.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
<p>A <code>Promise</code> which will be resolved when the navigation is done with result value <code>"true"</code>. If the given <code><b>item</b></code> is not
in this <code>navigator</code>, this method will return a resolved <code>Promise</code> with result value <code>"false"</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="navigatetoindex" class="tsd-anchor"></a>
<h3>navigate<wbr>ToIndex</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">navigate<wbr>ToIndex<span class="tsd-signature-symbol">(</span>idx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:175</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Navigate this <code>navigator</code> to the given <code>navigatee</code> item <code><b>idx</b></code>. This method returns <code>Promise</code> to allow the navigation to be
asynchronous. If the given <code><b>idx</b></code> is out of bound, this method will suddenly return resolved <code>Promise</code> having result value <code>"false"</code>.
Otherwise, it'll return a <code>Promise</code> which will be resolved when the navigation is done with result value <code>"true"</code>. The navigated-to <code><b>item</b></code>
will be set <code>active</code> flag to <code>true</code> and all other <code>navigatee</code> items in this <code>navigator</code> will be set <code>active</code> flag to
<code>false</code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>idx: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>navigatee</code> item <code><b>idx</b></code> to be navigated to.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>options</code> object used for the navigation. This will depend on each navigator implementation.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
<p>A <code>Promise</code> which will be resolved when the navigation is done with result value <code>"true"</code>. If the given <code><b>idx</b></code> is out of
bound, this method will return a resolved <code>Promise</code> with result value <code>"false"</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="navigatetoname" class="tsd-anchor"></a>
<h3>navigate<wbr>ToName</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">navigate<wbr>ToName<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:191</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Navigate this <code>navigator</code> to the given <code>navigatee</code> item <code><b>name</b></code>. This method returns <code>Promise</code> to allow the navigation to be
asynchronous. If the given item <code><b>name</b></code> does not exist, this method will suddenly return resolved <code>Promise</code> having result value <code>"false"</code>.
Otherwise, it'll return a <code>Promise</code> which will be resolved when the navigation is done with result value <code>"true"</code>. The navigated-to <code><b>item</b></code>
will be set <code>active</code> flag to <code>true</code> and all other <code>navigatee</code> items in this <code>navigator</code> will be set <code>active</code> flag to
<code>false</code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>navigatee</code> item <code><b>name</b></code> to be navigated to.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>options</code> object used for the navigation. This will depend on each navigator implementation.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
<p>A <code>Promise</code> which will be resolved when the navigation is done with result value <code>"true"</code>. If the given item <code><b>name</b></code> does not
exist, this method will return a resolved <code>Promise</code> with result value <code>"false"</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="removeitem" class="tsd-anchor"></a>
<h3>remove<wbr>Item</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">remove<wbr>Item<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:133</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Remove the given <code>navigatee</code> <code><b>item</b></code> (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) from this <code>navigator</code>. If the given <code><b>item</b></code> is
not currently in this <code>navigator</code>, this method will do nothing and return <code>false</code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>item: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>navigatee</code> item to be removed from this <code>navigator</code>.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>Returns <code>true</code> if the given <code><b>item</b></code> is in this <code>navigator</code> and successfully removed. Otherwise, returns
<code>false</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="reset" class="tsd-anchor"></a>
<h3>reset</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">reset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:198</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Reset this <code>navigator</code> to the original state.
</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="setitems" class="tsd-anchor"></a>
<h3>set<wbr>Items</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">set<wbr>Items<span class="tsd-signature-symbol">(</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in component/INavigator.ts:108</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Set <code>navigatee</code> items (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) into this <code>navigator</code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>items: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <code>navigatee</code> items (<a href="_component_inavigatee_.inavigatee.html">INavigatee</a>) to be set into this <code>navigator</code>.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_component_inavigator_.html">"component/INavigator"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_component_inavigator_.inavigator.html" class="tsd-kind-icon">INavigator</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#additem" class="tsd-kind-icon">add<wbr>Item</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#containsitem" class="tsd-kind-icon">contains<wbr>Item</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#getactiveindex" class="tsd-kind-icon">get<wbr>Active<wbr>Index</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#getactiveitem" class="tsd-kind-icon">get<wbr>Active<wbr>Item</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#getitembyindex" class="tsd-kind-icon">get<wbr>Item<wbr>ByIndex</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#getitembyname" class="tsd-kind-icon">get<wbr>Item<wbr>ByName</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#getitemcount" class="tsd-kind-icon">get<wbr>Item<wbr>Count</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#getitemindex" class="tsd-kind-icon">get<wbr>Item<wbr>Index</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#getitemindexbyname" class="tsd-kind-icon">get<wbr>Item<wbr>Index<wbr>ByName</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#getitems" class="tsd-kind-icon">get<wbr>Items</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#navigateto" class="tsd-kind-icon">navigate<wbr>To</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#navigatetoindex" class="tsd-kind-icon">navigate<wbr>ToIndex</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#navigatetoname" class="tsd-kind-icon">navigate<wbr>ToName</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#removeitem" class="tsd-kind-icon">remove<wbr>Item</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#reset" class="tsd-kind-icon">reset</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_component_inavigator_.inavigator.html#setitems" class="tsd-kind-icon">set<wbr>Items</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>