You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<spanclass="extends-implements">extends <ahref="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><<ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>></span></div>
90
90
<divclass="block">Enum where the input is sourced from.</div>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-162">DEFAULT</a></span></div>
167
+
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-166">DEFAULT</a></span></div>
168
168
<divclass="block">The input value is passed to the view during construction.</div>
169
169
</section>
170
170
</li>
171
171
<li>
172
172
<sectionclass="detail" id="CONTEXT">
173
173
<h3>CONTEXT</h3>
174
-
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-166">CONTEXT</a></span></div>
174
+
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-170">CONTEXT</a></span></div>
175
175
<divclass="block">The input value is retrieved from the react context.</div>
176
176
</section>
177
177
</li>
@@ -186,7 +186,7 @@ <h2>Method Details</h2>
186
186
<li>
187
187
<sectionclass="detail" id="values()">
188
188
<h3>values</h3>
189
-
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>[]</span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-157">values</a></span>()</div>
189
+
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>[]</span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-161">values</a></span>()</div>
190
190
<divclass="block">Returns an array containing the constants of this enum class, in
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-157">valueOf</a></span><wbr><spanclass="parameters">(<ahref="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> name)</span></div>
201
+
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-161">valueOf</a></span><wbr><spanclass="parameters">(<ahref="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> name)</span></div>
202
202
<divclass="block">Returns the enum constant of this class with the specified name.
203
203
The string must match <i>exactly</i> an identifier used to declare an
204
204
enum constant in this class. (Extraneous whitespace characters are
Copy file name to clipboardExpand all lines: api/react4j/annotations/Input.html
+8-4Lines changed: 8 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -279,12 +279,16 @@ <h3>observable</h3>
279
279
<li>
280
280
<sectionclass="detail" id="disposable()">
281
281
<h3>disposable</h3>
282
-
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-115">disposable</a></span></div>
282
+
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-119">disposable</a></span></div>
283
283
<divclass="block">Return an enum indicating whether the view should check whether the value of the input is disposed
284
284
prior to rendering. If the value is disposed then the render method will exit early and return null.
285
285
If this parameter is set to <ahref="Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the annotation processor will inspect the
286
286
type of the input and treat it as <ahref="Feature.html#ENABLE"><code>Feature.ENABLE</code></a> if the type is annotated with the <ahref="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 <ahref="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 <ahref="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 <ahref="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
+
<ahref="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>
288
292
<dlclass="notes">
289
293
<dt>Returns:</dt>
290
294
<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>
298
302
<li>
299
303
<sectionclass="detail" id="dependency()">
300
304
<h3>dependency</h3>
301
-
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-127">dependency</a></span></div>
305
+
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-131">dependency</a></span></div>
302
306
<divclass="block">Return an enum indicating whether the view should be disposed if the input is disposed. To enable this feature,
303
307
the input MUST set <ahref="#immutable()"><code>immutable()</code></a> to <code>true</code>, <ahref="#disposable()"><code>disposable()</code></a> MUST resolve to
304
308
<ahref="Feature.html#ENABLE"><code>Feature.ENABLE</code></a>. The type of the input is expected to implement the <ahref="https://arez.github.io/api/arez/component/DisposeNotifier.html" title="class or interface in arez.component" class="external-link"><code>DisposeNotifier</code></a>
0 commit comments