blob: 8874ddda3d4aaa001b66397c7df95f628010ec76 [file] [log] [blame]
Owen Gray3cf32b62021-04-19 14:33:36 -04001<html devsite="true">
2 <head>
3 <title>ViewDebug</title>
4{% setvar book_path %}/reference/kotlin/dokkatest/_book.yaml{% endsetvar %}
5{% include "_shared/_reference-head-tags.html" %}
6 </head>
7 <body>
Tiem Song6f896de2022-11-03 14:55:52 -07008 <div id="metadata-info-block"></div>
Owen Gray3cf32b62021-04-19 14:33:36 -04009 <h1>ViewDebug</h1>
Owen Gray3cf32b62021-04-19 14:33:36 -040010 <p>
Owen Gray22f20572022-08-08 13:48:02 -040011 <pre>class <a href="/reference/kotlin/dokkatest/platform/ViewDebug.html">ViewDebug</a></pre>
Owen Gray3cf32b62021-04-19 14:33:36 -040012 </p>
13 <hr>
14 <p>Various debugging/tracing tools related to View and the view hierarchy.</p>
15 <h2>Summary</h2>
16 <div class="devsite-table-wrapper">
17 <table class="responsive">
18 <thead>
19 <tr>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -040020 <th colspan="100%"><h3>Nested types</h3></th>
Owen Gray3cf32b62021-04-19 14:33:36 -040021 </tr>
22 </thead>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -040023 <tbody class="list">
Owen Gray3cf32b62021-04-19 14:33:36 -040024 <tr>
Owen Gray22f20572022-08-08 13:48:02 -040025 <td width="40%"><code>@<a href="https://developer.android.com/reference/java/lang/annotation/Target.html">Target</a>(value&nbsp;=&nbsp;[ElementType.FIELD,&nbsp;ElementType.METHOD])<br>@<a href="https://developer.android.com/reference/java/lang/annotation/Retention.html">Retention</a>(value&nbsp;=&nbsp;RetentionPolicy.RUNTIME)<br>annotation <a href="/reference/kotlin/dokkatest/platform/ViewDebug.CapturedViewProperty.html">ViewDebug.CapturedViewProperty</a></code></td>
Andrea Falconed77cf9d2021-04-26 17:34:56 -040026 <td>
Owen Grayf0f85832021-06-24 15:46:02 -040027 <p>This annotation can be used to mark fields and methods to be dumped when the view is captured.</p>
Owen Gray3cf32b62021-04-19 14:33:36 -040028 </td>
29 </tr>
30 <tr>
Owen Gray22f20572022-08-08 13:48:02 -040031 <td width="40%"><code>@<a href="https://developer.android.com/reference/java/lang/annotation/Target.html">Target</a>(value&nbsp;=&nbsp;[ElementType.FIELD,&nbsp;ElementType.METHOD])<br>@<a href="https://developer.android.com/reference/java/lang/annotation/Retention.html">Retention</a>(value&nbsp;=&nbsp;RetentionPolicy.RUNTIME)<br>annotation <a href="/reference/kotlin/dokkatest/platform/ViewDebug.ExportedProperty.html">ViewDebug.ExportedProperty</a></code></td>
Andrea Falconed77cf9d2021-04-26 17:34:56 -040032 <td>
Owen Grayf0f85832021-06-24 15:46:02 -040033 <p>This annotation can be used to mark fields and methods to be dumped by the view server.</p>
Owen Gray3cf32b62021-04-19 14:33:36 -040034 </td>
35 </tr>
36 <tr>
Owen Gray22f20572022-08-08 13:48:02 -040037 <td width="40%"><code>@<a href="https://developer.android.com/reference/java/lang/annotation/Target.html">Target</a>(value&nbsp;=&nbsp;[ElementType.TYPE])<br>@<a href="https://developer.android.com/reference/java/lang/annotation/Retention.html">Retention</a>(value&nbsp;=&nbsp;RetentionPolicy.RUNTIME)<br>annotation <a href="/reference/kotlin/dokkatest/platform/ViewDebug.FlagToString.html">ViewDebug.FlagToString</a></code></td>
Andrea Falconed77cf9d2021-04-26 17:34:56 -040038 <td>
Owen Gray3cf32b62021-04-19 14:33:36 -040039 <p>Defines a mapping from a flag to a String.</p>
40 </td>
41 </tr>
42 <tr>
Owen Gray22f20572022-08-08 13:48:02 -040043 <td width="40%"><code>enum <a href="/reference/kotlin/dokkatest/platform/ViewDebug.HierarchyTraceType.html">ViewDebug.HierarchyTraceType</a></code></td>
Andrea Falconed77cf9d2021-04-26 17:34:56 -040044 <td>
Owen Gray5ac68352022-09-06 09:10:58 -040045 <p><strong>This enum is deprecated.</strong>
Owen Gray3cf32b62021-04-19 14:33:36 -040046 <p>This enum is now unused</p>
47 </p>
48 </td>
49 </tr>
50 <tr>
Owen Gray22f20572022-08-08 13:48:02 -040051 <td width="40%"><code>@<a href="https://developer.android.com/reference/java/lang/annotation/Target.html">Target</a>(value&nbsp;=&nbsp;[ElementType.TYPE])<br>@<a href="https://developer.android.com/reference/java/lang/annotation/Retention.html">Retention</a>(value&nbsp;=&nbsp;RetentionPolicy.RUNTIME)<br>annotation <a href="/reference/kotlin/dokkatest/platform/ViewDebug.IntToString.html">ViewDebug.IntToString</a></code></td>
Andrea Falconed77cf9d2021-04-26 17:34:56 -040052 <td>
Owen Gray3cf32b62021-04-19 14:33:36 -040053 <p>Defines a mapping from an int value to a String.</p>
54 </td>
55 </tr>
56 <tr>
Owen Gray22f20572022-08-08 13:48:02 -040057 <td width="40%"><code>enum <a href="/reference/kotlin/dokkatest/platform/ViewDebug.RecyclerTraceType.html">ViewDebug.RecyclerTraceType</a></code></td>
Andrea Falconed77cf9d2021-04-26 17:34:56 -040058 <td>
Owen Gray5ac68352022-09-06 09:10:58 -040059 <p><strong>This enum is deprecated.</strong>
Owen Gray3cf32b62021-04-19 14:33:36 -040060 <p>This enum is now unused</p>
61 </p>
62 </td>
63 </tr>
64 </tbody>
65 </table>
66 </div>
67 <div class="devsite-table-wrapper">
68 <table class="responsive">
69 <thead>
70 <tr>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -040071 <th colspan="100%"><h3>Constants</h3></th>
Owen Gray3cf32b62021-04-19 14:33:36 -040072 </tr>
73 </thead>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -040074 <tbody class="list">
Owen Gray3cf32b62021-04-19 14:33:36 -040075 <tr>
Owen Gray3dc26bf2021-10-13 14:00:45 -040076 <td width="40%"><code>const <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
Andrea Falconed77cf9d2021-04-26 17:34:56 -040077 <td>
Owen Grayb861f6d2022-08-23 11:17:57 -040078 <div><code><a href="/reference/kotlin/dokkatest/platform/ViewDebug.html#TRACE_HIERARCHY()">TRACE_HIERARCHY</a> = false</code></div>
Owen Gray5ac68352022-09-06 09:10:58 -040079 <p><strong>This property is deprecated.</strong>
Owen Gray3cf32b62021-04-19 14:33:36 -040080 <p>This flag is now unused</p>
81 </p>
82 </td>
83 </tr>
84 <tr>
Owen Gray3dc26bf2021-10-13 14:00:45 -040085 <td width="40%"><code>const <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
Andrea Falconed77cf9d2021-04-26 17:34:56 -040086 <td>
Owen Grayb861f6d2022-08-23 11:17:57 -040087 <div><code><a href="/reference/kotlin/dokkatest/platform/ViewDebug.html#TRACE_RECYCLER()">TRACE_RECYCLER</a> = false</code></div>
Owen Gray5ac68352022-09-06 09:10:58 -040088 <p><strong>This property is deprecated.</strong>
Owen Gray3cf32b62021-04-19 14:33:36 -040089 <p>This flag is now unused</p>
90 </p>
91 </td>
92 </tr>
93 </tbody>
94 </table>
95 </div>
Owen Gray8b623eb2021-11-30 13:29:25 -050096 <div class="devsite-table-wrapper">
97 <table class="responsive">
98 <thead>
99 <tr>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -0400100 <th colspan="100%"><h3>Public constructors</h3></th>
Owen Gray8b623eb2021-11-30 13:29:25 -0500101 </tr>
102 </thead>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -0400103 <tbody class="list">
Owen Gray8b623eb2021-11-30 13:29:25 -0500104 <tr>
105 <td>
106 <div><code><a href="/reference/kotlin/dokkatest/platform/ViewDebug.html#ViewDebug()">ViewDebug</a>()</code></div>
107 </td>
108 </tr>
109 </tbody>
110 </table>
111 </div>
Owen Gray3cf32b62021-04-19 14:33:36 -0400112 <h2>Constants</h2>
Owen Gray3cf32b62021-04-19 14:33:36 -0400113 <div><a name="getTRACE_HIERARCHY()"></a><a name="setTRACE_HIERARCHY()"></a><a name="getTRACE_HIERARCHY--"></a><a name="setTRACE_HIERARCHY--"></a>
114 <h3 class="api-name" id="TRACE_HIERARCHY()">TRACE_HIERARCHY</h3>
Owen Grayb861f6d2022-08-23 11:17:57 -0400115 <pre class="api-signature no-pretty-print">const&nbsp;val&nbsp;<a href="/reference/kotlin/dokkatest/platform/ViewDebug.html#TRACE_HIERARCHY()">TRACE_HIERARCHY</a> = false:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
Owen Gray3cf32b62021-04-19 14:33:36 -0400116 <aside class="caution"><strong>This property is deprecated.</strong><br>
117 <p>This flag is now unused</p>
118 </aside>
119 </div>
120 <div><a name="getTRACE_RECYCLER()"></a><a name="setTRACE_RECYCLER()"></a><a name="getTRACE_RECYCLER--"></a><a name="setTRACE_RECYCLER--"></a>
121 <h3 class="api-name" id="TRACE_RECYCLER()">TRACE_RECYCLER</h3>
Owen Grayb861f6d2022-08-23 11:17:57 -0400122 <pre class="api-signature no-pretty-print">const&nbsp;val&nbsp;<a href="/reference/kotlin/dokkatest/platform/ViewDebug.html#TRACE_RECYCLER()">TRACE_RECYCLER</a> = false:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
Owen Gray3cf32b62021-04-19 14:33:36 -0400123 <aside class="caution"><strong>This property is deprecated.</strong><br>
124 <p>This flag is now unused</p>
125 </aside>
126 </div>
Owen Gray8b623eb2021-11-30 13:29:25 -0500127 <h2>Public constructors</h2>
128 <div><a name="ViewDebug--"></a><a name="viewdebug"></a>
129 <h3 class="api-name" id="ViewDebug()">ViewDebug</h3>
130 <pre class="api-signature no-pretty-print"><a href="/reference/kotlin/dokkatest/platform/ViewDebug.html#ViewDebug()">ViewDebug</a>()</pre>
131 </div>
Owen Gray3cf32b62021-04-19 14:33:36 -0400132 </body>
133</html>