Android
android.content.res
public final class

android.content.res.Configuration

java.lang.Object
android.content.res.Configuration Parcelable Comparable<T>

This class describes all device configuration information that can impact the resources the application retrieves. This includes both user-specified configuration options (locale and scaling) as well as dynamic device configuration (various types of input devices).

Summary

Constants

      Value  
Creator<Configuration CREATOR       
int  KEYBOARDHIDDEN_NO    0x00000001 
int  KEYBOARDHIDDEN_UNDEFINED    0x00000000 
int  KEYBOARDHIDDEN_YES    0x00000002 
int  KEYBOARD_12KEY    0x00000003 
int  KEYBOARD_NOKEYS    0x00000001 
int  KEYBOARD_QWERTY    0x00000002 
int  KEYBOARD_UNDEFINED    0x00000000 
int  NAVIGATION_DPAD    0x00000002 
int  NAVIGATION_NONAV    0x00000001 
int  NAVIGATION_TRACKBALL    0x00000003 
int  NAVIGATION_UNDEFINED    0x00000000 
int  NAVIGATION_WHEEL    0x00000004 
int  ORIENTATION_LANDSCAPE    0x00000002 
int  ORIENTATION_PORTRAIT    0x00000001 
int  ORIENTATION_SQUARE    0x00000003 
int  ORIENTATION_UNDEFINED    0x00000000 
int  TOUCHSCREEN_FINGER    0x00000003 
int  TOUCHSCREEN_NOTOUCH    0x00000001 
int  TOUCHSCREEN_STYLUS    0x00000002 
int  TOUCHSCREEN_UNDEFINED    0x00000000 
Constants inherited from interface android.os.Parcelable

Fields

public      float  fontScale  Current user preference for the scaling factor for fonts, relative to the base density scaling. 
public      int  keyboard  The kind of keyboard attached to the device. 
public      int  keyboardHidden  A flag indicating whether the keyboard has been hidden. 
public      Locale  locale  Current user preference for the locale. 
public      int  mcc  IMSI MCC (Mobile Country Code). 
public      int  mnc  IMSI MNC (Mobile Network Code). 
public      int  navigation  The kind of navigation method available on the device. 
public      int  orientation  Overall orientation of the screen. 
public      int  touchscreen  The kind of touch screen attached to the device. 

Public Constructors

            Configuration()
Construct an invalid Configuration. You must call setToDefaults() for this object to be valid.
            Configuration(Configuration o)
Makes a deep copy suitable for modification.

Public Methods

          int  compareTo(Configuration that)
          int  describeContents()
Parcelable methods
          int  diff(Configuration delta)
Return a bit mask of the differences between this Configuration object and the given one.
          boolean  equals(Object that)
Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
          boolean  equals(Configuration that)
          int  hashCode()
Returns an integer hash code for the receiver.
      static    boolean  needNewResources(int configChanges, int interestingChanges)
Determine if a new resource needs to be loaded from the bit set of configuration changes returned by updateFrom(Configuration).
          void  setToDefaults()
Set this object to the system defaults.
          String  toString()
Returns a string containing a concise, human-readable description of the receiver.
          int  updateFrom(Configuration delta)
Copy the fields from delta into this Configuration object, keeping track of which ones have changed.
          void  writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel.
Methods inherited from class java.lang.Object
Methods inherited from interface android.os.Parcelable
Methods inherited from interface java.lang.Comparable

Details

Constants

public static final Creator<Configuration> CREATOR

public static final int KEYBOARDHIDDEN_NO

Constant Value: 1 (0x00000001)

public static final int KEYBOARDHIDDEN_UNDEFINED

Constant Value: 0 (0x00000000)

public static final int KEYBOARDHIDDEN_YES

Constant Value: 2 (0x00000002)

public static final int KEYBOARD_12KEY

Constant Value: 3 (0x00000003)

public static final int KEYBOARD_NOKEYS

Constant Value: 1 (0x00000001)

public static final int KEYBOARD_QWERTY

Constant Value: 2 (0x00000002)

public static final int KEYBOARD_UNDEFINED

Constant Value: 0 (0x00000000)

public static final int NAVIGATION_DPAD

Constant Value: 2 (0x00000002)

public static final int NAVIGATION_NONAV

Constant Value: 1 (0x00000001)

public static final int NAVIGATION_TRACKBALL

Constant Value: 3 (0x00000003)

public static final int NAVIGATION_UNDEFINED

Constant Value: 0 (0x00000000)

public static final int NAVIGATION_WHEEL

Constant Value: 4 (0x00000004)

public static final int ORIENTATION_LANDSCAPE

Constant Value: 2 (0x00000002)

public static final int ORIENTATION_PORTRAIT

Constant Value: 1 (0x00000001)

public static final int ORIENTATION_SQUARE

Constant Value: 3 (0x00000003)

public static final int ORIENTATION_UNDEFINED

Constant Value: 0 (0x00000000)

public static final int TOUCHSCREEN_FINGER

Constant Value: 3 (0x00000003)

public static final int TOUCHSCREEN_NOTOUCH

Constant Value: 1 (0x00000001)

public static final int TOUCHSCREEN_STYLUS

Constant Value: 2 (0x00000002)

public static final int TOUCHSCREEN_UNDEFINED

Constant Value: 0 (0x00000000)

Fields

public float fontScale

Current user preference for the scaling factor for fonts, relative to the base density scaling.

public int keyboard

The kind of keyboard attached to the device. One of: KEYBOARD_QWERTY, KEYBOARD_12KEY.

public int keyboardHidden

A flag indicating whether the keyboard has been hidden. This will be set on a device with a mechanism to hide the keyboard from the user, when that mechanism is closed.

public Locale locale

Current user preference for the locale.

public int mcc

IMSI MCC (Mobile Country Code). 0 if undefined.

public int mnc

IMSI MNC (Mobile Network Code). 0 if undefined.

public int navigation

The kind of navigation method available on the device. One of: NAVIGATION_DPAD, NAVIGATION_TRACKBALL, NAVIGATION_WHEEL.

public int orientation

Overall orientation of the screen. May be one of ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, or ORIENTATION_SQUARE.

public int touchscreen

The kind of touch screen attached to the device. One of: TOUCHSCREEN_NOTOUCH, TOUCHSCREEN_STYLUS, TOUCHSCREEN_FINGER.

Public Constructors

public Configuration()

Construct an invalid Configuration. You must call setToDefaults() for this object to be valid.

public Configuration(Configuration o)

Makes a deep copy suitable for modification.

Public Methods

public int compareTo(Configuration that)

public int describeContents()

Parcelable methods

public int diff(Configuration delta)

Return a bit mask of the differences between this Configuration object and the given one. Does not change the values of either. Any undefined fields in delta are ignored.

public boolean equals(Object that)

Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison. The implementation in Object returns true only if the argument is the exact same object as the receiver (==).

Parameters

that Object the object to compare with this object.

Returns

  • boolean true if the object is the same as this object false if it is different from this object.

public boolean equals(Configuration that)

public int hashCode()

Returns an integer hash code for the receiver. Any two objects which answer true when passed to .equals must answer the same value for this method.

Returns

  • int the receiver's hash.

public static boolean needNewResources(int configChanges, int interestingChanges)

Determine if a new resource needs to be loaded from the bit set of configuration changes returned by updateFrom(Configuration).

Parameters

configChanges The mask of changes configurations as returned by updateFrom(Configuration).
interestingChanges The configuration changes that the resource can handled, as given in changingConfigurations.

Returns

  • Return true if the resource needs to be loaded, else false.

public void setToDefaults()

Set this object to the system defaults.

public String toString()

Returns a string containing a concise, human-readable description of the receiver.

Returns

  • String a printable representation for the receiver.

public int updateFrom(Configuration delta)

Copy the fields from delta into this Configuration object, keeping track of which ones have changed. Any undefined fields in delta are ignored and not copied in to the current Configuration.

Returns

public void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56