KotlinでAndroidのナビゲーションバーの高さと幅をプログラムから取得する方法

この記事では、Kotlinを使用してAndroidのナビゲーションバー(システムバー)の高さと幅をプログラムから動的に取得する方法を、ステップごとにわかりやすく解説します。ナビゲーションバーのサイズは端末によって異なるため、UIレイアウトを調整する際にこの情報を取得できると非常に便利です。

実装のポイント

ナビゲーションバーのサイズを取得するには、Resources.getIdentifier()メソッドを使って「navigation_bar_height」や「navigation_bar_width」といったシステム内部リソースのIDを取得し、さらにgetDimensionPixelSize()で実際のピクセル値に変換します。

実装手順

ステップ1: 新しいプロジェクトを作成する

Android Studioを開き、「File」→「New Project」を選択して新しいプロジェクトを作成します。必要な設定項目をすべて入力し、Empty Activityテンプレートを選択しておきましょう。

ステップ2: レイアウトファイル(activity_main.xml)を編集する

res/layout/activity_main.xmlに以下のコードを追加します。画面中央に結果を表示するためのTextViewを配置しています。

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="https://schemas.android.com/apk/res/android"
    xmlns:tools="https://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/text"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerHorizontal="true"
        android:layout_marginTop="70dp"
        android:background="#008080"
        android:padding="5dp"
        android:text="TutorialsPoint"
        android:textColor="#fff"
        android:textSize="24sp"
        android:textStyle="bold" />

    <TextView
        android:id="@+id/textView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerInParent="true"
        android:textColor="@android:color/holo_purple"
        android:textSize="20sp"
        android:textStyle="bold" />

</RelativeLayout>

ステップ3: MainActivity.ktを実装する

src/MainActivity.ktに以下のコードを記述します。ここでは、高さだけでなく幅も同時に取得し、ピクセル値として画面に表示しています。

import android.content.res.Resources
import android.os.Bundle
import android.widget.TextView
import androidx.appcompat.app.AppCompatActivity

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        title = "KotlinApp"

        val textView: TextView = findViewById(R.id.textView)
        val resources: Resources = applicationContext.resources

        // ナビゲーションバーの高さを取得
        val heightResId = resources.getIdentifier(
            "navigation_bar_height", "dimen", "android"
        )
        val navBarHeight = if (heightResId > 0) {
            resources.getDimensionPixelSize(heightResId)
        } else 0

        // ナビゲーションバーの幅を取得(横向き表示時に使用される値)
        val widthResId = resources.getIdentifier(
            "navigation_bar_width", "dimen", "android"
        )
        val navBarWidth = if (widthResId > 0) {
            resources.getDimensionPixelSize(widthResId)
        } else 0

        textView.text = "高さ: ${navBarHeight}px\n幅: ${navBarWidth}px"
    }
}

コードの解説:

• getIdentifier("navigation_bar_height", "dimen", "android"): システムフレームワーク内のディメンションリソースIDを文字列名から取得します。リソースが存在しない場合は0が返されます。
• getDimensionPixelSize(): 取得したリソースIDを現在の画面密度に基づいたピクセル値(px)に変換します。これにより、dp値ではなく実際の描画サイズが分かります。
• 幅は縦向きでは通常0ですが、横向きでナビゲーションバーが画面横に配置される端末では有効な値が返されます。

ステップ4: AndroidManifest.xmlを確認する

androidManifest.xmlには特別な権限は不要です。以下のようにアクティビティが正しく宣言されていれば問題ありません。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android"
    package="com.example.q11">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">

        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>

    </application>
</manifest>

アプリを実行して結果を確認する

それではアプリを実行してみましょう。実機のAndroidスマートフォンをPCに接続していることを前提とします。Android Studioでプロジェクトのアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックしてください。デバイス選択ダイアログで接続したモバイル端末を選択すると、実機の画面にアプリが起動し、ナビゲーションバーの高さと幅がピクセル単位で表示されます。

ジェスチャーナビゲーションを使用している端末では、ナビゲーションバーの高さが従来の3ボタンナビゲーションより小さくなるなど、端末やOSの設定によって値が変化することにも注目してみてください。