Android ToggleButton Control

Advertisements


A ToggleButton displays checked/unchecked states as a button. It is basically an on/off button with a light indicator.

ToggleButton Attributes

Following are the important attributes related to ToggleButton control. You can check Android official documentation for complete list of attributes and related methods which you can use to change these attributes are run time.

AttributeDescription
android:disabledAlphaThis is the alpha to apply to the indicator when disabled.
android:textOffThis is the text for the button when it is not checked.
android:textOnThis is the text for the button when it is checked.

Inherited from android.widget.TextView Class:

AttributeDescription
android:autoTextIf set, specifies that this TextView has a textual input method and automatically corrects some common spelling errors.
android:drawableBottomThis is the drawable to be drawn below the text.
android:drawableRightThis is the drawable to be drawn to the right of the text.
android:editableIf set, specifies that this TextView has an input method.
android:textThis is the Text to display.

Inherited from android.view.View Class:

AttributeDescription
android:backgroundThis is a drawable to use as the background.
android:contentDescriptionThis defines text that briefly describes content of the view.
android:idThis supplies an identifier name for this view,
android:onClickThis is the name of the method in this View's context to invoke when the view is clicked.
android:visibilityThis controls the initial visibility of the view.

Example

This example will take you through simple steps to show how to create your own Android application using Linear Layout and ToggleButton.

StepDescription
1You will use Eclipse IDE to create an Android application and name it as GUIDemo7 under a package com.example.guidemo7 as explained in the Hello World Example chapter.
2Modify src/MainActivity.java file to add a click event.
2Modify the default content of res/layout/activity_main.xml file to include Android UI control.
3Define required constants in res/values/strings.xml file
4Run the application to launch Android emulator and verify the result of the changes done in the application.

Following is the content of the modified main activity file src/com.example.guidemo7/MainActivity.java. This file can include each of the fundamental lifecycle methods.

package com.example.guidemo7;

import android.os.Bundle;
import android.app.Activity;
import android.view.Menu;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.Button;
import android.widget.Toast;
import android.widget.ToggleButton;

public class MainActivity extends Activity {

   private ToggleButton toggleBtn1, toggleBtn2;
   private Button btResult;

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

   private void addListenerOnToggleButton() {

     toggleBtn1 = (ToggleButton) findViewById
     (R.id.toggleButton1);
     toggleBtn2 = (ToggleButton) findViewById
     (R.id.toggleButton2);
     btResult = (Button) findViewById(R.id.button1);
     btResult.setOnClickListener(new OnClickListener() {

       @Override
       public void onClick(View v) {
         StringBuffer result = new StringBuffer();
         result.append("START Condition - ").append
         (toggleBtn1.getText());
         result.append("\nSTOP Condition - ").append
         (toggleBtn2.getText());
         Toast.makeText(MainActivity.this, result.toString(),
         Toast.LENGTH_SHORT).show();
       }
    });
   }

   @Override
   public boolean onCreateOptionsMenu(Menu menu) {
     /* Inflate the menu; this adds items to the action bar
        if it is present */
     getMenuInflater().inflate(R.menu.main, menu);
     return true;
   } 
}

Following will be the content of res/layout/activity_main.xml file:

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    tools:context=".MainActivity" >

    <TextView
        android:id="@+id/textView1"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="@string/example_togglebutton" />

    <ToggleButton
        android:id="@+id/toggleButton1"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_alignLeft="@+id/textView1"
        android:layout_below="@+id/textView1"
        android:layout_marginTop="24dp" />

    <Button
        android:id="@+id/button1"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_below="@+id/toggleButton1"
        android:layout_marginLeft="19dp"
        android:layout_marginTop="30dp"
        android:layout_toRightOf="@+id/toggleButton1"
        android:text="@string/example_result" />

    <ToggleButton
        android:id="@+id/toggleButton2"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_alignTop="@+id/toggleButton1"
        android:layout_toRightOf="@+id/textView1"
        android:textOff="@string/stop_togglebutton"
        android:textOn="@string/start_togglebutton" 
        android:checked="true"/>

</RelativeLayout>

Following will be the content of res/values/strings.xml to define these new constants:

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

    <string name="app_name">GUIDemo7</string>
    <string name="action_settings">Settings</string>
    <string name="example_togglebutton">Example showing    
    ToggleButton</string>
    <string name="start_togglebutton">START</string>
    <string name="stop_togglebutton">STOP</string>
    <string name="example_result">Click Me</string>

</resources>

Following is the default content of AndroidManifest.xml:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.guidemo7"
    android:versionCode="1"
    android:versionName="1.0" >

    <uses-sdk
        android:minSdkVersion="8"
        android:targetSdkVersion="17" />

    <application
        android:allowBackup="true"
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name"
        android:theme="@style/AppTheme" >
        <activity
            android:name="com.example.guidemo7.MainActivity"
            android:label="@string/app_name" >
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

Let's try to run your GUIDemo7 application. I assume you had created your AVD while doing environment setup. To run the app from Eclipse, open one of your project's activity files and click Run Eclipse Run Icon icon from the toolbar. Eclipse installs the app on your AVD and starts it and if everything is fine with your setup and application, it will display following Emulator window:

The following screen will appear:

Android ToggleButton Control

The following screen will appear, conditions are shown when state of both the toggle buttons are changed:

Android ToggleButton Control

The following screen will appear, conditions are shown when state of 2nd toggle button is changed to START:

Android ToggleButton Control

Exercise:

I will recommend to try above example with different attributes of ToggleButton in Layout XML file as well at programming time to have different look and feel of the ToggleButton. Try to make it editable, change to font color, font family, width, textSize etc and see the result. You can also try above example with multiple ToggleButton controls in one activity.



Advertisements
Advertisements