鸿蒙OS Display

Display

java.lang.Object

|---ohos.agp.window.service.Display

public class Display
extends Object

封装显示属性和操作。

DisplayManager.getDefaultDisplay(Context) 返回一个 Display 对象。

Since:

2

字段摘要

修饰符和类型	字段	描述
static int	STATE_DOZE	表示此屏幕正在打瞌睡。
static int	STATE_DOZE_SUSPEND	表示此屏幕正在打瞌睡，但 CPU 暂停更新它。
static int	STATE_OFF	表示此屏幕已关闭。
static int	STATE_ON	表示此屏幕已打开。
static int	STATE_ON_SUSPEND	表示此屏幕已打开，但 CPU 暂停更新它。
static int	STATE_UNKNOWN	表示此屏幕处于未知状态。
static int	STATE_VR	表示此屏幕处于虚拟现实（VR）状态。

构造函数摘要

构造函数	描述
Display()	用于创建 Display 实例的构造函数。

方法总结

修饰符和类型	方法	描述
DisplayAttributes	getAttributes()	获取显示的属性。
void	getCurrentSizeRange(Point outSmallestSize, Point outLargestSize)	获取显示器的尺寸范围，以像素为单位。
int	getDisplayId()	获取显示器的ID。
String	getDisplayName()	获取显示器的名称。
int	getDisplayState()	获取此显示设备的状态。
DisplayAttributes	getRealAttributes()	获取显示的实际属性。
void	getRealSize(Point outSize)	获取实际显示尺寸。
float	getRefreshRate()	获取此显示设备每秒的屏幕刷新率。
int	getRotation()	获取显示器的旋转度数。
void	getSize(Point outSize)	获取显示器的尺寸。
boolean	isAlive()	检查此显示设备是否处于活动状态。

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细信息

STATE_DOZE

public static final int STATE_DOZE

表示此屏幕正在打瞌睡。

Since:

5

STATE_DOZE_SUSPEND

public static final int STATE_DOZE_SUSPEND

表示此屏幕正在打瞌睡，但 CPU 暂停更新它。

Since:

5

STATE_OFF

public static final int STATE_OFF

表示此屏幕已关闭。

Since:

5

STATE_ON

public static final int STATE_ON

表示此屏幕已打开。

Since:

5

STATE_ON_SUSPEND

public static final int STATE_ON_SUSPEND

表示此屏幕已打开，但 CPU 暂停更新它。

Since:

5

STATE_UNKNOWN

public static final int STATE_UNKNOWN

表示此屏幕处于未知状态。

Since:

5

STATE_VR

public static final int STATE_VR

表示此屏幕处于虚拟现实（VR）状态。

Since:

5

构造函数详细信息

Display

public Display()

用于创建 Display 实例的构造函数。

方法详情

getDisplayId

public int getDisplayId()

获取显示器的ID。

返回:

返回显示 ID。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

getDisplayName

public String getDisplayName()

获取显示器的名称。

返回:

返回显示名称。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

getRotation

public int getRotation()

获取显示器的旋转度数。 旋转度由枚举值表示。 0 表示不旋转，1 表示 90 度，2 表示 180 度，3 表示 270 度。

返回:

返回显示器的旋转度数。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

getAttributes

public DisplayAttributes getAttributes()

获取显示的属性。 导航栏的宽度和高度不包括在内。

返回:

返回显示的属性。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

getRealAttributes

public DisplayAttributes getRealAttributes()

获取显示的实际属性。

返回:

返回显示的实际属性。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

getCurrentSizeRange

public void getCurrentSizeRange(Point outSmallestSize, Point outLargestSize)

获取显示器的尺寸范围，以像素为单位。

此方法获得所有方向上预期显示的最大和最小尺寸。 得到的显示范围保存在该方法的参数中。

参数：

参数名称	参数描述
outSmallestSize	指示最小显示尺寸。
outLargestSize	指示最大显示尺寸。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

getSize

public void getSize(Point outSize)

获取显示器的尺寸。

此方法可能不会返回显示的实际大小。 例如，如果始终显示状态栏，则返回值已排除状态栏的大小，或者该值与已缩放以适应小屏幕设备的显示相匹配。

参数：

参数名称	参数描述
outSize	表示显示尺寸。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

getRealSize

public void getRealSize(Point outSize)

获取实际显示尺寸。

返回值包括状态栏的大小，没有任何比例。

参数：

参数名称	参数描述
outSize	指示显示器的实际尺寸。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

getRefreshRate

public float getRefreshRate()

获取此显示设备每秒的屏幕刷新率。

返回:

返回每秒的屏幕刷新率，以 Hz 为单位。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

Since:

5

getDisplayState

public int getDisplayState()

获取此显示设备的状态。

返回:

返回显示设备状态，可以是 STATE_OFF、STATE_ON、STATE_DOZE、STATE_DOZE_SUSPEND、STATE_ON_SUSPEND 或 STATE_UNKNOWN。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

Since:

5

isAlive

public boolean isAlive()

检查此显示设备是否处于活动状态。

返回:

如果此显示设备处于活动状态，则返回 true； 如果移除此显示设备，则返回 false。

Throws:

Throw名称	Throw描述
NullPointerException	如果 mDisplayWrapper 为 null，则引发此异常。

Since:

5