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
<div class="block">Set the `react4j.enable_view_names` setting to <code>true</code>.</div>
984
984
</dd>
985
+
<dt><a href="react4j/annotations/View.html#exportBuilder()" class="member-name-link">exportBuilder()</a> - Element in annotation interface react4j.annotations.<a href="react4j/annotations/View.html" title="annotation interface in react4j.annotations">View</a></dt>
986
+
<dd>
987
+
<div class="block">Return true if the generated builder API should be public.</div>
<divclass="type-signature"><spanclass="annotations"><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a>
70
70
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>({<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>,<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#PARAMETER" title="class or interface in java.lang.annotation" class="external-link">PARAMETER</a>})
</span><spanclass="return-type"><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></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-58">name</a></span></div>
158
+
</span><spanclass="return-type"><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></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-56">name</a></span></div>
159
159
<divclass="block">Return the name of the input.
160
160
The name is the key used when accessing the input from the inputs object. It is also used when creating
161
161
the builder steps associated with inputs that are not sourced from tree context.</div>
</span><spanclass="return-type"><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></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-67">qualifier</a></span></div>
176
+
</span><spanclass="return-type"><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></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-65">qualifier</a></span></div>
177
177
<divclass="block">Return the qualifier used to access value from context.
178
178
It must only be specified if <ahref="#fromTreeContext()"><code>fromTreeContext()</code></a> is set to <code>true</code>.</div>
<divclass="block">Return <code>true</code> if the input value should be sourced from tree context rather than supplied when
194
194
creating the view. Inputs sourced from tree context are transparently passed from a parent view to
195
195
descendant views and do not need to be specified by the user when creating the view.</div>
@@ -206,7 +206,7 @@ <h3>fromTreeContext</h3>
206
206
<li>
207
207
<sectionclass="detail" id="require()">
208
208
<h3>require</h3>
209
-
<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-91">require</a></span></div>
209
+
<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-89">require</a></span></div>
210
210
<divclass="block">Setting indicating whether the input should be supplied when the view is constructed.
211
211
This influences validation when enabled and how the Builder class is created.
212
212
If set to <ahref="Feature.html#ENABLE"><code>Feature.ENABLE</code></a> then the user MUST supply the input and the builder will require the user
@@ -228,7 +228,7 @@ <h3>require</h3>
228
228
<li>
229
229
<sectionclass="detail" id="observable()">
230
230
<h3>observable</h3>
231
-
<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-104">observable</a></span></div>
231
+
<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-102">observable</a></span></div>
232
232
<divclass="block">Indicate whether the input should be annotated by <ahref="https://arez.github.io/api/arez/annotations/Observable.html" title="class or interface in arez.annotations" class="external-link"><code>Observable</code></a>.
233
233
234
234
<p>If set to <ahref="Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the input will be observable if and only if:</p>
<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="View.Type.html" title="enum class in react4j.annotations">View.Type</a>></span></div>
90
90
<divclass="block">Enum indicating type of view.</div>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-32">STATEFUL</a></span></div>
178
+
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-33">STATEFUL</a></span></div>
179
179
<divclass="block">The view can store state in fields, can declared lifecycle methods and may contain methods annotated by
180
180
the <ahref="ScheduleRender.html" title="annotation interface in react4j.annotations"><code>ScheduleRender</code></a> annotation.
181
181
The view will be scheduled to re-render if the views container re-renders and any input has changed
@@ -187,23 +187,23 @@ <h3>STATEFUL</h3>
187
187
<li>
188
188
<sectionclass="detail" id="TRACKING">
189
189
<h3>TRACKING</h3>
190
-
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-37">TRACKING</a></span></div>
190
+
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-38">TRACKING</a></span></div>
191
191
<divclass="block">The view is a <ahref="#STATEFUL"><code>STATEFUL</code></a> view <b>and</b> will re-render the view if any Arez
192
192
dependencies change. The framework uses the <ahref="https://arez.github.io/api/arez/annotations/Observe.html" title="class or interface in arez.annotations" class="external-link"><code>Observe</code></a> annotation to track Arez dependencies.</div>
193
193
</section>
194
194
</li>
195
195
<li>
196
196
<sectionclass="detail" id="MAYBE_TRACKING">
197
197
<h3>MAYBE_TRACKING</h3>
198
-
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-42">MAYBE_TRACKING</a></span></div>
198
+
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-43">MAYBE_TRACKING</a></span></div>
199
199
<divclass="block">The view is a <ahref="#TRACKING"><code>TRACKING</code></a> view but it will not generate an invariant failure if a
200
200
render results in zero Arez dependencies.</div>
201
201
</section>
202
202
</li>
203
203
<li>
204
204
<sectionclass="detail" id="NO_RENDER">
205
205
<h3>NO_RENDER</h3>
206
-
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-48">NO_RENDER</a></span></div>
206
+
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-49">NO_RENDER</a></span></div>
207
207
<divclass="block">The view must not have a method annotated with <ahref="Render.html" title="annotation interface in react4j.annotations"><code>Render</code></a>.
208
208
This is useful for "view" instances that provide capabilities or interact
209
209
with services and thus need not have a render method.</div>
@@ -220,7 +220,7 @@ <h2>Method Details</h2>
220
220
<li>
221
221
<sectionclass="detail" id="values()">
222
222
<h3>values</h3>
223
-
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a>[]</span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-22">values</a></span>()</div>
223
+
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a>[]</span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-23">values</a></span>()</div>
224
224
<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="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-22">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>
235
+
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/View.Type.html#line-23">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>
236
236
<divclass="block">Returns the enum constant of this class with the specified name.
237
237
The string must match <i>exactly</i> an identifier used to declare an
238
238
enum constant in this class. (Extraneous whitespace characters are
0 commit comments