blob: 5a2374565af36f693d8ba5df884a725f9402f25c [file]
<html devsite="true">
<head>
<title>Dimension</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div itemscope="" itemtype="http://developers.google.com/ReferenceObject">
<meta itemprop="name" content="Dimension">
<meta itemprop="path" content="androidx.annotation">
<meta itemprop="property" content="getUnit()">
<meta itemprop="property" content="DP()">
<meta itemprop="property" content="PX()">
<meta itemprop="property" content="SP()">
<meta itemprop="property" content="DP()">
<meta itemprop="property" content="PX()">
<meta itemprop="property" content="SP()">
<meta itemprop="language" content="JAVA">
</div>
<div id="header-block">
<div>
<h1>Dimension</h1>
</div>
<div id="metadata-info-block">
<div id="source-link"><a href="https://cs.android.com/search?q=file:androidx/annotation/Dimension.kt+class:androidx.annotation.Dimension&amp;ss=androidx/platform/frameworks/support" class="external">View Source</a></div>
</div>
</div>
<div id="refdoc-switcher-placeholder"></div>
<p>
<pre>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-must-be-documented/index.html">MustBeDocumented</a><br>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-retention/index.html">Retention</a>(value&nbsp;=&nbsp;AnnotationRetention.BINARY)<br>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html">Target</a>(allowedTargets&nbsp;=&nbsp;[AnnotationTarget.FUNCTION,&nbsp;AnnotationTarget.PROPERTY_GETTER,&nbsp;AnnotationTarget.PROPERTY_SETTER,&nbsp;AnnotationTarget.VALUE_PARAMETER,&nbsp;AnnotationTarget.FIELD,&nbsp;AnnotationTarget.LOCAL_VARIABLE,&nbsp;AnnotationTarget.ANNOTATION_CLASS])<br>public annotation <a href="/reference/androidx/annotation/Dimension.html">Dimension</a></pre>
</p>
<hr>
<p>Denotes that an integer parameter, field or method return value is expected to represent a dimension.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Constants</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>static&nbsp;final int</code></td>
<td>
<div><code><a href="/reference/androidx/annotation/Dimension.html#DP()">DP</a> = 0</code></div>
</td>
</tr>
<tr>
<td><code>static&nbsp;final int</code></td>
<td>
<div><code><a href="/reference/androidx/annotation/Dimension.html#PX()">PX</a> = 1</code></div>
</td>
</tr>
<tr>
<td><code>static&nbsp;final int</code></td>
<td>
<div><code><a href="/reference/androidx/annotation/Dimension.html#SP()">SP</a> = 2</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Public constructors</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td>
<div><code><a href="/reference/androidx/annotation/Dimension.html#Dimension(kotlin.Int)">Dimension</a>(int&nbsp;unit)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>final int</code></td>
<td>
<div><code><a href="/reference/androidx/annotation/Dimension.html#getUnit()">getUnit</a>()</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
<h2>Constants</h2>
<div class="api-item"><a name="getDP()"></a><a name="setDP()"></a><a name="getDP--"></a><a name="setDP--"></a>
<div class="api-name-block">
<div>
<h3 id="DP()">DP</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;int&nbsp;<a href="/reference/androidx/annotation/Dimension.html#DP()">DP</a> = 0</pre>
</div>
<div class="api-item"><a name="getPX()"></a><a name="setPX()"></a><a name="getPX--"></a><a name="setPX--"></a>
<div class="api-name-block">
<div>
<h3 id="PX()">PX</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;int&nbsp;<a href="/reference/androidx/annotation/Dimension.html#PX()">PX</a> = 1</pre>
</div>
<div class="api-item"><a name="getSP()"></a><a name="setSP()"></a><a name="getSP--"></a><a name="setSP--"></a>
<div class="api-name-block">
<div>
<h3 id="SP()">SP</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;int&nbsp;<a href="/reference/androidx/annotation/Dimension.html#SP()">SP</a> = 2</pre>
</div>
</div>
<div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="Dimension-kotlin.Int-"></a><a name="dimension"></a>
<div class="api-name-block">
<div>
<h3 id="Dimension(kotlin.Int)">Dimension</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;<a href="/reference/androidx/annotation/Dimension.html#Dimension(kotlin.Int)">Dimension</a>(int&nbsp;unit)</pre>
</div>
</div>
<div class="list">
<h2>Public methods</h2>
<div class="api-item"><a name="getUnit--"></a><a name="getunit"></a>
<div class="api-name-block">
<div>
<h3 id="getUnit()">getUnit</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;int&nbsp;<a href="/reference/androidx/annotation/Dimension.html#getUnit()">getUnit</a>()</pre>
</div>
</div>
</body>
</html>