Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UIToggleGroup

TODO chidren acttive change need observe !!!

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly entity

entity: Entity2D

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

  • Align: number
  • Layout: number
  • Low: number
  • Physics: number
  • Render: number
  • Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

    • (...args: any[]): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Accessors

active

  • get active(): boolean
  • set active(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

activeInHierarchy

  • get activeInHierarchy(): boolean

  • 在场景树中是否active

    readonly
    memberof

    Component

    Returns boolean

allowSwitchOff

  • get allowSwitchOff(): boolean
  • set allowSwitchOff(val: boolean): void

  • 默认值为false，UIToggleGroup下属的UIToggle是否允许取消激活态。

    memberof

    UIToggleGroup

    Returns boolean

  • 默认值为false，UIToggleGroup下属的UIToggle是否允许取消激活态。

    Parameters

    • val: boolean

    Returns void

deafaultActiveToggle

  • get deafaultActiveToggle(): UIToggle
  • set deafaultActiveToggle(val: UIToggle): void

  • 默认值为undefined，UIToggleGroup中默认处于激活态的UIToggle。

    memberof

    UIToggleGroup

    Returns UIToggle

  • 默认值为undefined，UIToggleGroup中默认处于激活态的UIToggle。

    Parameters

    Returns void

toggleList

  • UIToggleGroup控制的UIToggle数组

    readonly
    memberof

    UIToggleGroup

    Returns UIToggle[]

useStaticIndex

  • get useStaticIndex(): boolean
  • set useStaticIndex(val: boolean): void

  • 默认值为false，UIToggleGroup在onStart初始化index后，后续会不会自动更新index

    memberof

    UIToggleGroup

    Returns boolean

  • 默认值为false，UIToggleGroup在onStart初始化index后，后续会不会自动更新index

    Parameters

    • val: boolean

    Returns void

Methods

addToggle

  • 添加UIToggle进入UIToggleGroup

    memberof

    UIToggleGroup

    Parameters

    Returns void

checkedChange

  • 取消激活ToggleGroup中除toggle外的其他Toggle

    memberof

    UIToggleGroup

    Parameters

    Returns void

destroy

  • destroy(): void

  • Returns void

getActiveToggle

  • 返回当前ToggleGroup激活状态的Toggle

    memberof

    UIToggleGroup

    Returns UIToggle

getTypeName

  • getTypeName(): string

isDetached

  • isDetached(): boolean

  • Returns boolean

removeToggle

  • 删除UIToggleGroup中的UIToggle

    memberof

    UIToggleGroup

    Parameters

    Returns void

resetProperties

  • resetProperties(): void

setIndex

  • setIndex(index: number): boolean

  • 根据index，激活ToggleGroup里面Toggle，返回是否成功激活

    memberof

    UIToggleGroup

    Parameters

    • index: number

    Returns boolean

Generated using TypeDoc