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

    范围选取组件,该组件包含一个值和这个值所允许的最大最小约束范围。

    value属性的值永远被限制于当前的minimum和 maximum之间,并且minimum和 maximum永远按照固定的顺序排列, 即(minimum <= value <= maximum) 为真。

    如果snapInterval属性的值不是0,那么value的值也会被snapInterval所约束。

    Egret 2.4

    eui 1.0

    Web

    extension/eui/components/supportClasses/RangeExample.ts

    zh_CN

    Hierarchy (View Summary)

    Index
    $Component: Object
    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

    • get hostComponentKey(): string

      主机组件标识符。用于唯一确定一个组件的名称。通常用于在主题中查询默认皮肤名。

      Returns string

      null
      

      Theme#getSkinName()

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set hostComponentKey(value: string): void

      Parameters

      • value: string

      Returns void

    • get skinName(): any

      皮肤标识符。有效值可为:皮肤类定义,皮肤类名,皮肤实例,EXML文件内容,或外部EXML文件路径,

      Returns any

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set skinName(value: any): void

      Parameters

      • value: any

      Returns void

    • get enabled(): boolean

      组件是否可以接受用户交互。 将 enabled 属性设置为 false 后, 组件会自动禁用触摸事件(将 touchEnabled 和 touchChildren 同时设置为 false), 部分组件可能还会将皮肤的视图状态设置为"disabled",使其所有子项的颜色变暗。

      Returns boolean

      true
      

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set enabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get currentState(): string

      组件的当前视图状态。显式设置此属性, 将采用显式设置的值去更新皮肤状态,而忽略组件内部 getCurrentState() 方法返回的值。

      将其设置为 "" 或 null 可将取消组件外部显式设置的视图状态名称,从而采用内部 getCurrentState() 方法返回的状态。

      Returns string

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set currentState(value: string): void

      Parameters

      • value: string

      Returns void

    • get snapInterval(): number

      snapInterval 属性定义 value 属性的有效值。 如果为非零,则有效值为 minimum 与此属性的整数倍数之和,且小于或等于 maximum。

      例如,如果 minimum 为 10,maximum 为 20,而此属性为 3,则可能的有效值为 10、13、16、19 和 20.

      如果此属性的值为零,则仅会将有效值约束到介于 minimum 和 maximum 之间(包括两者)。

      Returns number

      1
      

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set snapInterval(value: number): void

      Parameters

      • value: number

      Returns void

    • 关联一个对象到逻辑组件的指定皮肤部件上。通常您不需要手动调用此方法,当使用EXML文件作为组件皮肤,此方法将会被自动调用。 在运行时,EXML文件内声明的id名称将作为此方法的partName参数,而id所对应的节点对象,将作为此方法的instance参数被依次传入。

      Parameters

      • partName: string

        皮肤部件名称

      • instance: any

        皮肤部件实例

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 添加皮肤部件时调用。 您无需直接调用此方法。 EUI 会在调用 setSkinPart()方法时自动调用此方法。

      子类覆盖此方法,以在皮肤部件第一次附加时对其执行一些初始化操作,例如添加事件监听,赋值缓存的属性值等。

      Parameters

      • partName: string

        要附加的皮肤部件名称。

      • instance: any

        要附加的皮肤部件实例。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 正删除外观部件的实例时调用。 您无需直接调用此方法。 EUI 会在调用 setSkinPart()方法时自动调用此方法。

      子类覆盖此方法,以在皮肤部件从逻辑组件卸载时对其执行一些清理操作,例如移除事件监听,断开缓存的引用等。

      Parameters

      • partName: string

        要卸载的皮肤部件名称

      • instance: any

        要卸载的皮肤部件实例

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 标记组件当前的视图状态失效,调用此方法后,子类应该覆盖 getCurrentState() 方法来返回当前的视图状态名称。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 子类覆盖此方法可以执行一些初始化子项操作。此方法仅在组件第一次添加到舞台时回调一次。 请务必调用super.createChildren()以完成父类组件的初始化

      Returns void

      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

    • 返回 minimum 与最接近 value 的 interval 的整数倍数之和, 除非 value 接近最大值限制的时候会返回 maximum。

      如果 interval 等于 0,则会将该值剪裁到限制的最小值和最大值。

      范围的有效值由 minimum 属性与 interval 的倍数之和决定, 与此同时也要小于等于 maximum 属性。 最大值不能是 snapInterval 属性的倍数。

      例如,如果 minimum 等于 1,maximum 等于 6,且 snapInterval 等于 3, 则 Range 的有效值有 1、2、5、6。

      类似地,如果 minimum 等于 2,maximum 等于 9, 且 snapInterval 等于 1.5,则 Range 的有效值有 2、3.5、5、6.5、8 和 9。

      Parameters

      • value: number

        输入值。

      • interval: number

        snapInterval 的值,或 snapInterval 的整数倍数。

      Returns number

      最近接输入值的有效值。

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 设置当前值。

      此方法假定调用者已经使用了 nearestValidValue() 方法来约束 value 参数。

      Parameters

      • value: number

        value属性的新值

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 更新皮肤部件(通常为滑块)的大小和可见性。

      子类覆盖此方法以基于 minimum、maximum 和 value 属性更新滑块的大小、位置和可见性。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN