com.phloxui

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>UISystemClock | 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/_service_uisystemclock_service_.html">"service/UISystemClock.service"</a> </li> <li> <a href="_service_uisystemclock_service_.uisystemclock.html">UISystemClock</a> </li> </ul> <h1>Class UISystemClock</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>ng</code> service handles the <code>UI</code> system clock logic. The <code>UI</code> system clock is mainly responsible for periodically update the system-wide clock to other components. Using clock provided by <code>this</code> service instead of using <code>setInterval()</code> or <code>setTimeout()</code> method may be more benefitial in many circumstances. For example, if you have many <code>UI</code> components needed to be periodically updated itself in background, without <code>this</code> service, you may need to use <code>setTimeout()</code> / <code>setInterval()</code> method for each component. This leads to having poor <code>application</code>'s performance. In spite of that, you can use the <code>system clock</code> provided by <code>this</code> service to let all <code>UI</code> components being updated at the same <code>clock tick</code> rate. Furthermore, <code>this</code> service also provides you a capability to configure its <code>interval</code>. So, you can haste up or slow down system-wide <code>UI</code> updating rate in a single place. </p> </div> <dl class="tsd-comment-tags"> <dt>author</dt> <dd><p>shiorin, tee4cute</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">UISystemClock</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="_service_uisystemclock_service_.uisystemclock.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private tsd-is-private-protected"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_uisystemclock_service_.uisystemclock.html#currentdatetime" class="tsd-kind-icon">current<wbr>Date<wbr>Time</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_uisystemclock_service_.uisystemclock.html#delaytimer" class="tsd-kind-icon">delay<wbr>Timer</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_uisystemclock_service_.uisystemclock.html#phloxappinfo" class="tsd-kind-icon">phlox<wbr>App<wbr>Info</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_uisystemclock_service_.uisystemclock.html#timerinterval" class="tsd-kind-icon">timer<wbr>Interval</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"><a href="_service_uisystemclock_service_.uisystemclock.html#getcurrentclockdatetime" class="tsd-kind-icon">get<wbr>Current<wbr>Clock<wbr>Date<wbr>Time</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_uisystemclock_service_.uisystemclock.html#getcurrentclocktime" class="tsd-kind-icon">get<wbr>Current<wbr>Clock<wbr>Time</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_service_uisystemclock_service_.uisystemclock.html#updatetimerinterval" class="tsd-kind-icon">update<wbr>Timer<wbr>Interval</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 UISystem<wbr>Clock<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_service_uisystemclock_service_.uisystemclock.html" class="tsd-signature-type">UISystemClock</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in service/UISystemClock.service.ts:29</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="_service_uisystemclock_service_.uisystemclock.html" class="tsd-signature-type">UISystemClock</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="currentdatetime" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> current<wbr>Date<wbr>Time</h3> <div class="tsd-signature tsd-kind-icon">current<wbr>Date<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div> <aside class="tsd-sources"> <ul> <li>Defined in service/UISystemClock.service.ts:24</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="delaytimer" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> delay<wbr>Timer</h3> <div class="tsd-signature tsd-kind-icon">delay<wbr>Timer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in service/UISystemClock.service.ts:29</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 service/UISystemClock.service.ts:25</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="timerinterval" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> timer<wbr>Interval</h3> <div class="tsd-signature tsd-kind-icon">timer<wbr>Interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in service/UISystemClock.service.ts:28</li> </ul> </aside> </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"> <a name="getcurrentclockdatetime" class="tsd-anchor"></a> <h3>get<wbr>Current<wbr>Clock<wbr>Date<wbr>Time</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Clock<wbr>Date<wbr>Time<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in service/UISystemClock.service.ts:69</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Get current <code>system clock</code> datetime. </p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4> <p>A <code>Date</code> object representing current system datetime.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getcurrentclocktime" class="tsd-anchor"></a> <h3>get<wbr>Current<wbr>Clock<wbr>Time</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Clock<wbr>Time<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 service/UISystemClock.service.ts:81</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Get current <code>system clock</code> time in milliseconds. </p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> <p>A number representing current system datetime in milliseconds.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="updatetimerinterval" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> update<wbr>Timer<wbr>Interval</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">update<wbr>Timer<wbr>Interval<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 service/UISystemClock.service.ts:51</li> </ul> </aside> <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/_service_uisystemclock_service_.html">"service/UISystem<wbr>Clock.service"</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="_service_uisystemclock_service_.uisystemclock.html" class="tsd-kind-icon">UISystem<wbr>Clock</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_service_uisystemclock_service_.uisystemclock.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_service_uisystemclock_service_.uisystemclock.html#currentdatetime" class="tsd-kind-icon">current<wbr>Date<wbr>Time</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_service_uisystemclock_service_.uisystemclock.html#delaytimer" class="tsd-kind-icon">delay<wbr>Timer</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_service_uisystemclock_service_.uisystemclock.html#phloxappinfo" class="tsd-kind-icon">phlox<wbr>App<wbr>Info</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_service_uisystemclock_service_.uisystemclock.html#timerinterval" class="tsd-kind-icon">timer<wbr>Interval</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_service_uisystemclock_service_.uisystemclock.html#getcurrentclockdatetime" class="tsd-kind-icon">get<wbr>Current<wbr>Clock<wbr>Date<wbr>Time</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_service_uisystemclock_service_.uisystemclock.html#getcurrentclocktime" class="tsd-kind-icon">get<wbr>Current<wbr>Clock<wbr>Time</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="_service_uisystemclock_service_.uisystemclock.html#updatetimerinterval" class="tsd-kind-icon">update<wbr>Timer<wbr>Interval</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>