Android
android.widget
public abstract class

android.widget.CompoundButton

java.lang.Object
android.view.View Drawable.Callback KeyEvent.Callback
android.widget.TextView ViewTreeObserver.OnPreDrawListener
android.widget.Button
android.widget.CompoundButton Checkable

A button with two states, checked and unchecked. When the button is pressed or clicked, the state changes automatically.

XML attributes

See CompoundButton Attributes, Button Attributes, TextView Attributes, View Attributes

Nested Classes
CompoundButton.OnCheckedChangeListener Interface definition for a callback to be invoked when the checked state of a compound button changed. 
Known Direct Subclasses

Summary

XML Attributes inherited from class android.widget.TextView
XML Attributes inherited from class android.view.View
Constants inherited from class android.view.View
Fields inherited from class android.view.View

Public Constructors

            CompoundButton(Context context)
            CompoundButton(Context context, AttributeSet attrs)
            CompoundButton(Context context, AttributeSet attrs, int defStyle)

Public Methods

          boolean  isChecked()
          void  onRestoreInstanceState(Parcelable state)
Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().
          Parcelable  onSaveInstanceState()
Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.
          boolean  performClick()
Call this view's OnClickListener, if it is defined.
          void  setButtonDrawable(int resid)
Set the background to a given Drawable, identified by its resource id.
          void  setButtonDrawable(Drawable d)
Set the background to a given Drawable
          void  setChecked(boolean checked)

Changes the checked state of this button.

          void  setOnCheckedChangeListener(CompoundButton.OnCheckedChangeListener listener)
Register a callback to be invoked when the checked state of this button changes.
          void  toggle()
Change the checked state of the view to the inverse of its current state

Protected Methods

          void  drawableStateChanged()
This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.
          int[]  onCreateDrawableState(int extraSpace)
Generate the new Drawable state for this view.
          void  onDraw(Canvas canvas)
Implement this to do your drawing.
Methods inherited from class android.widget.TextView
Methods inherited from class android.view.View
Methods inherited from class java.lang.Object
Methods inherited from interface android.graphics.drawable.Drawable.Callback
Methods inherited from interface android.view.KeyEvent.Callback
Methods inherited from interface android.view.ViewTreeObserver.OnPreDrawListener
Methods inherited from interface android.widget.Checkable

Details

Public Constructors

public CompoundButton(Context context)

public CompoundButton(Context context, AttributeSet attrs)

public CompoundButton(Context context, AttributeSet attrs, int defStyle)

Public Methods

public boolean isChecked()

public void onRestoreInstanceState(Parcelable state)

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). This function will never be called with a null state.

Parameters

state The frozen state that had previously been returned by onSaveInstanceState().

public Parcelable onSaveInstanceState()

Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can not be reconstructed later. For example, you will never store your current position on screen because that will be computed again when a new instance of the view is placed in its view hierarchy.

Some examples of things you may store here: the current cursor position in a text view (but usually not the text itself since that is stored in a content provider or other persistent storage), the currently selected item in a list view.

public boolean performClick()

Call this view's OnClickListener, if it is defined.

Returns

  • True there was an assigned OnClickListener that was called, false otherwise is returned.

public void setButtonDrawable(int resid)

Set the background to a given Drawable, identified by its resource id.

Parameters

resid the resource id of the drawable to use as the background

public void setButtonDrawable(Drawable d)

Set the background to a given Drawable

Parameters

d The Drawable to use as the background

public void setChecked(boolean checked)

Changes the checked state of this button.

Parameters

checked true to check the button, false to uncheck it

public void setOnCheckedChangeListener(CompoundButton.OnCheckedChangeListener listener)

Register a callback to be invoked when the checked state of this button changes.

Parameters

listener the callback to call on checked state change

public void toggle()

Change the checked state of the view to the inverse of its current state

Protected Methods

protected void drawableStateChanged()

This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.

Be sure to call through to the superclass when overriding this function.

protected int[] onCreateDrawableState(int extraSpace)

Generate the new Drawable state for this view. This is called by the view system when the cached Drawable state is determined to be invalid. To retrieve the current state, you should use getDrawableState().

Parameters

extraSpace if non-zero, this is the number of extra entries you would like in the returned array in which you can place your own states.

Returns

  • Returns an array holding the current Drawable state of the view.

protected void onDraw(Canvas canvas)

Implement this to do your drawing.

Parameters

canvas the canvas on which the background will be drawn
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56