UNPKG

@web-atoms/core-docs

Version:
789 lines 60.1 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>WindowService | @web-atoms/core</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">@web-atoms/core</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> </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/_web_services_windowservice_.html">&quot;web/services/WindowService&quot;</a> </li> <li> <a href="_web_services_windowservice_.windowservice.html">WindowService</a> </li> </ul> <h1>Class WindowService</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="_services_navigationservice_.navigationservice.html" class="tsd-signature-type">NavigationService</a> <ul class="tsd-hierarchy"> <li> <span class="target">WindowService</span> </li> </ul> </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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="_web_services_windowservice_.windowservice.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_web_services_windowservice_.windowservice.html#app" class="tsd-kind-icon">app</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_web_services_windowservice_.windowservice.html#screen" class="tsd-kind-icon">screen</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_web_services_windowservice_.windowservice.html#alertwindow" class="tsd-kind-icon">alert<wbr>Window</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_web_services_windowservice_.windowservice.html#currenttarget" class="tsd-kind-icon">current<wbr>Target</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite"><a href="_web_services_windowservice_.windowservice.html#location" class="tsd-kind-icon">location</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite"><a href="_web_services_windowservice_.windowservice.html#title" class="tsd-kind-icon">title</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_web_services_windowservice_.windowservice.html#alert" class="tsd-kind-icon">alert</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_web_services_windowservice_.windowservice.html#back" class="tsd-kind-icon">back</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_web_services_windowservice_.windowservice.html#closepopup" class="tsd-kind-icon">close<wbr>Popup</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_web_services_windowservice_.windowservice.html#confirm" class="tsd-kind-icon">confirm</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_web_services_windowservice_.windowservice.html#gethostforelement" class="tsd-kind-icon">get<wbr>Host<wbr>For<wbr>Element</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_web_services_windowservice_.windowservice.html#navigate" class="tsd-kind-icon">navigate</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_web_services_windowservice_.windowservice.html#notify" class="tsd-kind-icon">notify</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="_web_services_windowservice_.windowservice.html#openpage" class="tsd-kind-icon">open<wbr>Page</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite tsd-is-protected"><a href="_web_services_windowservice_.windowservice.html#openwindow" class="tsd-kind-icon">open<wbr>Window</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_web_services_windowservice_.windowservice.html#refresh" class="tsd-kind-icon">refresh</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_web_services_windowservice_.windowservice.html#refreshscreen" class="tsd-kind-icon">refresh<wbr>Screen</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_web_services_windowservice_.windowservice.html#register" class="tsd-kind-icon">register</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_web_services_windowservice_.windowservice.html#registerforpopup" class="tsd-kind-icon">register<wbr>For<wbr>Popup</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_web_services_windowservice_.windowservice.html#registerhostforwindow" class="tsd-kind-icon">register<wbr>Host<wbr>For<wbr>Window</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_web_services_windowservice_.windowservice.html#registernavigationhook" class="tsd-kind-icon">register<wbr>Navigation<wbr>Hook</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_web_services_windowservice_.windowservice.html#remove" class="tsd-kind-icon">remove</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">new <wbr>Window<wbr>Service<span class="tsd-signature-symbol">(</span>app<span class="tsd-signature-symbol">: </span><a href="_app_.app.html" class="tsd-signature-type">App</a>, jsonService<span class="tsd-signature-symbol">: </span><a href="_services_jsonservice_.jsonservice.html" class="tsd-signature-type">JsonService</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_web_services_windowservice_.windowservice.html" class="tsd-signature-type">WindowService</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#constructor">constructor</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L102">src/web/services/WindowService.ts:102</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>app: <a href="_app_.app.html" class="tsd-signature-type">App</a></h5> </li> <li> <h5>jsonService: <a href="_services_jsonservice_.jsonservice.html" class="tsd-signature-type">JsonService</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_web_services_windowservice_.windowservice.html" class="tsd-signature-type">WindowService</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="app" class="tsd-anchor"></a> <h3>app</h3> <div class="tsd-signature tsd-kind-icon">app<span class="tsd-signature-symbol">:</span> <a href="_app_.app.html" class="tsd-signature-type">App</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#app">app</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/NavigationService.ts#L80">src/services/NavigationService.ts:80</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="screen" class="tsd-anchor"></a> <h3>screen</h3> <div class="tsd-signature tsd-kind-icon">screen<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_core_iscreen_.iscreen.html" class="tsd-signature-type">IScreen</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L36">src/web/services/WindowService.ts:36</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="alertwindow" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> alert<wbr>Window</h3> <div class="tsd-signature tsd-kind-icon">alert<wbr>Window<span class="tsd-signature-symbol">:</span> <a href="_web_controls_atomalertwindow_.atomalertwindow.html" class="tsd-signature-type">AtomAlertWindow</a><span class="tsd-signature-symbol"> =&nbsp;AtomAlertWindow</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L34">src/web/services/WindowService.ts:34</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This is just to preload Alert window.</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="currenttarget" class="tsd-anchor"></a> <h3>current<wbr>Target</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> currentTarget<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> currentTarget<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</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 <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L39">src/web/services/WindowService.ts:39</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLElement</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L43">src/web/services/WindowService.ts:43</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>v: <span class="tsd-signature-type">HTMLElement</span></h5> </li> </ul> <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-accessor tsd-parent-kind-class tsd-is-overwrite"> <a name="location" class="tsd-anchor"></a> <h3>location</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> location<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_core_atomuri_.atomuri.html" class="tsd-signature-type">AtomUri</a></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> location<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><a href="_core_atomuri_.atomuri.html" class="tsd-signature-type">AtomUri</a><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"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#location">location</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L96">src/web/services/WindowService.ts:96</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets current location of browser, this does not return actual location but it returns values of browser location. This is done to provide mocking behavior for unit testing.</p> </div> <dl class="tsd-comment-tags"> <dt>readonly</dt> <dd></dd> <dt>type</dt> <dd><p>{AtomLocation}</p> </dd> <dt>memberof</dt> <dd><p>BrowserService</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <a href="_core_atomuri_.atomuri.html" class="tsd-signature-type">AtomUri</a></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#location">location</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L100">src/web/services/WindowService.ts:100</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets current location of browser, this does not return actual location but it returns values of browser location. This is done to provide mocking behavior for unit testing.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>v: <a href="_core_atomuri_.atomuri.html" class="tsd-signature-type">AtomUri</a></h5> </li> </ul> <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-accessor tsd-parent-kind-class tsd-is-overwrite"> <a name="title" class="tsd-anchor"></a> <h3>title</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> title<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> title<span class="tsd-signature-symbol">(</span>v<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#title">title</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L75">src/web/services/WindowService.ts:75</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get current window title</p> </div> <dl class="tsd-comment-tags"> <dt>type</dt> <dd><p>{string}</p> </dd> <dt>memberof</dt> <dd><p>BrowserService</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#title">title</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L83">src/web/services/WindowService.ts:83</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set current window title</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>BrowserService</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>v: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </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-class tsd-is-overwrite"> <a name="alert" class="tsd-anchor"></a> <h3>alert</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">alert<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_formattedstring_.formattedstring.html" class="tsd-signature-type">FormattedString</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span>, title<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#alert">alert</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L189">src/web/services/WindowService.ts:189</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_formattedstring_.formattedstring.html" class="tsd-signature-type">FormattedString</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> title: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="back" class="tsd-anchor"></a> <h3>back</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">back<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"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#back">back</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L165">src/web/services/WindowService.ts:165</a></li> </ul> </aside> <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-class"> <a name="closepopup" class="tsd-anchor"></a> <h3>close<wbr>Popup</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">close<wbr>Popup<span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MouseEvent</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 <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L209">src/web/services/WindowService.ts:209</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>e: <span class="tsd-signature-type">MouseEvent</span></h5> </li> </ul> <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-class tsd-is-overwrite"> <a name="confirm" class="tsd-anchor"></a> <h3>confirm</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">confirm<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_formattedstring_.formattedstring.html" class="tsd-signature-type">FormattedString</a>, title<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#confirm">confirm</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L173">src/web/services/WindowService.ts:173</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_formattedstring_.formattedstring.html" class="tsd-signature-type">FormattedString</a></h5> </li> <li> <h5>title: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="gethostforelement" class="tsd-anchor"></a> <h3>get<wbr>Host<wbr>For<wbr>Element</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Host<wbr>For<wbr>Element<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L264">src/web/services/WindowService.ts:264</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLElement</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="navigate" class="tsd-anchor"></a> <h3>navigate</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">navigate<span class="tsd-signature-symbol">(</span>url<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#navigate">navigate</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L161">src/web/services/WindowService.ts:161</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Navigate current browser to given url.</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>BrowserService</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> </ul> <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-class tsd-is-overwrite"> <a name="notify" class="tsd-anchor"></a> <h3>notify</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">notify<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_formattedstring_.formattedstring.html" class="tsd-signature-type">FormattedString</a>, title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">?: </span><a href="../enums/_services_navigationservice_.notifytype.html" class="tsd-signature-type">NotifyType</a>, delay<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#notify">notify</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L286">src/web/services/WindowService.ts:286</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_formattedstring_.formattedstring.html" class="tsd-signature-type">FormattedString</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> title: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> type: <a href="../enums/_services_navigationservice_.notifytype.html" class="tsd-signature-type">NotifyType</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> delay: <span class="tsd-signature-type">number</span></h5> </li> </ul> <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-class tsd-has-type-parameter tsd-is-inherited"> <a name="openpage" class="tsd-anchor"></a> <h3>open<wbr>Page</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">open<wbr>Page&lt;T&gt;<span class="tsd-signature-symbol">(</span>pageName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span>, viewModelParameters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_core_types_.inamevaluepairs.html" class="tsd-signature-type">INameValuePairs</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_services_navigationservice_.ipageoptions.html" class="tsd-signature-type">IPageOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#openpage">openPage</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/NavigationService.ts#L93">src/services/NavigationService.ts:93</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>pageName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>node style package url or a class</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> viewModelParameters: <a href="../interfaces/_core_types_.inamevaluepairs.html" class="tsd-signature-type">INameValuePairs</a></h5> <div class="tsd-comment tsd-typography"> <p>key value pair that will be injected on ViewModel when created</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_services_navigationservice_.ipageoptions.html" class="tsd-signature-type">IPageOptions</a></h5> <div class="tsd-comment tsd-typography"> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite tsd-is-protected"> <a name="openwindow" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> open<wbr>Window</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">open<wbr>Window&lt;T&gt;<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><a href="_core_atomuri_.atomuri.html" class="tsd-signature-type">AtomUri</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_services_navigationservice_.ipageoptions.html" class="tsd-signature-type">IPageOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#openwindow">openWindow</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L308">src/web/services/WindowService.ts:308</a></li> </ul> </aside> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <a href="_core_atomuri_.atomuri.html" class="tsd-signature-type">AtomUri</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_services_navigationservice_.ipageoptions.html" class="tsd-signature-type">IPageOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="refresh" class="tsd-anchor"></a> <h3>refresh</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">refresh<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"> <p>Overrides <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#refresh">refresh</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L260">src/web/services/WindowService.ts:260</a></li> </ul> </aside> <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-class"> <a name="refreshscreen" class="tsd-anchor"></a> <h3>refresh<wbr>Screen</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">refresh<wbr>Screen<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 <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L278">src/web/services/WindowService.ts:278</a></li> </ul> </aside> <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-class"> <a name="register" class="tsd-anchor"></a> <h3>register</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><a href="../interfaces/_core_types_.iclassof.html" class="tsd-signature-type">IClassOf</a><span class="tsd-signature-symbol">&lt;</span><a href="_web_controls_atomcontrol_.atomcontrol.html" class="tsd-signature-type">AtomControl</a><span class="tsd-signature-symbol">&gt;</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 <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L169">src/web/services/WindowService.ts:169</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>id: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>type: <a href="../interfaces/_core_types_.iclassof.html" class="tsd-signature-type">IClassOf</a><span class="tsd-signature-symbol">&lt;</span><a href="_web_controls_atomcontrol_.atomcontrol.html" class="tsd-signature-type">AtomControl</a><span class="tsd-signature-symbol">&gt;</span></h5> </li> </ul> <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-class tsd-is-protected"> <a name="registerforpopup" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> register<wbr>For<wbr>Popup</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">register<wbr>For<wbr>Popup<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 <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L299">src/web/services/WindowService.ts:299</a></li> </ul> </aside> <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-class"> <a name="registerhostforwindow" class="tsd-anchor"></a> <h3>register<wbr>Host<wbr>For<wbr>Window</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">register<wbr>Host<wbr>For<wbr>Window<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><a href="../modules/_web_services_windowservice_.html#hostforelementfunc" class="tsd-signature-type">HostForElementFunc</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_core_types_.idisposable.html" class="tsd-signature-type">IDisposable</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/web/services/WindowService.ts#L147">src/web/services/WindowService.ts:147</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>f: <a href="../modules/_web_services_windowservice_.html#hostforelementfunc" class="tsd-signature-type">HostForElementFunc</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_core_types_.idisposable.html" class="tsd-signature-type">IDisposable</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="registernavigationhook" class="tsd-anchor"></a> <h3>register<wbr>Navigation<wbr>Hook</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">register<wbr>Navigation<wbr>Hook<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><a href="../modules/_services_navigationservice_.html#navigatecallback" class="tsd-signature-type">navigateCallback</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_core_types_.idisposable.html" class="tsd-signature-type">IDisposable</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#registernavigationhook">registerNavigationHook</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/NavigationService.ts#L184">src/services/NavigationService.ts:184</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>callback: <a href="../modules/_services_navigationservice_.html#navigatecallback" class="tsd-signature-type">navigateCallback</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_core_types_.idisposable.html" class="tsd-signature-type">IDisposable</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="remove" class="tsd-anchor"></a> <h3>remove</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</span>view<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_services_navigationservice_.navigationservice.html">NavigationService</a>.<a href="_services_navigationservice_.navigationservice.html#remove">remove</a></p> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/NavigationService.ts#L170">src/services/NavigationService.ts:170</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sends signal to remove window/popup/frame, it will not immediately remove, because it will identify whether it can remove or not by displaying cancellation warning. Only if there is no cancellation warning or user chooses to force close, it will not remove.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>view: <span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> </ul> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> force: <span class="tsd-signature-type">boolean</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>true if view was removed successfully</p> </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/_web_services_windowservice_.html">&quot;web/services/<wbr>Window<wbr>Service&quot;</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind