Egret Engine R - v6.0.0
    Preparing search index...

    支持视区的组件接口。

    如果组件的内容子项比组件要大,而且您向往子项可以在父级组件的边缘处被裁减,您可以定义一个视区。

    视区是您希望显示的组件的区域的矩形子集,而不是显示整个组件。

    Scroller

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    interface IViewport {
        contentWidth: number;
        contentHeight: number;
        scrollH: number;
        scrollV: number;
        scrollEnabled: boolean;
        includeInLayout: boolean;
        left: any;
        right: any;
        top: any;
        bottom: any;
        horizontalCenter: any;
        verticalCenter: any;
        percentWidth: number;
        percentHeight: number;
        explicitWidth: number;
        explicitHeight: number;
        minWidth: number;
        maxWidth: number;
        minHeight: number;
        maxHeight: number;
        setMeasuredSize(width: number, height: number): void;
        invalidateProperties(): void;
        validateProperties(): void;
        invalidateSize(): void;
        validateSize(recursive?: boolean): void;
        invalidateDisplayList(): void;
        validateDisplayList(): void;
        validateNow(): void;
        setLayoutBoundsSize(layoutWidth: number, layoutHeight: number): void;
        setLayoutBoundsPosition(x: number, y: number): void;
        getLayoutBounds(bounds: Rectangle): void;
        getPreferredBounds(bounds: Rectangle): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    contentWidth: number

    视域的内容的宽度。

    如果 scrollEnabled 为 true, 则视域的 contentWidth 为水平滚动定义限制, 且视域的实际宽度定义可见的内容量。

    要在内容中水平滚动, 请在 0 和 contentWidth - width 之间更改 scrollH

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    contentHeight: number

    视域的内容的高度。

    如果 scrollEnabled 为 true,则视域的 contentHeight 为垂直滚动定义限制, 且视域的实际高度定义可见的内容量。要在内容中垂直滚动,请在 0 和 contentHeight - height 之间更改 scrollV

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    scrollH: number

    可视区域水平方向起始点。

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    scrollV: number

    可视区域竖直方向起始点。

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    scrollEnabled: boolean

    是否启用容器滚动。如果为 true,则将子项剪切到视区的边界,配合设置scrollH和scrollV属性将能滚动视区。 如果为 false,则容器子代会从容器边界扩展过去,而设置scrollH和scrollV也无效。默认false。

    false
    

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    includeInLayout: boolean

    指定此组件是否包含在父容器的布局中。若为false,则父级容器在测量和布局阶段都忽略此组件。 注意,visible属性与此属性不同,设置visible为false,父级容器仍会对其布局。

    true
    

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    left: any

    距父级容器离左边距离。

    NaN
    

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    right: any

    距父级容器右边距离。

    NaN
    

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    top: any

    距父级容器顶部距离。

    NaN
    

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    bottom: any

    距父级容器底部距离。

    NaN
    

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    horizontalCenter: any

    在父级容器中距水平中心位置的距离。

    NaN
    

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    verticalCenter: any

    在父级容器中距竖直中心位置的距离。

    NaN
    

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    percentWidth: number

    相对父级容器宽度的百分比。

    NaN
    

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    percentHeight: number

    相对父级容器高度的百分比。

    NaN
    

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    explicitWidth: number

    外部显式指定的宽度。

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    explicitHeight: number

    外部显式指定的高度。

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    minWidth: number

    组件的最小宽度,此属性设置为大于maxWidth的值时无效。同时影响测量和自动布局的尺寸。

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    maxWidth: number

    组件的最大高度。同时影响测量和自动布局的尺寸。

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    minHeight: number

    组件的最小高度,此属性设置为大于maxHeight的值时无效。同时影响测量和自动布局的尺寸。

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    maxHeight: number

    组件的最大高度,同时影响测量和自动布局的尺寸。

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    • 标记提交过需要延迟应用的属性,以便在稍后屏幕更新期间调用该组件的 commitProperties() 方法。

      这是一个很有用的机制,可将组件更改延迟到稍后屏幕更新时进行处理,从而消除了重复的工作。

      例如,要更改文本颜色和大小,如果在更改颜色后立即进行更新,然后在设置大小后再更新大小,就有些浪费。 同时更改两个属性后再使用新的大小和颜色一次性呈示文本,效率会更高。

      很少调用 Invalidation 方法。通常,在组件上设置属性会自动调用合适的 invalidation 方法。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 由布局逻辑用于通过调用 commitProperties() 方法来验证组件的属性。 通常,子类应覆盖 commitProperties() 方法,而不是覆盖此方法。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 标记提交过需要验证组件尺寸,以便在稍后屏幕更新期间调用该组件的 measure() 方法。

      Invalidation 是一个很有用的机制,可将组件更改延迟到稍后屏幕更新时进行处理,从而消除了重复的工作。

      例如,要更改文本和字体大小,如果在更改文本后立即进行更新,然后在设置大小后再更新大小,就有些浪费。 更改两个属性后再使用新的大小一次性呈示文本,效率会更高。

      很少调用 Invalidation 方法。通常,在组件上设置属性会自动调用合适的 invalidation 方法。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 验证组件的尺寸。

      Parameters

      • Optionalrecursive: boolean

        如果为 true,则调用对象子项的此方法。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 标记需要验证显示列表,以便在稍后屏幕更新期间调用该组件的 updateDisplayList() 方法。

      Invalidation 是一个很有用的机制,可将组件更改延迟到稍后屏幕更新时进行处理,从而消除了重复的工作。

      例如,要更改宽度和高度,如果在更改宽度后立即更新组件,然后在设置新高度后再次更新组件,就有些浪费。 更改两个属性后再使用新的大小一次性呈示组件,效率会更高。

      很少调用 Invalidation 方法。通常,在组件上设置属性会自动调用合适的 invalidation 方法。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 验证并更新此对象的属性和布局,如果需要的话重绘对象。

      通常只有当脚本执行完毕后,才会处理要求进行大量计算的处理属性。

      例如,对 width 属性的设置可能会延迟,因为此设置需要重新计算这些对象的子项或父项的宽度。 如果脚本多次设置了 width 属性,则延迟处理可防止进行多次处理。此方法允许您手动覆盖此行为。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 设置元素的布局大小。这是元素在屏幕上进行绘制时所用的大小。

      如果 width 和/或 height 参数尚未指定 (NaN)),则 EUI 会将该元素的布局大小设置为首选宽度和/或首选高度。

      请注意,调用 setLayoutBoundSize() 方法会影响布局位置,因此请在调用 setLayoutBoundSize() 之后再调用 setLayoutBoundPosition()。

      Parameters

      • layoutWidth: number

        元素的布局宽度。

      • layoutHeight: number

        元素的布局高度。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 设置元素在屏幕上进行绘制时所用的布局坐标。

      请注意,调用 setLayoutBoundSize() 方法会影响布局位置,因此请在调用 setLayoutBoundSize() 之后再调用 setLayoutBoundPosition()。

      Parameters

      • x: number

        边框左上角的 X 坐标。

      • y: number

        边框左上角的 Y 坐标。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 组件的布局尺寸,常用于父级的updateDisplayList()方法中。

      按照:布局尺寸>外部显式设置尺寸>测量尺寸 的优先级顺序返回尺寸。

      注意此方法返回值已经包含scale和rotation。

      Parameters

      • bounds: Rectangle

        可以放置结果的Rectangle实例。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 获取组件的首选尺寸,常用于父级的measure()方法中。

      按照:外部显式设置尺寸>测量尺寸 的优先级顺序返回尺寸。

      注意此方法返回值已经包含scale和rotation。

      Parameters

      • bounds: Rectangle

        可以放置结果的Rectangle实例。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN