Android - programmatically change the state of a switch without triggering OnCheckChanged listener

Question

I'm looking for a method of programmatically changing the state of an Android Switch widget using switch.setChecked(true); without triggering OnCheckedChangedlistener.

My first thought was to swap it out for an OnClickListener but as this only registers clicks and you are able to not only click but also slide a Switch then it's not really fit for purpose as if the user was to slide the Switch from off to on then the Switch would actually do nothing as the user is not clicking...

If anyone's got a solution or a smart work around for this, that would be awesome

Answer 1

Set the listener to null before calling setCheck() function, and enable it after that, such as the following:

switch.setOnCheckedChangeListener (null);
switch.setChecked(true);
switch.setOnCheckedChangeListener (this);

Reference: Change Checkbox value without triggering onCheckChanged

Answer 2

Every CompoundButton (two states button - on/off) has a pressed state which is true only when a user is pressing the view.

Just add a check in your listener before starting the actual logic:

if(compoundButton.isPressed()) {
    // continue with your listener
}

That way, changing the checked value programmatically won't trigger the unwanted code.

From @krisDrOid answer.

Answer 3

Well, just before doing things in code with the switch you could just unregister the Listener, then do whatever you need to, and again register the listener.

Answer 4

I have one solution and its working fine at my end. I have added setOnTouchListener and setOnCheckedChangeListener on my switch control, and added following code to solve my problem.

    // set tag by default.
    mMySwitch.setTag("TAG");

    // Add OnCheckedChangeListener.
    mMySwitch.setOnCheckedChangeListener(new CompoundButton.OnCheckedChangeListener() {
         @Override
         public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) {
            if (mMySwitch.getTag() != null) {
                 mMySwitch.setTag(null);
                 return;
                }

          // Do your stuff here.
        }
    });

    // Add Touch listener.
    mMySwitch.setOnTouchListener(new View.OnTouchListener() {
         @Override
         public boolean onTouch(View v, MotionEvent event) {
            mMySwitch.setTag(null);
            return false;
         }
    });

In this way setOnCheckedChangeListener is getting called only when check changed happens by human intervention by drag, by click, by touch.

Also don't forgot to add your valid string tag ( not null ) when your trying to change check status of switch control. like :

 mMySwitch.setTag("TAG");
 mMySwitch.setChecked(true);

Answer 5

Write a custom Switch or SwitchCompat and override the setOnCheckedListener.

public class SwitchCompat extends android.support.v7.widget.SwitchCompat {
private boolean mIgnoreCheckedChange = false;

public SwitchCompat(Context context) {
    super(context);
}

public SwitchCompat(Context context, AttributeSet attrs) {
    super(context, attrs);
}

public SwitchCompat(Context context, AttributeSet attrs, int defStyleAttr) {
    super(context, attrs, defStyleAttr);
}


@Override
public void setOnCheckedChangeListener(final OnCheckedChangeListener listener) {
    super.setOnCheckedChangeListener(new OnCheckedChangeListener() {
        @Override
        public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) {
            if (mIgnoreCheckedChange) {
                return;
            }
            listener.onCheckedChanged(buttonView, isChecked);
        }
    });
}

public void setChecked(boolean checked, boolean notify) {
    mIgnoreCheckedChange = !notify;
    setChecked(checked);
    mIgnoreCheckedChange = false;
}

}

Answer 6

the best solution I can find is;

const val SWITCH_COMPAT_IGNORE_TAG = "SWITCH_COMPAT_IGNORE_TAG"

fun SwitchCompat.isCheckedWithIgnoreTag(isChecked: Boolean) {
    tag = SWITCH_COMPAT_IGNORE_TAG
    this.isChecked = isChecked
    tag = null
}

switchCompat.isCheckedWithIgnoreTag(true)

switchCompat.setOnCheckedChangeListener { buttonView, isChecked ->
    if (buttonView.tag != SWITCH_COMPAT_IGNORE_TAG) {
        //TODO
    }
}

Answer 7

Based on the answers from @ronginat and @hyb1996 I made SensibleSwitch so that you can just drop it in your XML layouts, use the listener as you would expect to and not worry about it.

 import android.content.Context
 import android.util.AttributeSet
 import androidx.appcompat.widget.SwitchCompat

 class SensibleSwitch : SwitchCompat {
     constructor(context: Context) : super(context)
     constructor(context: Context, attrs: AttributeSet?) : super(context, attrs)
     constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : super(context, attrs, defStyleAttr)

     override fun setOnCheckedChangeListener(listener: OnCheckedChangeListener?) {
         super.setOnCheckedChangeListener { compoundButton, isChecked ->
             if (isPressed) {
                 listener?.onCheckedChanged(compoundButton, isChecked)
             }
         }
     }
 }

Answer 8

switch.setOnCheckedChangeListener
{
    compoundButton, check
    if (switch.isPressed || switch.isSelected)
        if (check) {
            TODO("")
        } else { 
            TODO("")
        }
}

Answer 9

Elaborating on Mahmoud's answer

CompoundButton.OnCheckedChangeListener switchListener;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
    switchListener = new CompoundButton.OnCheckedChangeListener() {
            @Override
            public void onCheckedChanged(CompoundButton compoundButton, boolean b) {
                //Implement on check change
            }
        }; 
      switch.setOnCheckedChangeListener (switchListener);

      //When you want to trigger the checked of switch do the following
      switch.setOnCheckedChangeListener (null);
      switch.setChecked(true);
      switch.setOnCheckedChangeListener (switchListener);
     }

`

Answer 10

use this switch.setChecked(true); // first set value (from pref or server or anywhere) and than switch.setOnCheckedChangeListener (this); add listener.

Answer 11

If nothing worked here is a tricky solution.

Create a textview on top of the switch and add clickListener to textview.

 <TextView
        android:elevation="1dp"
        android:id="@+id/switchLabel"
        android:layout_width="0dp"
        android:layout_height="0dp"
        android:text=""
        app:layout_constraintBottom_toBottomOf="@id/switch1"
        app:layout_constraintStart_toStartOf="@+id/switch1"
        app:layout_constraintTop_toTopOf="@id/switch1"
        app:layout_constraintEnd_toEndOf="@id/switch1" />

Add elavation to textview.

Answer 12

For the default switch writed <Switch/> on xml, do this in kotlin to set it programmatically :

mySwitch.isChecked = true

Then, if you want to do some action when user click on it:

 mySwitch.setOnCheckedChangeListener { compoundButton, isChecked ->
            when (isChecked) {
                true -> { /* do something here*/ }
                false -> { /* do something here*/ }
            }
        }