public final class WindowInsets
extends Object
java.lang.Object | |
↳ | android.view.WindowInsets |
描述窗口内容的一组插入。
WindowInsets是不可变的,将来可能会扩展以包含更多的插入类型。 要调整插页,请使用提供的克隆方法之一来获取具有调整属性的新WindowInsets实例。
Public constructors |
|
---|---|
WindowInsets(WindowInsets src) 构造一个新的WindowInsets,从源WindowInsets复制所有值。 |
Public methods |
|
---|---|
WindowInsets |
consumeStableInsets() 返回此WindowInsets的完整消费的稳定插入的副本。 |
WindowInsets |
consumeSystemWindowInsets() 返回此WindowInsets的完整消耗的系统窗口插入的副本。 |
int |
getStableInsetBottom() 以像素为单位返回底部稳定的插入。 |
int |
getStableInsetLeft() 以像素为单位返回左侧稳定的插图。 |
int |
getStableInsetRight() 以像素为单位返回正确的稳定插图。 |
int |
getStableInsetTop() 以像素为单位返回顶部稳定的插入。 |
int |
getSystemWindowInsetBottom() 以像素为单位返回底部系统窗口插图。 |
int |
getSystemWindowInsetLeft() 以像素为单位返回左侧系统窗口的插图。 |
int |
getSystemWindowInsetRight() 以像素为单位返回正确的系统窗口插图。 |
int |
getSystemWindowInsetTop() 以像素为单位返回顶部系统窗口插图。 |
boolean |
hasInsets() 如果此WindowInsets具有任何非零的插图,则返回true。 |
boolean |
hasStableInsets() 如果此WindowInsets具有非零稳定的插入,则返回true。 |
boolean |
hasSystemWindowInsets() 如果此WindowInsets具有非零系统窗口insets,则返回true。 |
boolean |
isConsumed() 检查这些插入是否完全消耗。 |
boolean |
isRound() 如果关联的窗口具有圆形,则返回true。 |
WindowInsets |
replaceSystemWindowInsets(int left, int top, int right, int bottom) 返回此WindowInsets的副本,并将选定的系统窗口插入符用新值替换。 |
WindowInsets |
replaceSystemWindowInsets(Rect systemWindowInsets) 返回此WindowInsets的副本,并将选定的系统窗口插入符用新值替换。 |
String |
toString() 返回对象的字符串表示形式。 |
Inherited methods |
|
---|---|
From class java.lang.Object
|
WindowInsets (WindowInsets src)
构造一个新的WindowInsets,从源WindowInsets复制所有值。
Parameters | |
---|---|
src |
WindowInsets : Source to copy insets from |
WindowInsets consumeStableInsets ()
返回此WindowInsets的完整消费的稳定插入的副本。
Returns | |
---|---|
WindowInsets |
A modified copy of this WindowInsets |
WindowInsets consumeSystemWindowInsets ()
返回此WindowInsets的完整消耗的系统窗口插入的副本。
Returns | |
---|---|
WindowInsets |
A modified copy of this WindowInsets |
int getStableInsetBottom ()
以像素为单位返回底部稳定的插入。
稳定的插图表示可能部分或完全被系统UI元素遮挡的全屏窗口的区域。 该值不会基于这些元素的可见性状态而改变; 例如,如果状态栏通常显示但暂时隐藏,则稳定插图仍将提供与显示的状态栏关联的插图。
Returns | |
---|---|
int |
The bottom stable inset |
int getStableInsetLeft ()
以像素为单位返回左侧稳定的插图。
稳定的插图表示可能部分或完全被系统UI元素遮挡的全屏窗口的区域。 该值不会基于这些元素的可见性状态而改变; 例如,如果状态栏通常显示但暂时隐藏,则稳定插图仍将提供与显示的状态栏关联的插图。
Returns | |
---|---|
int |
The left stable inset |
int getStableInsetRight ()
以像素为单位返回正确的稳定插图。
稳定的插图表示可能部分或完全被系统UI元素遮挡的全屏窗口的区域。 该值不会基于这些元素的可见性状态而改变; 例如,如果状态栏通常显示但暂时隐藏,则稳定插图仍将提供与显示的状态栏关联的插图。
Returns | |
---|---|
int |
The right stable inset |
int getStableInsetTop ()
以像素为单位返回顶部稳定的插入。
稳定的插图表示可能部分或完全被系统UI元素遮挡的全屏窗口的区域。 该值不会基于这些元素的可见性状态而改变; 例如,如果状态栏通常显示但暂时隐藏,则稳定插图仍将提供与显示的状态栏关联的插图。
Returns | |
---|---|
int |
The top stable inset |
int getSystemWindowInsetBottom ()
以像素为单位返回底部系统窗口插图。
系统窗口插图表示全屏窗口的区域,部分或完全被状态栏,导航栏,IME或其他系统窗口遮挡。
Returns | |
---|---|
int |
The bottom system window inset |
int getSystemWindowInsetLeft ()
以像素为单位返回左侧系统窗口的插图。
系统窗口插图表示全屏窗口的区域,部分或完全被状态栏,导航栏,IME或其他系统窗口遮挡。
Returns | |
---|---|
int |
The left system window inset |
int getSystemWindowInsetRight ()
以像素为单位返回正确的系统窗口插图。
系统窗口插图表示全屏窗口的区域,部分或完全被状态栏,导航栏,IME或其他系统窗口遮挡。
Returns | |
---|---|
int |
The right system window inset |
int getSystemWindowInsetTop ()
以像素为单位返回顶部系统窗口插图。
系统窗口插图表示全屏窗口的区域,部分或完全被状态栏,导航栏,IME或其他系统窗口遮挡。
Returns | |
---|---|
int |
The top system window inset |
boolean hasInsets ()
如果此WindowInsets具有任何非零的插图,则返回true。
Returns | |
---|---|
boolean |
true if any inset values are nonzero |
boolean hasStableInsets ()
如果此WindowInsets具有非零稳定的插入,则返回true。
稳定的插图表示可能部分或完全被系统UI元素遮挡的全屏窗口的区域。 该值不会基于这些元素的可见性状态而改变; 例如,如果状态栏通常显示但暂时隐藏,则稳定插图仍将提供与显示的状态栏关联的插图。
Returns | |
---|---|
boolean |
true if any of the stable inset values are nonzero |
boolean hasSystemWindowInsets ()
如果此WindowInsets具有非零系统窗口insets,则返回true。
系统窗口插图表示全屏窗口的区域,部分或完全被状态栏,导航栏,IME或其他系统窗口遮挡。
Returns | |
---|---|
boolean |
true if any of the system window inset values are nonzero |
boolean isConsumed ()
检查这些插入是否完全消耗。
如果已调用适用的consume*
方法以使所有插入已设置为零,则认为插入被“消耗”。 这会影响通过视图层次结构的插页传播; 尚未完全消耗的插图将继续传播到子视图。
此方法的结果等于返回值 fitSystemWindows(android.graphics.Rect)
。
Returns | |
---|---|
boolean |
true if the insets have been fully consumed. |
boolean isRound ()
如果关联的窗口具有圆形,则返回true。
圆窗的左侧,顶部,右侧和底部边缘一直到达窗户的相关边缘,但角落可能不可见。 响应圆形插图的意见应该注意不要在可能无法访问的角落布置关键元素。
Returns | |
---|---|
boolean |
True if the window is round |
WindowInsets replaceSystemWindowInsets (int left, int top, int right, int bottom)
返回此WindowInsets的副本,并将选定的系统窗口插入符用新值替换。
Parameters | |
---|---|
left |
int : New left inset in pixels |
top |
int : New top inset in pixels |
right |
int : New right inset in pixels |
bottom |
int : New bottom inset in pixels |
Returns | |
---|---|
WindowInsets |
A modified copy of this WindowInsets |
WindowInsets replaceSystemWindowInsets (Rect systemWindowInsets)
返回此WindowInsets的副本,并将选定的系统窗口插入符用新值替换。
Parameters | |
---|---|
systemWindowInsets |
Rect : New system window insets. Each field is the inset in pixels for that edge |
Returns | |
---|---|
WindowInsets |
A modified copy of this WindowInsets |
String toString ()
返回对象的字符串表示形式。 通常, toString
方法返回一个“文本表示”该对象的字符串。 结果应该是一个简洁但内容丰富的表述,对于一个人来说很容易阅读。 建议所有子类重写此方法。
该toString
类方法Object
返回一个由类的名称,其中所述对象是其实例,该符号字符`的字符串@
”,并且对象的哈希码的无符号的十六进制表示。 换句话说,这个方法返回一个字符串,其值等于:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |