Configuration

Kotlin |Java

class Configuration : Comparable<Configuration!>, Parcelable

kotlin.Any
↳	android.content.res.Configuration

This class describes all device configuration information that can impact the resources the application retrieves. This includes both user-specified configuration options (locale list and scaling) as well as device configurations (such as input modes, screen size and screen orientation).

You can acquire this object from Resources, using Resources.getConfiguration. Thus, from an activity, you can get it by chaining the request with android.app.Activity#getResources:

Configuration config = getResources().getConfiguration();

Summary

Constants
static Int	`COLOR_MODE_HDR_MASK` Constant for `colorMode`: bits that encode the dynamic range of the screen.
static Int	`COLOR_MODE_HDR_NO` Constant for `colorMode`: a `COLOR_MODE_HDR_MASK` value indicating that the screen is not HDR (low/standard dynamic range).
static Int	`COLOR_MODE_HDR_SHIFT` Constant for `colorMode`: bits shift to get the screen dynamic range.
static Int	`COLOR_MODE_HDR_UNDEFINED` Constant for `colorMode`: a `COLOR_MODE_HDR_MASK` value indicating that it is unknown whether or not the screen is HDR.
static Int	`COLOR_MODE_HDR_YES` Constant for `colorMode`: a `COLOR_MODE_HDR_MASK` value indicating that the screen is HDR (dynamic range).
static Int	`COLOR_MODE_UNDEFINED` Constant for `colorMode`: a value indicating that the color mode is undefined
static Int	`COLOR_MODE_WIDE_COLOR_GAMUT_MASK` Constant for `colorMode`: bits that encode whether the screen is wide gamut.
static Int	`COLOR_MODE_WIDE_COLOR_GAMUT_NO` Constant for `colorMode`: a `COLOR_MODE_WIDE_COLOR_GAMUT_MASK` value indicating that the screen is not wide gamut.
static Int	`COLOR_MODE_WIDE_COLOR_GAMUT_UNDEFINED` Constant for `colorMode`: a `COLOR_MODE_WIDE_COLOR_GAMUT_MASK` value indicating that it is unknown whether or not the screen is wide gamut.
static Int	`COLOR_MODE_WIDE_COLOR_GAMUT_YES` Constant for `colorMode`: a `COLOR_MODE_WIDE_COLOR_GAMUT_MASK` value indicating that the screen is wide gamut.
static Int	`DENSITY_DPI_UNDEFINED` Default value for `densityDpi` indicating that no width has been specified.
static Int	`FONT_WEIGHT_ADJUSTMENT_UNDEFINED` An undefined fontWeightAdjustment.
static Int	`GRAMMATICAL_GENDER_FEMININE` Constant for grammatical gender: to indicate the terms of address the user preferred in an application is feminine.
static Int	`GRAMMATICAL_GENDER_MASCULINE` Constant for grammatical gender: to indicate the terms of address the user preferred in an application is masculine.
static Int	`GRAMMATICAL_GENDER_NEUTRAL` Constant for grammatical gender: to indicate the terms of address the user preferred in an application is neuter.
static Int	`GRAMMATICAL_GENDER_NOT_SPECIFIED` Constant for grammatical gender: to indicate the user has not specified the terms of address for the application.
static Int	`HARDKEYBOARDHIDDEN_NO` Constant for `hardKeyboardHidden`, value corresponding to the physical keyboard being exposed.
static Int	`HARDKEYBOARDHIDDEN_UNDEFINED` Constant for `hardKeyboardHidden`: a value indicating that no value has been set.
static Int	`HARDKEYBOARDHIDDEN_YES` Constant for `hardKeyboardHidden`, value corresponding to the physical keyboard being hidden.
static Int	`KEYBOARDHIDDEN_NO` Constant for `keyboardHidden`, value corresponding to the keysexposed resource qualifier.
static Int	`KEYBOARDHIDDEN_UNDEFINED` Constant for `keyboardHidden`: a value indicating that no value has been set.
static Int	`KEYBOARDHIDDEN_YES` Constant for `keyboardHidden`, value corresponding to the keyshidden resource qualifier.
static Int	`KEYBOARD_12KEY` Constant for `keyboard`, value corresponding to the 12key resource qualifier.
static Int	`KEYBOARD_NOKEYS` Constant for `keyboard`, value corresponding to the nokeys resource qualifier.
static Int	`KEYBOARD_QWERTY` Constant for `keyboard`, value corresponding to the qwerty resource qualifier.
static Int	`KEYBOARD_UNDEFINED` Constant for `keyboard`: a value indicating that no value has been set.
static Int	`MNC_ZERO` Constant used to to represent MNC (Mobile Network Code) zero.
static Int	`NAVIGATIONHIDDEN_NO` Constant for `navigationHidden`, value corresponding to the navexposed resource qualifier.
static Int	`NAVIGATIONHIDDEN_UNDEFINED` Constant for `navigationHidden`: a value indicating that no value has been set.
static Int	`NAVIGATIONHIDDEN_YES` Constant for `navigationHidden`, value corresponding to the navhidden resource qualifier.
static Int	`NAVIGATION_DPAD` Constant for `navigation`, value corresponding to the dpad resource qualifier.
static Int	`NAVIGATION_NONAV` Constant for `navigation`, value corresponding to the nonav resource qualifier.
static Int	`NAVIGATION_TRACKBALL` Constant for `navigation`, value corresponding to the trackball resource qualifier.
static Int	`NAVIGATION_UNDEFINED` Constant for `navigation`: a value indicating that no value has been set.
static Int	`NAVIGATION_WHEEL` Constant for `navigation`, value corresponding to the wheel resource qualifier.
static Int	`ORIENTATION_LANDSCAPE` Constant for `orientation`, value corresponding to the land resource qualifier.
static Int	`ORIENTATION_PORTRAIT` Constant for `orientation`, value corresponding to the port resource qualifier.
static Int	`ORIENTATION_SQUARE`
static Int	`ORIENTATION_UNDEFINED` Constant for `orientation`: a value indicating that no value has been set.
static Int	`SCREENLAYOUT_LAYOUTDIR_LTR` Constant for `screenLayout`: a `SCREENLAYOUT_LAYOUTDIR_MASK` value indicating that a layout dir has been set to LTR.
static Int	`SCREENLAYOUT_LAYOUTDIR_MASK` Constant for `screenLayout`: bits that encode the layout direction.
static Int	`SCREENLAYOUT_LAYOUTDIR_RTL` Constant for `screenLayout`: a `SCREENLAYOUT_LAYOUTDIR_MASK` value indicating that a layout dir has been set to RTL.
static Int	`SCREENLAYOUT_LAYOUTDIR_SHIFT` Constant for `screenLayout`: bits shift to get the layout direction.
static Int	`SCREENLAYOUT_LAYOUTDIR_UNDEFINED` Constant for `screenLayout`: a `SCREENLAYOUT_LAYOUTDIR_MASK` value indicating that no layout dir has been set.
static Int	`SCREENLAYOUT_LONG_MASK` Constant for `screenLayout`: bits that encode the aspect ratio.
static Int	`SCREENLAYOUT_LONG_NO` Constant for `screenLayout`: a `SCREENLAYOUT_LONG_MASK` value that corresponds to the notlong resource qualifier.
static Int	`SCREENLAYOUT_LONG_UNDEFINED` Constant for `screenLayout`: a `SCREENLAYOUT_LONG_MASK` value indicating that no size has been set.
static Int	`SCREENLAYOUT_LONG_YES` Constant for `screenLayout`: a `SCREENLAYOUT_LONG_MASK` value that corresponds to the long resource qualifier.
static Int	`SCREENLAYOUT_ROUND_MASK` Constant for `screenLayout`: bits that encode roundness of the screen.
static Int	`SCREENLAYOUT_ROUND_NO` Constant for `screenLayout`: a `SCREENLAYOUT_ROUND_MASK` value indicating that the screen does not have a rounded shape.
static Int	`SCREENLAYOUT_ROUND_UNDEFINED` Constant for `screenLayout`: a `SCREENLAYOUT_ROUND_MASK` value indicating that it is unknown whether or not the screen has a round shape.
static Int	`SCREENLAYOUT_ROUND_YES` Constant for `screenLayout`: a `SCREENLAYOUT_ROUND_MASK` value indicating that the screen has a rounded shape.
static Int	`SCREENLAYOUT_SIZE_LARGE` Constant for `screenLayout`: a `SCREENLAYOUT_SIZE_MASK` value indicating the screen is at least approximately 480x640 dp units, corresponds to the large resource qualifier.
static Int	`SCREENLAYOUT_SIZE_MASK` Constant for `screenLayout`: bits that encode the size.
static Int	`SCREENLAYOUT_SIZE_NORMAL` Constant for `screenLayout`: a `SCREENLAYOUT_SIZE_MASK` value indicating the screen is at least approximately 320x470 dp units, corresponds to the normal resource qualifier.
static Int	`SCREENLAYOUT_SIZE_SMALL` Constant for `screenLayout`: a `SCREENLAYOUT_SIZE_MASK` value indicating the screen is at least approximately 320x426 dp units, corresponds to the small resource qualifier.
static Int	`SCREENLAYOUT_SIZE_UNDEFINED` Constant for `screenLayout`: a `SCREENLAYOUT_SIZE_MASK` value indicating that no size has been set.
static Int	`SCREENLAYOUT_SIZE_XLARGE` Constant for `screenLayout`: a `SCREENLAYOUT_SIZE_MASK` value indicating the screen is at least approximately 720x960 dp units, corresponds to the xlarge resource qualifier.
static Int	`SCREENLAYOUT_UNDEFINED` Constant for `screenLayout`: a value indicating that screenLayout is undefined
static Int	`SCREEN_HEIGHT_DP_UNDEFINED` Default value for `screenHeightDp` indicating that no width has been specified.
static Int	`SCREEN_WIDTH_DP_UNDEFINED` Default value for `screenWidthDp` indicating that no width has been specified.
static Int	`SMALLEST_SCREEN_WIDTH_DP_UNDEFINED` Default value for `smallestScreenWidthDp` indicating that no width has been specified.
static Int	`TOUCHSCREEN_FINGER` Constant for `touchscreen`, value corresponding to the finger resource qualifier.
static Int	`TOUCHSCREEN_NOTOUCH` Constant for `touchscreen`, value corresponding to the notouch resource qualifier.
static Int	`TOUCHSCREEN_STYLUS`
static Int	`TOUCHSCREEN_UNDEFINED` Constant for `touchscreen`: a value indicating that no value has been set.
static Int	`UI_MODE_NIGHT_MASK` Constant for `uiMode`: bits that encode the night mode.
static Int	`UI_MODE_NIGHT_NO` Constant for `uiMode`: a `UI_MODE_NIGHT_MASK` value that corresponds to the notnight resource qualifier.
static Int	`UI_MODE_NIGHT_UNDEFINED` Constant for `uiMode`: a `UI_MODE_NIGHT_MASK` value indicating that no mode type has been set.
static Int	`UI_MODE_NIGHT_YES` Constant for `uiMode`: a `UI_MODE_NIGHT_MASK` value that corresponds to the night resource qualifier.
static Int	`UI_MODE_TYPE_APPLIANCE` Constant for `uiMode`: a `UI_MODE_TYPE_MASK` value that corresponds to the appliance resource qualifier.
static Int	`UI_MODE_TYPE_CAR` Constant for `uiMode`: a `UI_MODE_TYPE_MASK` value that corresponds to the car resource qualifier.
static Int	`UI_MODE_TYPE_DESK` Constant for `uiMode`: a `UI_MODE_TYPE_MASK` value that corresponds to the desk resource qualifier.
static Int	`UI_MODE_TYPE_MASK` Constant for `uiMode`: bits that encode the mode type.
static Int	`UI_MODE_TYPE_NORMAL` Constant for `uiMode`: a `UI_MODE_TYPE_MASK` value that corresponds to no UI mode resource qualifier specified.
static Int	`UI_MODE_TYPE_TELEVISION` Constant for `uiMode`: a `UI_MODE_TYPE_MASK` value that corresponds to the television resource qualifier.
static Int	`UI_MODE_TYPE_UNDEFINED` Constant for `uiMode`: a `UI_MODE_TYPE_MASK` value indicating that no mode type has been set.
static Int	`UI_MODE_TYPE_VR_HEADSET` Constant for `uiMode`: a `UI_MODE_TYPE_MASK` value that corresponds to the vrheadset resource qualifier.
static Int	`UI_MODE_TYPE_WATCH` Constant for `uiMode`: a `UI_MODE_TYPE_MASK` value that corresponds to the watch resource qualifier.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`Configuration()` Construct an invalid Configuration.
`Configuration(o: Configuration!)` Makes a deep copy suitable for modification.

Public methods
Int	`compareTo(other: Configuration!)` Compares this object with the specified object for order.
Int	`describeContents()` Parcelable methods
Int	`diff(delta: Configuration!)` Return a bit mask of the differences between this Configuration object and the given one.
Boolean	`equals(that: Configuration!)`
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
static Configuration	`generateDelta(base: Configuration, change: Configuration)` Generate a delta Configuration between `base` and `change`.
Int	`getGrammaticalGender()` Returns the user preference for the grammatical gender.
Int	`getLayoutDirection()` Return the layout direction.
LocaleList	`getLocales()` Get the locale list.
Int	`hashCode()` Returns a hash code value for the object.
Boolean	`isLayoutSizeAtLeast(size: Int)` Check if the Configuration's current `screenLayout` is at least the given size.
Boolean	`isNightModeActive()` Retuns whether the configuration is in night mode
Boolean	`isScreenHdr()` Return whether the screen has a high dynamic range.
Boolean	`isScreenRound()` Return whether the screen has a round shape.
Boolean	`isScreenWideColorGamut()` Return whether the screen has a wide color gamut and wide color gamut rendering is supported by this device.
static Boolean	`needNewResources(configChanges: Int, interestingChanges: Int)` Determines if a new resource needs to be loaded from the bit set of configuration changes returned by `updateFrom(Configuration)`.
Unit	`readFromParcel(source: Parcel!)`
Unit	`setLayoutDirection(loc: Locale!)` Set the layout direction from a Locale.
Unit	`setLocale(loc: Locale?)` Set the locale list to a list of just one locale.
Unit	`setLocales(locales: LocaleList?)` Set the locale list.
Unit	`setTo(o: Configuration!)` Sets the fields in this object to those in the given Configuration.
Unit	`setToDefaults()` Set this object to the system defaults.
String	`toString()` Returns a string representation of the object.
Int	`updateFrom(delta: Configuration)` Copies the fields from delta into this Configuration object, keeping track of which ones have changed.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<Configuration!>	`CREATOR`
Int	`colorMode` Bit mask of color capabilities of the screen.
Int	`densityDpi` The target screen density being rendered to, corresponding to density resource qualifier.
Float	`fontScale` Current user preference for the scaling factor for fonts, relative to the base density scaling.
Int	`fontWeightAdjustment` Adjustment in text font weight.
Int	`hardKeyboardHidden` A flag indicating whether the hard keyboard has been hidden.
Int	`keyboard` The kind of keyboard attached to the device.
Int	`keyboardHidden` A flag indicating whether any keyboard is available.
Locale!	`locale` Current user preference for the locale, corresponding to locale resource qualifier.
Int	`mcc` IMSI MCC (Mobile Country Code), corresponding to mcc resource qualifier.
Int	`mnc` IMSI MNC (Mobile Network Code), corresponding to mnc resource qualifier.
Int	`navigation` The kind of navigation method available on the device.
Int	`navigationHidden` A flag indicating whether any 5-way or DPAD navigation available.
Int	`orientation` Overall orientation of the screen.
Int	`screenHeightDp` The height of the available screen space in dp units.
Int	`screenLayout` Bit mask of overall layout of the screen.
Int	`screenWidthDp` The width of the available screen space in dp units.
Int	`smallestScreenWidthDp` The smallest screen size an application will see in normal operation.
Int	`touchscreen` The kind of touch screen attached to the device.
Int	`uiMode` Bit mask of the ui mode.

Constants

COLOR_MODE_HDR_MASK

Added in API level 26

static val COLOR_MODE_HDR_MASK: Int

Constant for colorMode: bits that encode the dynamic range of the screen.

Value: 12

COLOR_MODE_HDR_NO

Added in API level 26

static val COLOR_MODE_HDR_NO: Int

Constant for colorMode: a COLOR_MODE_HDR_MASK value indicating that the screen is not HDR (low/standard dynamic range).

Corresponds to the -lowdr resource qualifier.

Value: 4

COLOR_MODE_HDR_SHIFT

Added in API level 26

static val COLOR_MODE_HDR_SHIFT: Int

Constant for colorMode: bits shift to get the screen dynamic range.

Value: 2

COLOR_MODE_HDR_UNDEFINED

Added in API level 26

static val COLOR_MODE_HDR_UNDEFINED: Int

Constant for colorMode: a COLOR_MODE_HDR_MASK value indicating that it is unknown whether or not the screen is HDR.

Value: 0

COLOR_MODE_HDR_YES

Added in API level 26

static val COLOR_MODE_HDR_YES: Int

Constant for colorMode: a COLOR_MODE_HDR_MASK value indicating that the screen is HDR (dynamic range).

Corresponds to the -highdr resource qualifier.

Value: 8

COLOR_MODE_UNDEFINED

Added in API level 26

static val COLOR_MODE_UNDEFINED: Int

Constant for colorMode: a value indicating that the color mode is undefined

Value: 0

COLOR_MODE_WIDE_COLOR_GAMUT_MASK

Added in API level 26

static val COLOR_MODE_WIDE_COLOR_GAMUT_MASK: Int

Constant for colorMode: bits that encode whether the screen is wide gamut.

Value: 3

COLOR_MODE_WIDE_COLOR_GAMUT_NO

Added in API level 26

static val COLOR_MODE_WIDE_COLOR_GAMUT_NO: Int

Constant for colorMode: a COLOR_MODE_WIDE_COLOR_GAMUT_MASK value indicating that the screen is not wide gamut.

Corresponds to the -nowidecg resource qualifier.

Value: 1

COLOR_MODE_WIDE_COLOR_GAMUT_UNDEFINED

Added in API level 26

static val COLOR_MODE_WIDE_COLOR_GAMUT_UNDEFINED: Int

Constant for colorMode: a COLOR_MODE_WIDE_COLOR_GAMUT_MASK value indicating that it is unknown whether or not the screen is wide gamut.

Value: 0

COLOR_MODE_WIDE_COLOR_GAMUT_YES

Added in API level 26

static val COLOR_MODE_WIDE_COLOR_GAMUT_YES: Int

Constant for colorMode: a COLOR_MODE_WIDE_COLOR_GAMUT_MASK value indicating that the screen is wide gamut.

Corresponds to the -widecg resource qualifier.

Value: 2

DENSITY_DPI_UNDEFINED

Added in API level 17

static val DENSITY_DPI_UNDEFINED: Int

Default value for densityDpi indicating that no width has been specified.

Value: 0

FONT_WEIGHT_ADJUSTMENT_UNDEFINED

Added in API level 31

static val FONT_WEIGHT_ADJUSTMENT_UNDEFINED: Int

An undefined fontWeightAdjustment.

Value: 2147483647

GRAMMATICAL_GENDER_FEMININE

Added in API level 34

static val GRAMMATICAL_GENDER_FEMININE: Int

Constant for grammatical gender: to indicate the terms of address the user preferred in an application is feminine.

Value: 2

GRAMMATICAL_GENDER_MASCULINE

Added in API level 34

static val GRAMMATICAL_GENDER_MASCULINE: Int

Constant for grammatical gender: to indicate the terms of address the user preferred in an application is masculine.

Value: 3