Skip to content

Commit ed41f5c

Browse files
committed
Publish website
1 parent a64bfd3 commit ed41f5c

5 files changed

Lines changed: 129 additions & 117 deletions

File tree

api/react4j/annotations/Input.Source.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h1 title="Enum Class Input.Source" class="title">Enum Class Input.Source</h1>
8585
<dd><a href="Input.html" title="annotation interface in react4j.annotations">Input</a></dd>
8686
</dl>
8787
<hr>
88-
<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-157">Input.Source</a></span>
88+
<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-161">Input.Source</a></span>
8989
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>&gt;</span></div>
9090
<div class="block">Enum where the input is sourced from.</div>
9191
</section>
@@ -164,14 +164,14 @@ <h2>Enum Constant Details</h2>
164164
<li>
165165
<section class="detail" id="DEFAULT">
166166
<h3>DEFAULT</h3>
167-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-162">DEFAULT</a></span></div>
167+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-166">DEFAULT</a></span></div>
168168
<div class="block">The input value is passed to the view during construction.</div>
169169
</section>
170170
</li>
171171
<li>
172172
<section class="detail" id="CONTEXT">
173173
<h3>CONTEXT</h3>
174-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-166">CONTEXT</a></span></div>
174+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-170">CONTEXT</a></span></div>
175175
<div class="block">The input value is retrieved from the react context.</div>
176176
</section>
177177
</li>
@@ -186,7 +186,7 @@ <h2>Method Details</h2>
186186
<li>
187187
<section class="detail" id="values()">
188188
<h3>values</h3>
189-
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>[]</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-157">values</a></span>()</div>
189+
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>[]</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-161">values</a></span>()</div>
190190
<div class="block">Returns an array containing the constants of this enum class, in
191191
the order they are declared.</div>
192192
<dl class="notes">
@@ -198,7 +198,7 @@ <h3>values</h3>
198198
<li>
199199
<section class="detail" id="valueOf(java.lang.String)">
200200
<h3>valueOf</h3>
201-
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-157">valueOf</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
201+
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-161">valueOf</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
202202
<div class="block">Returns the enum constant of this class with the specified name.
203203
The string must match <i>exactly</i> an identifier used to declare an
204204
enum constant in this class. (Extraneous whitespace characters are

api/react4j/annotations/Input.html

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -279,12 +279,16 @@ <h3>observable</h3>
279279
<li>
280280
<section class="detail" id="disposable()">
281281
<h3>disposable</h3>
282-
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-115">disposable</a></span></div>
282+
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-119">disposable</a></span></div>
283283
<div class="block">Return an enum indicating whether the view should check whether the value of the input is disposed
284284
prior to rendering. If the value is disposed then the render method will exit early and return null.
285285
If this parameter is set to <a href="Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the annotation processor will inspect the
286286
type of the input and treat it as <a href="Feature.html#ENABLE"><code>Feature.ENABLE</code></a> if the type is annotated with the <a href="https://arez.github.io/api/arez/annotations/ArezComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ArezComponent</code></a>
287-
annotation or the <a href="https://arez.github.io/api/arez/annotations/ActAsComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ActAsComponent</code></a> annotation.</div>
287+
annotation or the <a href="https://arez.github.io/api/arez/annotations/ActAsComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ActAsComponent</code></a> annotation.
288+
289+
<p>For tracked renders, disposable inputs whose declared type is annotated with <a href="https://arez.github.io/api/arez/annotations/ArezComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ArezComponent</code></a> or
290+
<a href="https://arez.github.io/api/arez/annotations/ActAsComponent.html" title="class or interface in arez.annotations" class="external-link"><code>ActAsComponent</code></a> will also be observed during render so that disposing the input can invalidate the
291+
render and trigger a rerender.</p></div>
288292
<dl class="notes">
289293
<dt>Returns:</dt>
290294
<dd>an enum indicating whether the view should check whether the value of the input is disposed prior to rendering.</dd>
@@ -298,7 +302,7 @@ <h3>disposable</h3>
298302
<li>
299303
<section class="detail" id="dependency()">
300304
<h3>dependency</h3>
301-
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-127">dependency</a></span></div>
305+
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-131">dependency</a></span></div>
302306
<div class="block">Return an enum indicating whether the view should be disposed if the input is disposed. To enable this feature,
303307
the input MUST set <a href="#immutable()"><code>immutable()</code></a> to <code>true</code>, <a href="#disposable()"><code>disposable()</code></a> MUST resolve to
304308
<a href="Feature.html#ENABLE"><code>Feature.ENABLE</code></a>. The type of the input is expected to implement the <a href="https://arez.github.io/api/arez/component/DisposeNotifier.html" title="class or interface in arez.component" class="external-link"><code>DisposeNotifier</code></a>
@@ -318,7 +322,7 @@ <h3>dependency</h3>
318322
<li>
319323
<section class="detail" id="immutable()">
320324
<h3>immutable</h3>
321-
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-152">immutable</a></span></div>
325+
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-156">immutable</a></span></div>
322326
<div class="block">True if the input is not expected to change after initial value is set. If the value of the input does change
323327
then it is expected that the view will be unmounted and a new view created. This is implemented
324328
by synthesizing a key for the view every time the view that is derived from this input. To enable this

0 commit comments

Comments
 (0)