UNPKG

com.phloxui

Version:

PhloxUI Ng2+ Framework

826 lines 62.1 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>PhloxDialog | 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_phloxdialog_component_.html">&quot;component/PhloxDialog.component&quot;</a> </li> <li> <a href="_component_phloxdialog_component_.phloxdialog.html">PhloxDialog</a> </li> </ul> <h1>Class PhloxDialog</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;"> A <code>singleton</code> UI component controlling <code>application</code> pop-up dialog logic. This dialog is a <code>modal</code> dialog, saying that, when it is displayed, all user&#39;s UI actions will be blocked and the user will be forced to focus on this dialog. When the user completes the interaction with this dialog, for example, clicking on &quot;OK&quot; button, this dialog will be hidden and the user can resume normal UI operations. Normally, you <b>should NOT</b> directly access this component instance but you could control it via <b><a href="_service_dialogservice_service_.dialogservice.html">DialogService</a></b>. </p> <p style="text-indent: 2em;"> Please note that there is a dialog <code>display queue</code> operating behind the scenes. This <code>display queue</code> is a <code>FIFO</code> queue keeping all dialog models (<a href="_component_model_dialogmodel_.dialogmodel.html">DialogModel</a>) --which are automatically generated and kept in the queue when <code><i>show...Dialog</i></code> methods are called-- but those dialog models cannot be displayed suddenly. For example, if there already is a dialog being displayed currently, but, there is also someone else calling <code><i>show...Dialog</i></code> method simultaneously, the dialog model generated from the later <code><i>show...Dialog</i></code> method will not be showed suddenly. Nevertheless, it&#39;ll be showed immediately when the first dialog is closed. For this mechanism, the dialog model can be firstly kept in the queue, then, it will be showed and removed from the queue when its preceding dialog is closed. </p> <p style="text-indent: 2em;"> If you want to implement your own <b>custom dialog</b>, you should do it using <code>component dialog</code> rather than building it all up from scratches. The only thing which you need to do is just implementing the component being displayed inside the dialog body. All other mechanisms, such as dialog <code>display queue</code> listed above, should be left to be handled by the framework or by this class. For more information about building custom dialog, please see <a href="_component_phloxdialog_component_.phloxdialog.html#showcomponentdialog">showComponentDialog</a>. </p> </div> <dl class="tsd-comment-tags"> <dt>author</dt> <dd><p>shiorin, tee4cute</p> </dd> <dt>see</dt> <dd><p><a href="_service_dialogservice_service_.dialogservice.html">DialogService</a></p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">PhloxDialog</span> </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"><a href="_component_phloxdialog_component_.phloxdialog.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-private"><a href="_component_phloxdialog_component_.phloxdialog.html#_show" class="tsd-kind-icon">_show</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#componentdialog" class="tsd-kind-icon">component<wbr>Dialog</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#confirmdialog" class="tsd-kind-icon">confirm<wbr>Dialog</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#currentmodel" class="tsd-kind-icon">current<wbr>Model</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#currentresolver" class="tsd-kind-icon">current<wbr>Resolver</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#dialogclass" class="tsd-kind-icon">dialog<wbr>Class</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#dialogqueue" class="tsd-kind-icon">dialog<wbr>Queue</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#dialogresolverqueue" class="tsd-kind-icon">dialog<wbr>Resolver<wbr>Queue</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#messagedialog" class="tsd-kind-icon">message<wbr>Dialog</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#needfocusservice" class="tsd-kind-icon">need<wbr>Focus<wbr>Service</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#phloxappinfo" class="tsd-kind-icon">phlox<wbr>App<wbr>Info</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_component_phloxdialog_component_.phloxdialog.html#component_dialog" class="tsd-kind-icon">COMPONENT_<wbr>DIALOG</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_component_phloxdialog_component_.phloxdialog.html#confirm_dialog" class="tsd-kind-icon">CONFIRM_<wbr>DIALOG</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_component_phloxdialog_component_.phloxdialog.html#message_dialog" class="tsd-kind-icon">MESSAGE_<wbr>DIALOG</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_component_phloxdialog_component_.phloxdialog.html#type_name" class="tsd-kind-icon">TYPE_<wbr>NAME</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private tsd-is-private-protected"> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#show" class="tsd-kind-icon">show</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-private"><a href="_component_phloxdialog_component_.phloxdialog.html#_showdialog" class="tsd-kind-icon">_show<wbr>Dialog</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_phloxdialog_component_.phloxdialog.html#getcurrentmodel" class="tsd-kind-icon">get<wbr>Current<wbr>Model</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_phloxdialog_component_.phloxdialog.html#getdialogclass" class="tsd-kind-icon">get<wbr>Dialog<wbr>Class</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_phloxdialog_component_.phloxdialog.html#getdialogheight" class="tsd-kind-icon">get<wbr>Dialog<wbr>Height</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#getdialogresult" class="tsd-kind-icon">get<wbr>Dialog<wbr>Result</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_phloxdialog_component_.phloxdialog.html#getdialogwidth" class="tsd-kind-icon">get<wbr>Dialog<wbr>Width</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#geti18nmessage" class="tsd-kind-icon">get<wbr>I18NMessage</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#getresolverwrapper" class="tsd-kind-icon">get<wbr>Resolver<wbr>Wrapper</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_phloxdialog_component_.phloxdialog.html#hidedialog" class="tsd-kind-icon">hide<wbr>Dialog</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_phloxdialog_component_.phloxdialog.html#isshow" class="tsd-kind-icon">is<wbr>Show</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_phloxdialog_component_.phloxdialog.html#showcomponentdialog" class="tsd-kind-icon">show<wbr>Component<wbr>Dialog</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_phloxdialog_component_.phloxdialog.html#showconfirmdialog" class="tsd-kind-icon">show<wbr>Confirm<wbr>Dialog</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_phloxdialog_component_.phloxdialog.html#showdialog" class="tsd-kind-icon">show<wbr>Dialog</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_component_phloxdialog_component_.phloxdialog.html#showmessagedialog" class="tsd-kind-icon">show<wbr>Message<wbr>Dialog</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_component_phloxdialog_component_.phloxdialog.html#shownextdialog" class="tsd-kind-icon">show<wbr>Next<wbr>Dialog</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"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Phlox<wbr>Dialog<span class="tsd-signature-symbol">(</span>phloxAppService<span class="tsd-signature-symbol">: </span><a href="_service_phloxappinfoservice_service_.phloxappinfoservice.html" class="tsd-signature-type">PhloxAppInfoService</a>, needFocusService<span class="tsd-signature-symbol">: </span><a href="_service_needfocusservice_service_.needfocusservice.html" class="tsd-signature-type">NeedFocusService</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_component_phloxdialog_component_.phloxdialog.html" class="tsd-signature-type">PhloxDialog</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:82</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>phloxAppService: <a href="_service_phloxappinfoservice_service_.phloxappinfoservice.html" class="tsd-signature-type">PhloxAppInfoService</a></h5> </li> <li> <h5>needFocusService: <a href="_service_needfocusservice_service_.needfocusservice.html" class="tsd-signature-type">NeedFocusService</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_component_phloxdialog_component_.phloxdialog.html" class="tsd-signature-type">PhloxDialog</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-private"> <a name="_show" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _show</h3> <div class="tsd-signature tsd-kind-icon">_show<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:65</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="componentdialog" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> component<wbr>Dialog</h3> <div class="tsd-signature tsd-kind-icon">component<wbr>Dialog<span class="tsd-signature-symbol">:</span> <a href="_component_dialog_internal_componentdialog_component_.componentdialog.html" class="tsd-signature-type">ComponentDialog</a></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:60</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="confirmdialog" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> confirm<wbr>Dialog</h3> <div class="tsd-signature tsd-kind-icon">confirm<wbr>Dialog<span class="tsd-signature-symbol">:</span> <a href="_component_dialog_internal_confirmdialog_component_.confirmdialog.html" class="tsd-signature-type">ConfirmDialog</a></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:56</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="currentmodel" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> current<wbr>Model</h3> <div class="tsd-signature tsd-kind-icon">current<wbr>Model<span class="tsd-signature-symbol">:</span> <a href="_component_model_dialogmodel_.dialogmodel.html" class="tsd-signature-type">DialogModel</a></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:61</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="currentresolver" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> current<wbr>Resolver</h3> <div class="tsd-signature tsd-kind-icon">current<wbr>Resolver<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:62</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="dialogclass" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> dialog<wbr>Class</h3> <div class="tsd-signature tsd-kind-icon">dialog<wbr>Class<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:53</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="dialogqueue" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> dialog<wbr>Queue</h3> <div class="tsd-signature tsd-kind-icon">dialog<wbr>Queue<span class="tsd-signature-symbol">:</span> <a href="_component_model_dialogmodel_.dialogmodel.html" class="tsd-signature-type">DialogModel</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:52</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="dialogresolverqueue" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> dialog<wbr>Resolver<wbr>Queue</h3> <div class="tsd-signature tsd-kind-icon">dialog<wbr>Resolver<wbr>Queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:54</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="messagedialog" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> message<wbr>Dialog</h3> <div class="tsd-signature tsd-kind-icon">message<wbr>Dialog<span class="tsd-signature-symbol">:</span> <a href="_component_dialog_internal_messagedialog_component_.messagedialog.html" class="tsd-signature-type">MessageDialog</a></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:58</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="needfocusservice" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> need<wbr>Focus<wbr>Service</h3> <div class="tsd-signature tsd-kind-icon">need<wbr>Focus<wbr>Service<span class="tsd-signature-symbol">:</span> <a href="_service_needfocusservice_service_.needfocusservice.html" class="tsd-signature-type">NeedFocusService</a></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:64</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="phloxappinfo" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> phlox<wbr>App<wbr>Info</h3> <div class="tsd-signature tsd-kind-icon">phlox<wbr>App<wbr>Info<span class="tsd-signature-symbol">:</span> <a href="_component_model_phloxappinfo_.phloxappinfo.html" class="tsd-signature-type">PhloxAppInfo</a></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:63</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="component_dialog" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> COMPONENT_<wbr>DIALOG</h3> <div class="tsd-signature tsd-kind-icon">COMPONENT_<wbr>DIALOG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;COMPONENT_DIALOG</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:50</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="confirm_dialog" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> CONFIRM_<wbr>DIALOG</h3> <div class="tsd-signature tsd-kind-icon">CONFIRM_<wbr>DIALOG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;CONFIRM_DIALOG</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:48</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="message_dialog" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> MESSAGE_<wbr>DIALOG</h3> <div class="tsd-signature tsd-kind-icon">MESSAGE_<wbr>DIALOG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;MESSAGE_DIALOG</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:49</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="type_name" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> TYPE_<wbr>NAME</h3> <div class="tsd-signature tsd-kind-icon">TYPE_<wbr>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;TYPE_NAME</span></div> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:46</li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"> <a name="show" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> show</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> show<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> show<span class="tsd-signature-symbol">(</span>show<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:80</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:67</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>show: <span class="tsd-signature-type">boolean</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-private"> <a name="_showdialog" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _show<wbr>Dialog</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">_show<wbr>Dialog<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/PhloxDialog.component.ts:188</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="getcurrentmodel" class="tsd-anchor"></a> <h3>get<wbr>Current<wbr>Model</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Model<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_component_model_dialogmodel_.dialogmodel.html" class="tsd-signature-type">DialogModel</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:381</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="_component_model_dialogmodel_.dialogmodel.html" class="tsd-signature-type">DialogModel</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getdialogclass" class="tsd-anchor"></a> <h3>get<wbr>Dialog<wbr>Class</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Dialog<wbr>Class<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><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/PhloxDialog.component.ts:385</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getdialogheight" class="tsd-anchor"></a> <h3>get<wbr>Dialog<wbr>Height</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Dialog<wbr>Height<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> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:156</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="getdialogresult" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Dialog<wbr>Result</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">get<wbr>Dialog<wbr>Result<span class="tsd-signature-symbol">(</span>dialogType<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">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:166</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>dialogType: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getdialogwidth" class="tsd-anchor"></a> <h3>get<wbr>Dialog<wbr>Width</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Dialog<wbr>Width<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> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:146</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="geti18nmessage" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>I18NMessage</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">get<wbr>I18NMessage<span class="tsd-signature-symbol">(</span>key<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">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:127</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="getresolverwrapper" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Resolver<wbr>Wrapper</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">get<wbr>Resolver<wbr>Wrapper<span class="tsd-signature-symbol">(</span>model<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, resolve<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, reject<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">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:136</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>model: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>resolve: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>reject: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="hidedialog" class="tsd-anchor"></a> <h3>hide<wbr>Dialog</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">hide<wbr>Dialog<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/PhloxDialog.component.ts:227</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Hide the current showing dialog and show the next dialog in the queue (if any). </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-class"> <a name="isshow" class="tsd-anchor"></a> <h3>is<wbr>Show</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">is<wbr>Show<span class="tsd-signature-symbol">(</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/PhloxDialog.component.ts:377</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="showcomponentdialog" class="tsd-anchor"></a> <h3>show<wbr>Component<wbr>Dialog</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">show<wbr>Component<wbr>Dialog<span class="tsd-signature-symbol">(</span>componentDialogModel<span class="tsd-signature-symbol">: </span><a href="_component_model_componentdialogmodel_.componentdialogmodel.html" class="tsd-signature-type">ComponentDialogModel</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">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/PhloxDialog.component.ts:346</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Display a component dialog on the screen. A component dialog is a dialog allowing you to display your own custom dialog by specifying a <code>component type</code> being displayed as its body. That <code>component type</code> must be a class which is an instance of <a href="../interfaces/_component_idialogcontroller_.idialogcontroller.html">IDialogController</a>. </p> </div> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="_component_dialog_internal_componentdialog_component_.componentdialog.html">ComponentDialog</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>componentDialogModel: <a href="_component_model_componentdialogmodel_.componentdialogmodel.html" class="tsd-signature-type">ComponentDialogModel</a></h5> <div class="tsd-comment tsd-typography"> <p>A dialog model being displayed.</p> </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">any</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>The <code>promise</code> which will be resolved when this dialog is closed. The resolving result will be the value returned from <a href="../interfaces/_component_idialogcontroller_.idialogcontroller.html#getdialogresult">IDialogController.getDialogResult</a> method.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="showconfirmdialog" class="tsd-anchor"></a> <h3>show<wbr>Confirm<wbr>Dialog</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">show<wbr>Confirm<wbr>Dialog<span class="tsd-signature-symbol">(</span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, showCancelBtn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, height<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"> <ul> <li>Defined in component/PhloxDialog.component.ts:273</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Display a confirmation dialog on the screen. </p> </div> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="_component_dialog_internal_confirmdialog_component_.confirmdialog.html">ConfirmDialog</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>title: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The dialog title text.</p> </div> </li> <li> <h5>message: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The dialog message which will be displayed in the dialog body.</p> </div> </li> <li> <h5>showCancelBtn: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>To display the <code>CANCEL</code> button or not. By default, the confirmation dialog will contain only <code>YES</code> and <code>NO</code> button.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> width: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The css <code>&quot;width&quot;</code> style value governing dialog width e.g. <code>100px</code>, <code>50pt</code>.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> height: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The css <code>&quot;height&quot;</code> style value governing dialog height e.g. <code>100px</code>, <code>50pt</code>.</p> </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">any</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>The <code>promise</code> which will be resolved when this dialog is closed. The resolving result will be the value returned from <a href="_component_dialog_internal_confirmdialog_component_.confirmdialog.html#getdialogresult">ConfirmDialog.getDialogResult</a> method.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="showdialog" class="tsd-anchor"></a> <h3>show<wbr>Dialog</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">show<wbr>Dialog<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/PhloxDialog.component.ts:198</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Show current dialog described by the <code><b><a href="_component_phloxdialog_component_.phloxdialog.html#currentmodel">currentModel</a></b></code>. This usually be the last model generated by the last <code><i>show...Dialog</i></code> method call. </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-class"> <a name="showmessagedialog" class="tsd-anchor"></a> <h3>show<wbr>Message<wbr>Dialog</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">show<wbr>Message<wbr>Dialog<span class="tsd-signature-symbol">(</span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, height<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"> <ul> <li>Defined in component/PhloxDialog.component.ts:309</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Display a message dialog on the screen. </p> </div> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="_component_dialog_internal_messagedialog_component_.messagedialog.html">MessageDialog</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>title: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The dialog title text.</p> </div> </li> <li> <h5>message: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The dialog message which will be displayed in the dialog body.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> width: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The css <code>&quot;width&quot;</code> style value governing dialog width e.g. <code>100px</code>, <code>50pt</code>.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> height: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The css <code>&quot;height&quot;</code> style value governing dialog height e.g. <code>100px</code>, <code>50pt</code>.</p> </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">any</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>The <code>promise</code> which will be resolved when this dialog is closed. The resolving result will be the value returned from <a href="_component_dialog_internal_messagedialog_component_.messagedialog.html#getdialogresult">MessageDialog.getDialogResult</a> method (which always returns <code>true</code>).</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="shownextdialog" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> show<wbr>Next<wbr>Dialog</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">show<wbr>Next<wbr>Dialog<span class="tsd-signature-symbol">(</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/PhloxDialog.component.ts:103</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</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_phloxdialog_component_.html">"component/<wbr>Phlox<wbr>Dialog.component"</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-external-module"> <a href="_component_phloxdialog_component_.phloxdialog.html" class="tsd-kind-icon">Phlox<wbr>Dialog</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_component_phloxdialog_component_.phloxdialog.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_component_phloxdialog_component_.phloxdialog.html#_show" class="tsd-kind-icon">_show</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_comp