[Android] Switch を使った切り替えボタンの実装

Switch はよく設定などで使われるON/OFFのウィジェットの１つです

Android Studio
2021.2.1

Switch

　
Button、CompoundButton を継承しているのでタップをトリガーとして何らかの挙動をさせるという使い方になります

java.lang.Object
↳	android.view.View
	↳	android.widget.TextView
		↳	android.widget.Button
			↳	android.widget.CompoundButton
				↳	android.widget.Switch

似たようなウィジェットとしてSwitchCompatとSwithMaterialというのもあります
というのは、UseSwitchCompatOrMaterialXml のwarningが出てきます

Switch
- Platformに依存してスイッチの表示が異なりますが、古いKitKat以前でのことであり Android OSシェアは数%以下です
SwitchCompat
- MaterialDesignを継承
- androidx.appcompat.widget のSwith ウィジェット
SwitchMaterial
- SwitchCompatを継承
- Material Components Library のライブラリから

SwitchもSwitchCompatも基本的なところはあまり変わらないのでSwitchCompatを使ったほうがいいというGoogleの推奨なんでしょうか

SwitchMaterialはSwitchCompatを継承していますが、SwitchとSwitchCompatには継承関係はありません、ただ同じCompoundButtonを継承しています

目次
1. Swithc トグルウィジェット
2. サンプルコード
3. thumbとtrackのカスタマイズ

Swithc トグルウィジェット

　
PaletのButtonグループにSwitchがあるので画面に配置します

Codeを見るとWarningが出ているので
tools:ignore=”UseSwitchCompatOrMaterialXml”
これでSwitchCompatやMaterialのリントを無視する設定を追加します
これはコードでもwarningが出てきます

    <Switch
        android:id="@+id/switch1"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Switch"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintVertical_bias="0.3"
        tools:ignore="UseSwitchCompatOrMaterialXml" />

<Switch

android:id="@+id/switch1"

android:layout_width="wrap_content"

android:layout_height="wrap_content"

android:text="Switch"

app:layout_constraintBottom_toBottomOf="parent"

app:layout_constraintEnd_toEndOf="parent"

app:layout_constraintStart_toStartOf="parent"

app:layout_constraintTop_toTopOf="parent"

app:layout_constraintVertical_bias="0.3"

tools:ignore="UseSwitchCompatOrMaterialXml" />

android:text=”xxx” でテキストを設定できるのですが、レイアウトに気を付けないとSwitchを並べるとアンバランスになってしまいます

これはテキストとSwithを合わせた横サイズが異なってしまうからなので
例えば、

android:layout_width=”200dp”

で統一しておけばalignmentが上手くいきます

タップやフリップでSwithの変更を受け取るには
setOnCheckedChangeListener
onCheckedChanged
を使います

@SuppressLint("UseSwitchCompatOrMaterialCode")
Switch sw = findViewById(R.id.switch0);
sw.setOnCheckedChangeListener(new CompoundButton.OnCheckedChangeListener() {
    public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) {
        if (isChecked) {
            // The toggle is enabled
        } else {
            // The toggle is disabled
        }
    }
});

@SuppressLint("UseSwitchCompatOrMaterialCode")

Switch sw = findViewById(R.id.switch0);

sw.setOnCheckedChangeListener(new CompoundButton.OnCheckedChangeListener() {

public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) {

if (isChecked) {

// The toggle is enabled

} else {

// The toggle is disabled

}

});

ここでも、@SuppressLint(“UseSwitchCompatOrMaterialCode”)をいれるようにwarningが出ます

サンプルコード

よく設定にあるSwithボタンでAirPlaneモードに入ると
それにより他の通信がOFFになるような設定を考えてみます
(UseSwitchCompatOrMaterialCodeが山ほど出ています…)

MainActivity.java

//package com.example.testswitch;

import androidx.appcompat.app.AppCompatActivity;
import android.annotation.SuppressLint;
import android.os.Bundle;
import android.util.Log;
import android.widget.Switch;

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        @SuppressLint("UseSwitchCompatOrMaterialCode")
        Switch sw0 = findViewById(R.id.switch0);
        @SuppressLint("UseSwitchCompatOrMaterialCode")
        Switch sw1 = findViewById(R.id.switch1);
        @SuppressLint("UseSwitchCompatOrMaterialCode")
        Switch sw2 = findViewById(R.id.switch2);
        @SuppressLint("UseSwitchCompatOrMaterialCode")
        Switch sw3 = findViewById(R.id.switch3);
        sw1.setChecked(true);
        sw2.setChecked(true);
        sw3.setChecked(true);

        // lambda式にしたので、OnCheckedChangeListener()は見えなくなっています
        sw0.setOnCheckedChangeListener((buttonView, isChecked) -> {
            if (isChecked) {
                Log.d("debug","The Switch is enabled");
                sw1.setChecked(false);
                sw2.setChecked(false);
                sw3.setChecked(false);
            } else {
                Log.d("debug","The Switch is disabled");
            }
        });
    }
}

//package com.example.testswitch;

import androidx.appcompat.app.AppCompatActivity;

import android.annotation.SuppressLint;

import android.os.Bundle;

import android.util.Log;

import android.widget.Switch;

public class MainActivity extends AppCompatActivity {

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

@SuppressLint("UseSwitchCompatOrMaterialCode")

Switch sw0 = findViewById(R.id.switch0);

@SuppressLint("UseSwitchCompatOrMaterialCode")

Switch sw1 = findViewById(R.id.switch1);

@SuppressLint("UseSwitchCompatOrMaterialCode")

Switch sw2 = findViewById(R.id.switch2);

@SuppressLint("UseSwitchCompatOrMaterialCode")

Switch sw3 = findViewById(R.id.switch3);

sw1.setChecked(true);

sw2.setChecked(true);

sw3.setChecked(true);

// lambda式にしたので、OnCheckedChangeListener()は見えなくなっています

sw0.setOnCheckedChangeListener((buttonView, isChecked) -> {

if (isChecked) {

Log.d("debug","The Switch is enabled");

sw1.setChecked(false);

sw2.setChecked(false);

sw3.setChecked(false);

} else {

Log.d("debug","The Switch is disabled");

}

});

}

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <Switch
        android:id="@+id/switch0"
        android:layout_width="150dp"
        android:layout_height="wrap_content"
        android:text="@string/sw0"
        android:background="#ccffee"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintVertical_bias="0.15"
        tools:ignore="UseSwitchCompatOrMaterialXml" />

    <Switch
        android:id="@+id/switch1"
        android:layout_width="150dp"
        android:layout_height="wrap_content"
        android:text="@string/sw1"
        android:background="#ccffee"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintVertical_bias="0.2"
        tools:ignore="UseSwitchCompatOrMaterialXml" />

    <Switch
        android:id="@+id/switch2"
        android:layout_width="150dp"
        android:layout_height="wrap_content"
        android:text="@string/sw2"
        android:background="#ccffee"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintVertical_bias="0.25"
        tools:ignore="UseSwitchCompatOrMaterialXml" />

    <Switch
        android:id="@+id/switch3"
        android:layout_width="150dp"
        android:layout_height="wrap_content"
        android:text="@string/sw3"
        android:background="#ccffee"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintVertical_bias="0.3"
        tools:ignore="UseSwitchCompatOrMaterialXml" />

</androidx.constraintlayout.widget.ConstraintLayout>

<?xml version="1.0" encoding="utf-8"?>

<androidx.constraintlayout.widget.ConstraintLayout

xmlns:android="http://schemas.android.com/apk/res/android"

xmlns:app="http://schemas.android.com/apk/res-auto"

xmlns:tools="http://schemas.android.com/tools"

android:layout_width="match_parent"

android:layout_height="match_parent"

tools:context=".MainActivity">

<Switch

android:id="@+id/switch0"

android:layout_width="150dp"

android:layout_height="wrap_content"

android:text="@string/sw0"

android:background="#ccffee"

app:layout_constraintBottom_toBottomOf="parent"

app:layout_constraintEnd_toEndOf="parent"

app:layout_constraintStart_toStartOf="parent"

app:layout_constraintTop_toTopOf="parent"

app:layout_constraintVertical_bias="0.15"

tools:ignore="UseSwitchCompatOrMaterialXml" />

<Switch

android:id="@+id/switch1"

android:layout_width="150dp"

android:layout_height="wrap_content"

android:text="@string/sw1"

android:background="#ccffee"

app:layout_constraintBottom_toBottomOf="parent"

app:layout_constraintEnd_toEndOf="parent"

app:layout_constraintStart_toStartOf="parent"

app:layout_constraintTop_toTopOf="parent"

app:layout_constraintVertical_bias="0.2"

tools:ignore="UseSwitchCompatOrMaterialXml" />

<Switch

android:id="@+id/switch2"

android:layout_width="150dp"

android:layout_height="wrap_content"

android:text="@string/sw2"

android:background="#ccffee"

app:layout_constraintBottom_toBottomOf="parent"

app:layout_constraintEnd_toEndOf="parent"

app:layout_constraintStart_toStartOf="parent"

app:layout_constraintTop_toTopOf="parent"

app:layout_constraintVertical_bias="0.25"

tools:ignore="UseSwitchCompatOrMaterialXml" />

<Switch

android:id="@+id/switch3"

android:layout_width="150dp"

android:layout_height="wrap_content"

android:text="@string/sw3"

android:background="#ccffee"

app:layout_constraintBottom_toBottomOf="parent"

app:layout_constraintEnd_toEndOf="parent"

app:layout_constraintStart_toStartOf="parent"

app:layout_constraintTop_toTopOf="parent"

app:layout_constraintVertical_bias="0.3"

tools:ignore="UseSwitchCompatOrMaterialXml" />

</androidx.constraintlayout.widget.ConstraintLayout>

strings.xml

<resources>
    <string name="app_name">TestSwitch</string>
    <string name="sw0">AirPlane mode: </string>
    <string name="sw1">WiFi</string>
    <string name="sw2">Bluetooth</string>
    <string name="sw3">Phone</string>
</resources>

<string name="app_name">TestSwitch</string>

<string name="sw0">AirPlane mode: </string>

<string name="sw2">Bluetooth</string>

<string name="sw3">Phone</string>

</resources>

実行してみると

thumbとtrackのカスタマイズ

　
Switchでのthumbとtrackの色と形をカスタマイズするには
shape を使うことで可能です
ただ、これはボタンのようなON/OFFの状態遷移があるので
selectorを使ってstateに応じて色と形を変化させます

SwitchではMaterialに関係しない部分は
同様のことがSwitchCompatでもできます

custom_thumb_selector.xml
custom_track_selector.xml

のxmlファイルを作成してdrawable以下に配置します

このようなthumbとtrackでカスタマイズしてみます

shapeはrectagleで四角形
corners のradiusの分だけ角丸になります
soildでは色と縦横サイズを設定

デフォルト：android:state_enabled=”false”
チェック後：android:state_checked=”true”

状態としてはpressedなどありますが省略します

custom_thumb_selector.xml

<?xml version="1.0" encoding="utf-8"?>
<selector xmlns:android="http://schemas.android.com/apk/res/android">
    <item android:state_enabled="false">
        <shape
            android:shape="rectangle">
            <stroke
                android:width="2dp"
                android:color="#484"/>
            <solid
                android:color="#4e4"/>
            <size android:width="30dp" android:height="30dp" />
            <corners
                android:radius="5dp"/>
        </shape>
    </item>
    <item android:state_checked="true">
        <shape
            android:shape="rectangle">
            <stroke
                android:width="2dp"
                android:color="#484"/>
            <solid
                android:color="#fe4"/>
            <size android:width="30dp" android:height="30dp" />
            <corners
                android:radius="5dp"/>
        </shape>
    </item>
</selector>

<?xml version="1.0" encoding="utf-8"?>

<shape

android:shape="rectangle">

<stroke

android:width="2dp"

android:color="#484"/>

<solid

android:color="#4e4"/>

<corners

android:radius="5dp"/>

</shape>

</item>

<shape

android:shape="rectangle">

<stroke

android:width="2dp"

android:color="#484"/>

<solid

android:color="#fe4"/>

<corners

android:radius="5dp"/>

</shape>

</item>

</selector>

custom_track_selector.xml

<?xml version="1.0" encoding="utf-8"?>
<selector xmlns:android="http://schemas.android.com/apk/res/android">
    <item android:state_enabled="false">
        <shape
            android:shape="rectangle">
            <stroke
                android:width="2dp"
                android:color="#444"/>
            <solid
                android:color="#8b8"/>
            <corners
                android:radius="5dp"/>
        </shape>
    </item>

    <item android:state_checked="true">
        <shape
            android:shape="rectangle">
            <stroke
                android:width="2dp"
                android:color="#444"/>
            <solid
                android:color="#bdb"/>
            <corners
                android:radius="5dp"/>
        </shape>
    </item>
</selector>

<?xml version="1.0" encoding="utf-8"?>

<shape

android:shape="rectangle">

<stroke

android:width="2dp"

android:color="#444"/>

<solid

android:color="#8b8"/>

<corners

android:radius="5dp"/>

</shape>

</item>

<shape

android:shape="rectangle">

<stroke

android:width="2dp"

android:color="#444"/>

<solid

android:color="#bdb"/>

<corners

android:radius="5dp"/>

</shape>

</item>

</selector>

それぞれのselectorをレイアウトに設定します
android:thumb=”@drawable/custom_thumb_selector” android:track=”@drawable/custom_track_selector”

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout 
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <Switch
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:thumb="@drawable/custom_thumb_selector"
        android:track="@drawable/custom_track_selector"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintVertical_bias="0.45"
        tools:ignore="UseSwitchCompatOrMaterialXml" />

    <Switch
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:thumb="@drawable/custom_thumb_selector"
        android:track="@drawable/custom_track_selector"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintVertical_bias="0.55"
        tools:ignore="UseSwitchCompatOrMaterialXml" />

</androidx.constraintlayout.widget.ConstraintLayout>

<?xml version="1.0" encoding="utf-8"?>

<androidx.constraintlayout.widget.ConstraintLayout

xmlns:android="http://schemas.android.com/apk/res/android"

xmlns:app="http://schemas.android.com/apk/res-auto"

xmlns:tools="http://schemas.android.com/tools"

android:layout_width="match_parent"

android:layout_height="match_parent"

tools:context=".MainActivity">

<Switch

android:layout_width="wrap_content"

android:layout_height="wrap_content"

android:thumb="@drawable/custom_thumb_selector"

android:track="@drawable/custom_track_selector"

app:layout_constraintBottom_toBottomOf="parent"

app:layout_constraintEnd_toEndOf="parent"

app:layout_constraintStart_toStartOf="parent"

app:layout_constraintTop_toTopOf="parent"

app:layout_constraintVertical_bias="0.45"

tools:ignore="UseSwitchCompatOrMaterialXml" />

<Switch

android:layout_width="wrap_content"

android:layout_height="wrap_content"

android:thumb="@drawable/custom_thumb_selector"

android:track="@drawable/custom_track_selector"

app:layout_constraintBottom_toBottomOf="parent"

app:layout_constraintEnd_toEndOf="parent"

app:layout_constraintStart_toStartOf="parent"

app:layout_constraintTop_toTopOf="parent"

app:layout_constraintVertical_bias="0.55"

tools:ignore="UseSwitchCompatOrMaterialXml" />

</androidx.constraintlayout.widget.ConstraintLayout>

実行してみると

References:
切り替えボタン | Android デベロッパー
 Switch – Android Developers