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

    TabBar 类显示一组相同的选项卡。一次可以选择一个选项卡,且默认情况下选择第一个选项卡。

    该组选项卡由 dataProvider 属性定义。 每个选项卡的外观由 ItemRenderer 定义。

    可以使用 TabBar 控件设置 ViewStack 容器的活动子代,如下例所示:

          
          
             
             
             
          
    

    Egret 2.4

    eui 1.0

    Web

    extension/eui/components/TabBarExample.ts

    zh_CN

    Hierarchy (View Summary)

    Index
    $DataGroup: Object
    $Group: Object
    states: State[]

    为此组件定义的视图状态。

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    currentState: string

    Component#currentState

    Egret 2.4

    eui 1.0

    Web

    hasState: (stateName: string) => boolean

    Skin#hasState()

    Egret 2.4

    eui 1.0

    Web

    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

    NO_SELECTION: number = -1

    未选中任何项时的索引值

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    NO_PROPOSED_SELECTION: number = -2

    未设置缓存选中项的值

    Egret 2.4

    eui 1.0

    Web

    zh_CN

    • get itemRenderer(): any

      用于数据项目的项呈示器。您应该直接为此属性赋值自定义类的类定义,而不是一个实例。注意:该类必须实现 IItemRenderer 接口。
      rendererClass获取顺序:itemRendererFunction > itemRenderer > 默认ItemRenerer。

      Returns any

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set itemRenderer(value: any): void

      Parameters

      • value: any

      Returns void

    • get itemRendererSkinName(): any

      条目渲染器的可选皮肤标识符。在实例化itemRenderer时,若其内部没有设置过skinName,则将此属性的值赋值给它的skinName。 注意:若 itemRenderer 不是 Component 的子类,则此属性无效。

      Returns any

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set itemRendererSkinName(value: any): void

      Parameters

      • value: any

      Returns void

    • get itemRendererFunction(): (item: any) => any

      为某个特定数据项返回一个项呈示器类定义的函数。 rendererClass获取顺序:itemRendererFunction > itemRenderer > 默认ItemRenerer。

      Returns (item: any) => any

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set itemRendererFunction(value: (item: any) => any): void

      Parameters

      • value: (item: any) => any

      Returns void

    • get numElements(): number

      布局元素子项的数量。

      Returns number

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set elementsContent(value: DisplayObject[]): void

      此属性通常在 EXML 的解析器中调用,便于快速添加多个子项。

      Parameters

      • value: DisplayObject[]

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • get contentWidth(): number

      Returns number

      IViewport#contentWidth

      Egret 2.4

      eui 1.0

      Web

    • get contentHeight(): number

      Returns number

      IViewport#contentHeight

      Egret 2.4

      eui 1.0

      Web

    • get scrollEnabled(): boolean

      Returns boolean

      IViewport#scrollEnabled

      Egret 2.4

      eui 1.0

      Web

    • set scrollEnabled(value: boolean): void

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

      Parameters

      • value: boolean

      Returns void

      false
      

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • get scrollH(): number

      Returns number

      IViewport#scrollH

      Egret 2.4

      eui 1.0

      Web

    • set scrollH(value: number): void

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

      Parameters

      • value: number

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • get scrollV(): number

      Returns number

      IViewport#scrollV

      Egret 2.4

      eui 1.0

      Web

    • set scrollV(value: number): void

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

      Parameters

      • value: number

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • get touchThrough(): boolean

      触摸组件的背景透明区域是否可以穿透。设置为true表示可以穿透,反之透明区域也会响应触摸事件。默认 false。

      Returns boolean

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set touchThrough(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get requireSelection(): boolean

      如果为 true,则控件中必须含有选中的数据项目。 如果该值为 true,则始终将 selectedIndex 属性设置为 0 和 (dataProvider.length - 1) 之间的一个值。

      Returns boolean

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set requireSelection(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get selectedIndex(): number

      选中项目的基于 0 的索引。 或者如果未选中项目,则为-1。设置 selectedIndex 属性会取消选择当前选定的项目并选择指定索引位置的数据项目。

      这个值会之中在-1到(dataProvider.length - 1)之间。如果从该组件中删除一个低于 selectedIndex的值,则selectedIndex也会相应的调节选定的索引。

      如果删除的项为当前选中项,则该值会变为:

      • -1: 如果 requireSelection == false 或者已经没有剩余项目。
      • 0: 如果 requireSelection == true 并且当前至少还有一个剩余项目。

      当用户通过与控件交互来更改 selectedIndex 属性时,此控件将分派 change 和 changing 事件。 当以编程方式更改 selectedIndex 属性的值时,此控件不分派 change 和 changing 事件。

      Returns number

      -1
      

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set selectedIndex(value: number): void

      Parameters

      • value: number

      Returns void

    • get selectedItem(): any

      当前已选中的项目。设置此属性会取消选中当前选定的项目并选择新指定的项目。

      如果设置的selectedItem不在当前列表里那么selectedItem将被设置 为undefined

      如果选择项目被移除,那选择项会被设置为:

      • undefined: 如果 requireSelection == false 或者已经没有剩余项。
      • 第一项: 当 requireSelection == true 并且列表中还至少存有一项.

      当用户通过与控件交互来更改 selectedItem 属性时,此控件将分派 change 和 changing 事件。 当以编程方式更改 selectedItem 属性的值时,此控件不分派 change 和 changing 事件。

      Returns any

      undefined
      

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • set selectedItem(value: any): void

      Parameters

      • value: any

      Returns void

    • 在支持虚拟布局的容器中,设置容器内可见的子元素索引范围。此方法在不支持虚拟布局的容器中无效。 通常在即将重新布局子项之前会被调用一次,容器覆盖此方法提前释放已经不可见的子元素。

      Parameters

      • startIndex: number

        可视元素起始索引(包括)

      • endIndex: number

        可视元素结束索引(包括)

      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

    • 设置 contentWidthcontentHeight 属性。 此方法由布局来调用,开发者应该在布局类的 updateDisplayList() 方法中对其进行调用。

      Parameters

      • width: number

        contentWidth 的新值。

      • height: number

        contentHeight 的新值。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 设置测量结果。

      Parameters

      • width: number

        测量宽度

      • height: number

        测量高度

      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

    • 验证组件的尺寸。

      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

    • 由程序或者用户设置选中项。

      Parameters

      • value: number

        索引值。

      • OptionaldispatchChangeEvent: boolean

        当索引值发生改变,且该参数为true的时候,组件派发出一个“change”事件。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 由程序或用户设置选中项数据源。

      Parameters

      • value: any

        要选中的项。

      • dispatchChangeEvent: boolean = false

        当索引值发生改变,且该参数为true的时候,组件派发出一个“change”事件。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 选中或取消选中项目时调用。子类必须覆盖此方法才可设置选中项。

      Parameters

      • index: number

        已选中的项目索引。

      • selected: boolean

        true为选中,false取消选中

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 提交选中项属性。该方法会派发一个“changing”事件,如果该事件没有被阻止, 该方法将会提交选择项病根据参数派发“change”事件。

      Parameters

      • dispatchChangedEvents: boolean = true

        是否派发一个“changed”事件。

      Returns boolean

      true 表示提交成功, false表示被取消

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 仅调整选中索引值而不更新选中项,即在提交属性阶段itemSelected方法不会被调用,也不会触发changing和change事件。

      Parameters

      • newIndex: number

        新索引。

      • add: boolean = false

        如果已将项目添加到组件,则为true;如果已删除项目,则为false

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 数据源刷新时触发。此方法不从组件外部调用,仅用于编写自定义组件时,子类覆盖父类的此方法,以便在数据源发生改变时,自动执行一些额外的根据数据刷新视图的操作。

      Returns void

      Egret 2.4

      eui 1.0

      Web

      zh_CN

    • 侦听项呈示器TouchEvent.TOUCH_CANCEL事件的方法。触发时会取消对舞台TouchEvent.TOUCH_ENDTouchEvent.TOUCH_TAP事件的侦听。

      Parameters

      • event: TouchEvent

        事件TouchEvent的对象。

      Returns void

      Egret 3.0.1

      eui 1.0

      Web

      zh_CN