Winter Cardinal UI - v0.457.0 / DMenus

Class: DMenus

Table of contents

Constructors

• constructor

Properties

• CREATORS
• CREATOR_DEFAULT
• MENU_CREATOR

Methods

• addItemCreator
• newItem
• newItemOf
• newItems
• newItemsOf
• newMenu
• setItemCreatorDefault
• setMenuCreator

Constructors

constructor

• new DMenus(): DMenus

Returns

DMenus

Properties

CREATORS

▪ Static Protected CREATORS: DMenuItemCreator[] = []

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:18

---

CREATOR_DEFAULT

▪ Static Protected CREATOR_DEFAULT: null | DMenuItemCreator = null

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:19

---

MENU_CREATOR

▪ Static Protected Optional MENU_CREATOR: DMenuMenuCreator

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:20

Methods

addItemCreator

▸ addItemCreator(creator): void

Parameters

Name	Type
creator	DMenuItemCreator

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:22

---

newItem

▸ newItem<VALUE>(options, sticky): null | DisplayObject

Type parameters

Name
VALUE

Parameters

Name	Type
options	DMenuItemOptionsUnion<VALUE>
sticky	boolean

Returns

null | DisplayObject

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:52

---

newItemOf

▸ newItemOf<VALUE>(creators, creatorDefault, options, sticky): null | DisplayObject

Type parameters

Name
VALUE

Parameters

Name	Type
creators	DMenuItemCreator[]
creatorDefault	null | DMenuItemCreator
options	DMenuItemOptionsUnion<VALUE>
sticky	boolean

Returns

null | DisplayObject

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:34

---

newItems

▸ newItems<VALUE>(parent, items, sticky): void

Type parameters

Name
VALUE

Parameters

Name	Type
parent	Container
items	(undefined | null | DisplayObject | DMenuItemOptionsUnion<VALUE>)[]
sticky	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:82

---

newItemsOf

▸ newItemsOf<VALUE>(creator, parent, items, sticky): void

Type parameters

Name
VALUE

Parameters

Name	Type
creator	Object
creator.newItem	(options: DMenuItemOptionsUnion<VALUE>, sticky: boolean) => null | DisplayObject
parent	Container
items	(undefined | null | DisplayObject | DMenuItemOptionsUnion<VALUE>)[]
sticky	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:59

---

newMenu

▸ newMenu<VALUE>(options?): DMenu<VALUE, DThemeMenu, DMenuOptions<VALUE, DThemeMenu>>

Type parameters

Name
VALUE

Parameters

Name	Type
options?	DMenuOptions<VALUE, DThemeMenu>

Returns

DMenu<VALUE, DThemeMenu, DMenuOptions<VALUE, DThemeMenu>>

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:90

---

setItemCreatorDefault

▸ setItemCreatorDefault(creator): void

Parameters

Name	Type
creator	DMenuItemCreator

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:26

---

setMenuCreator

▸ setMenuCreator(creator): void

Parameters

Name	Type
creator	DMenuMenuCreator

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menus.ts:30

Edit this page.