Screen (library API)

```
public interface Screen
```
Screen interface specifies API through which an actual information about the Android device's screen may be accessed.
A screen implementation may be obtained via Screen.PROVIDER.getScreen(Context).
Below are listed methods provided by this interface:
Author:

Martin Albedinsky

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Screen.Orientation` Defines an annotation for determining set of available screen orientations.
`static interface`	`Screen.Provider` Interface for provider that may be used to access implementation of `Screen`.
`static class`	`Screen.ScreenDensity` Represents density of the Android device's screen.
`static class`	`Screen.ScreenRotation` Represents rotation of the Android device's screen.
`static class`	`Screen.ScreenType` Represents type of the Android device's screen.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ORIENTATION_BEHIND` Copy of `ActivityInfo.SCREEN_ORIENTATION_BEHIND` flag for better access.
`static int`	`ORIENTATION_CURRENT` Orientation flag that is used to lock screen on the current orientation.
`static int`	`ORIENTATION_FULL_SENSOR` Copy of `ActivityInfo.SCREEN_ORIENTATION_FULL_SENSOR` flag for better access.
`static int`	`ORIENTATION_LANDSCAPE` Copy of `ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE` flag for better access.
`static int`	`ORIENTATION_PORTRAIT` Copy of `ActivityInfo.SCREEN_ORIENTATION_PORTRAIT` flag for better access.
`static int`	`ORIENTATION_REVERSE_LANDSCAPE` Copy of `ActivityInfo.SCREEN_ORIENTATION_REVERSE_LANDSCAPE` flag for better access.
`static int`	`ORIENTATION_REVERSE_PORTRAIT` Copy of `ActivityInfo.SCREEN_ORIENTATION_REVERSE_PORTRAIT` flag for better access.
`static int`	`ORIENTATION_SENSOR` Copy of `ActivityInfo.SCREEN_ORIENTATION_SENSOR` flag for better access.
`static int`	`ORIENTATION_SENSOR_LANDSCAPE` Copy of `ActivityInfo.SCREEN_ORIENTATION_SENSOR_LANDSCAPE` flag for better access.
`static int`	`ORIENTATION_SENSOR_PORTRAIT` Copy of `ActivityInfo.SCREEN_ORIENTATION_SENSOR_PORTRAIT` flag for better access.
`static int`	`ORIENTATION_UNSPECIFIED` Copy of `ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED` flag for better access.
`static int`	`ORIENTATION_USER` Copy of `ActivityInfo.SCREEN_ORIENTATION_USER` flag for better access.
`static Screen.Provider`	`PROVIDER` A `Screen.Provider` implementation that may be used to access implementation of `Screen`.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`dpToPixel(float dp)` Transforms density pixel to raw pixel.
`int`	`getBrightness(android.app.Activity activity)` Returns the back-light brightness of the Android device's screen for the current application window from the range [0, 100].
`int`	`getCurrentHeight()` Returns the current height of the Android device's screen, which depends on the current screen orientation.
`int`	`getCurrentOrientation()` Returns the current orientation of the Android device's screen.
`Screen.ScreenRotation`	`getCurrentRotation()` Returns the current rotation of the Android device's screen.
`int`	`getCurrentWidth()` Returns the current width of the Android device's screen, which depends on the current screen orientation.
`int`	`getDefaultOrientation()` Returns the default orientation of the Android device's screen.
`Screen.ScreenDensity`	`getDensity()` Returns the density of the Android device's screen.
`float`	`getDiagonalDistanceInInches()` Returns the diagonal distance of the Android device's screen.
`int`	`getDiagonalDistanceInPixels()` Returns the diagonal distance of the Android device's screen.
`android.view.Display`	`getDisplay()` Returns default display of the Android device.
`int`	`getHeight()` Returns the "default" height of the Android device's screen.
`android.util.DisplayMetrics`	`getMetrics()` Returns the current display metrics of the Android device's screen.
`int`	`getRawDensity()` Returns the raw density of the Android device's screen obtained from the screen metrics.
`float`	`getRefreshRate()` Returns refresh rate of the Android device's screen.
`int`	`getRequestedOrientation(android.app.Activity activity)` Returns the orientation that was requested for the specified `activity` via `requestOrientation(Activity, int)` or directly `Activity.setRequestedOrientation(int)`.
`float`	`getScreenDP()` Returns the value of density pixel for 1 pixel for the Android device's screen.
`int`	`getSystemBrightness()` Returns the back-light brightness of the Android device's screen.
`Screen.ScreenType`	`getType()` Returns the type of the Android device's screen.
`int`	`getWidth()` Returns the "default" width of the Android device's screen.
`boolean`	`isInteractive()` Checks whether the Android device's screen is interactive or not.
`boolean`	`isOn()` Checks whether the Android device's screen is currently on or off.
`boolean`	`isOrientationLocked()` Returns flag indicating whether orientation of the Android device's screen is currently locked or not.
`boolean`	`lockOrientation(android.app.Activity activity)` Locks orientation of the Android device's screen at the current orientation for the given activity.
`float`	`pixelToDP(int pixel)` Transforms raw pixel to density pixel.
`boolean`	`requestOrientation(android.app.Activity activity, int orientation)` Requests the specified orientation as orientation of the Android device's screen for the given activity.
`void`	`setBrightness(android.app.Activity activity, int brightness)` Sets the back-light brightness of the Android device's screen.
`void`	`unlockOrientation(android.app.Activity activity)` Unlocks orientation of the Android device's screen for the given activity.

- Field Detail
  - PROVIDER
```
static final Screen.Provider PROVIDER
```
    A Screen.Provider implementation that may be used to access implementation of Screen.
  - ORIENTATION_CURRENT
```
static final int ORIENTATION_CURRENT
```
    Orientation flag that is used to lock screen on the current orientation.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_UNSPECIFIED
```
static final int ORIENTATION_UNSPECIFIED
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED flag for better access.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_LANDSCAPE
```
static final int ORIENTATION_LANDSCAPE
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE flag for better access.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_PORTRAIT
```
static final int ORIENTATION_PORTRAIT
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_PORTRAIT flag for better access.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_USER
```
static final int ORIENTATION_USER
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_USER flag for better access.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_BEHIND
```
static final int ORIENTATION_BEHIND
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_BEHIND flag for better access.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_SENSOR
```
static final int ORIENTATION_SENSOR
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_SENSOR flag for better access.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_SENSOR_LANDSCAPE
```
static final int ORIENTATION_SENSOR_LANDSCAPE
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_SENSOR_LANDSCAPE flag for better access.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_SENSOR_PORTRAIT
```
static final int ORIENTATION_SENSOR_PORTRAIT
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_SENSOR_PORTRAIT flag for better access.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_REVERSE_LANDSCAPE
```
static final int ORIENTATION_REVERSE_LANDSCAPE
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_REVERSE_LANDSCAPE flag for better access.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_REVERSE_PORTRAIT
```
static final int ORIENTATION_REVERSE_PORTRAIT
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_REVERSE_PORTRAIT flag for better access.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_FULL_SENSOR
```
static final int ORIENTATION_FULL_SENSOR
```
    Copy of ActivityInfo.SCREEN_ORIENTATION_FULL_SENSOR flag for better access.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isOn
```
boolean isOn()
```
    Checks whether the Android device's screen is currently on or off.
    
    Returns:
    
    True if screen is on, false otherwise.
  - isInteractive
```
boolean isInteractive()
```
    Checks whether the Android device's screen is interactive or not.
    Note, that this is supported only for KITKAT_WATCH and above.
    
    Returns:
    
    True if screen is interactive, false otherwise.
  - getDisplay
```
android.view.Display getDisplay()
```
    Returns default display of the Android device.
    
    Returns:
    
    The default display obtained by WindowManager.getDefaultDisplay().
  - getWidth
```
int getWidth()
```
    Returns the "default" width of the Android device's screen.
    
    Returns:
    
    Screen width in pixels.
  - getHeight
```
int getHeight()
```
    Returns the "default" height of the Android device's screen.
    
    Returns:
    
    Screen height in pixels.
  - getCurrentWidth
```
int getCurrentWidth()
```
    Returns the current width of the Android device's screen, which depends on the current screen orientation.
    
    Returns:
    
    Screen current width in pixels.
  - getCurrentHeight
```
int getCurrentHeight()
```
    Returns the current height of the Android device's screen, which depends on the current screen orientation.
    
    Returns:
    
    Screen current height in pixels.
  - getMetrics
```
android.util.DisplayMetrics getMetrics()
```
    Returns the current display metrics of the Android device's screen.
    
    Returns:
    
    Display metrics.
  - getDensity
```
Screen.ScreenDensity getDensity()
```
    Returns the density of the Android device's screen.
    
    Returns:
    
    One of Screen.ScreenDensity values or UNKNOWN if the current screen data are unavailable.
    
    See Also:
    
    getRawDensity()
  - getRawDensity
```
int getRawDensity()
```
    Returns the raw density of the Android device's screen obtained from the screen metrics.
    
    Returns:
    
    Value of raw density
    
    See Also:
    
    getDensity()
  - getType
```
Screen.ScreenType getType()
```
    Returns the type of the Android device's screen.
    
    Returns:
    
    One of Screen.ScreenType values or UNKNOWN if the current screen data are unavailable.
  - getDefaultOrientation
```
int getDefaultOrientation()
```
    Returns the default orientation of the Android device's screen.
    
    Returns:
    
    ORIENTATION_PORTRAIT for phone, ORIENTATION_LANDSCAPE for tablet or UNSPECIFIED if the current screen data are unavailable or orientation is unknown.
  - getCurrentOrientation
```
int getCurrentOrientation()
```
    Returns the current orientation of the Android device's screen.
    
    Returns:
    
    One of ORIENTATION_PORTRAIT, ORIENTATION_LANDSCAPE, ORIENTATION_REVERSE_PORTRAIT ORIENTATION_REVERSE_LANDSCAPE, ORIENTATION_USER, ORIENTATION_SENSOR, ORIENTATION_SENSOR_PORTRAIT, ORIENTATION_SENSOR_LANDSCAPE, ORIENTATION_FULL_SENSOR, ORIENTATION_BEHIND, or ORIENTATION_UNSPECIFIED if the current screen data are unavailable or orientation is unknown.
  - getCurrentRotation
```
Screen.ScreenRotation getCurrentRotation()
```
    Returns the current rotation of the Android device's screen.
    
    Returns:
    
    One of Screen.ScreenRotation values or UNKNOWN if the current screen data are unavailable or orientation is unknown.
  - getDiagonalDistanceInInches
```
float getDiagonalDistanceInInches()
```
    Returns the diagonal distance of the Android device's screen.
    
    Returns:
    
    Diagonal distance in the inches.
  - getDiagonalDistanceInPixels
```
int getDiagonalDistanceInPixels()
```
    Returns the diagonal distance of the Android device's screen.
    
    Returns:
    
    Diagonal distance in the raw pixels.
  - getBrightness
```
int getBrightness(android.app.Activity activity)
```
    Returns the back-light brightness of the Android device's screen for the current application window from the range [0, 100].
    
    Parameters:
    
    activity - Currently visible activity.
    
    Returns:
    
    The value of brightness from the specified range or negative number if the current application window doesn't have set custom brightness value or the given activity or its window is invalid.
  - setBrightness
```
void setBrightness(android.app.Activity activity,
                   int brightness)
```
    Sets the back-light brightness of the Android device's screen. Brightness will be applied only for the current application window, not for the whole device.
    Note, that the platform will automatically take care of changing the brightness as the user moves in and out of the application with custom brightness.
    
    Parameters:
    
    activity - Currently visible activity.
    
    brightness - The value of brightness for the application window from the range [0, 100].
    
    Throws:
    
    IllegalArgumentException - When the given brightness value is out of the specified range.
  - getSystemBrightness
```
int getSystemBrightness()
```
    Returns the back-light brightness of the Android device's screen.
    
    Returns:
    
    The value of system brightness as an Android user set it in the settings.
  - requestOrientation
```
boolean requestOrientation(android.app.Activity activity,
                           int orientation)
```
    Requests the specified orientation as orientation of the Android device's screen for the given activity.
    
    Parameters:
    
    activity - Currently visible activity.
    
    orientation - Orientation that you would like to set for the activity. One of the orientation flags specified within this interface.
    
    Returns:
    
    True if orientation was successfully requested, false otherwise.
    
    See Also:
    
    isOrientationLocked(), lockOrientation(Activity)
  - getRequestedOrientation
```
int getRequestedOrientation(android.app.Activity activity)
```
    Returns the orientation that was requested for the specified activity via requestOrientation(Activity, int) or directly Activity.setRequestedOrientation(int).
    
    Parameters:
    
    activity - Currently visible activity of which requested orientation to obtain.
    
    Returns:
    
    One of the orientation flags specified within this interface.
  - lockOrientation
```
boolean lockOrientation(android.app.Activity activity)
```
    Locks orientation of the Android device's screen at the current orientation for the given activity.
    
    Parameters:
    
    activity - Currently visible activity.
    
    Returns:
    
    True if orientation was locked, false otherwise.
    
    See Also:
    
    isOrientationLocked(), unlockOrientation(Activity), requestOrientation(Activity, int)
  - unlockOrientation
```
void unlockOrientation(android.app.Activity activity)
```
    Unlocks orientation of the Android device's screen for the given activity. This will actually requests SCREEN_ORIENTATION_USER orientation.
    
    Parameters:
    
    activity - Currently visible activity.
    
    See Also:
    
    isOrientationLocked(), lockOrientation(Activity)
  - isOrientationLocked
```
boolean isOrientationLocked()
```
    Returns flag indicating whether orientation of the Android device's screen is currently locked or not. Note, that this flag is useful only while you are within activity which requests to lock/unlock screen orientation.
    
    Returns:
    
    True if screen orientation is currently locked by one of lockOrientation(Activity) or requestOrientation(Activity, int), false otherwise.
    
    See Also:
    
    lockOrientation(Activity), requestOrientation(Activity, int)
  - pixelToDP
```
float pixelToDP(int pixel)
```
    Transforms raw pixel to density pixel. Transformation will be performed according to density of the Android device's screen.
    
    Parameters:
    
    pixel - The pixel value which you want to transform to density pixel value.
    
    Returns:
    
    Density pixel value transformed from the given pixel value.
    
    See Also:
    
    dpToPixel(float)
  - dpToPixel
```
int dpToPixel(float dp)
```
    Transforms density pixel to raw pixel. Transformation will be performed according to density of the Android device's screen.
    
    Parameters:
    
    dp - The density pixel value which you want to transform to pixel raw value.
    
    Returns:
    
    Pixel value transformed from the given density pixel value.
    
    See Also:
    
    pixelToDP(int)
  - getScreenDP
```
float getScreenDP()
```
    Returns the value of density pixel for 1 pixel for the Android device's screen.
    This value depends on the screen's density.
    
    Returns:
    
    Density pixel value of screen.
    
    See Also:
    
    dpToPixel(float), pixelToDP(int)
  - getRefreshRate
```
float getRefreshRate()
```
    Returns refresh rate of the Android device's screen.
    
    Returns:
    
    Refresh rate in frames per second.
    
    See Also:
    
    Display.getRefreshRate()

Interface Screen

Nested Class Summary

Field Summary

Method Summary

Field Detail

PROVIDER

ORIENTATION_CURRENT

ORIENTATION_UNSPECIFIED

ORIENTATION_LANDSCAPE

ORIENTATION_PORTRAIT

ORIENTATION_USER

ORIENTATION_BEHIND

ORIENTATION_SENSOR

ORIENTATION_SENSOR_LANDSCAPE

ORIENTATION_SENSOR_PORTRAIT

ORIENTATION_REVERSE_LANDSCAPE

ORIENTATION_REVERSE_PORTRAIT

ORIENTATION_FULL_SENSOR

Method Detail

isOn

isInteractive

getDisplay

getWidth

getHeight

getCurrentWidth

getCurrentHeight

getMetrics

getDensity

getRawDensity

getType

getDefaultOrientation

getCurrentOrientation

getCurrentRotation

getDiagonalDistanceInInches

getDiagonalDistanceInPixels

getBrightness

setBrightness

getSystemBrightness

requestOrientation

getRequestedOrientation

lockOrientation

unlockOrientation

isOrientationLocked

pixelToDP

dpToPixel

getScreenDP

getRefreshRate