Winter Cardinal UI - v0.457.0 / DDialogLayered

Class: DDialogLayered<VALUE, THEME, OPTIONS>

A dialog with a header, a content and a footer.

Type parameters

Name Type
VALUE void
THEME extends DThemeDialogLayered = DThemeDialogLayered
OPTIONS extends DDialogLayeredOptions<VALUE, THEME> = DDialogLayeredOptions<VALUE, THEME>

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new DDialogLayered<VALUE, THEME, OPTIONS>(options?): DDialogLayered<VALUE, THEME, OPTIONS>

Type parameters

Name Type
VALUE void
THEME extends DThemeDialogLayered = DThemeDialogLayered
OPTIONS extends DDialogLayeredOptions<VALUE, THEME, any> = DDialogLayeredOptions<VALUE, THEME, any>

Parameters

Name Type
options? OPTIONS

Returns

DDialogLayered<VALUE, THEME, OPTIONS>

Inherited from

DDialog.constructor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:798

Properties

_accessibleActive

• _accessibleActive: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

DDialog._accessibleActive

Defined in

node_modules/pixi.js/pixi.js.d.ts:8559


_accessibleDiv

• _accessibleDiv: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

DDialog._accessibleDiv

Defined in

node_modules/pixi.js/pixi.js.d.ts:8565


_align

• Protected _align: null | UtilAttachAlign

Inherited from

DDialog._align

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:134


_alwaysOnTop

• Protected _alwaysOnTop: boolean

Inherited from

DDialog._alwaysOnTop

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:130


_animation

• Protected Optional _animation: null | DAnimation<DBase<DThemeBase, DBaseOptions<DThemeBase, any>>>

Inherited from

DDialog._animation

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:125


_auto

• Protected _auto: DBaseAutoSet

Inherited from

DDialog._auto

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:777


_background

• Protected _background: DBackgroundStateAware

Inherited from

DDialog._background

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:788


_border

• Protected _border: DBorderStateAware

Inherited from

DDialog._border

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:789


_bounds

• _bounds: Bounds

The bounds object, this is used to calculate and store the bounds of the displayObject.

Member

PIXI.DisplayObject#_bounds

Inherited from

DDialog._bounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:8681


_boundsID

• Protected _boundsID: number

Flags the cached bounds as dirty.

Member

PIXI.DisplayObject#_boundsID

Inherited from

DDialog._boundsID

Defined in

node_modules/pixi.js/pixi.js.d.ts:8694


_boundsRect

• Protected _boundsRect: Bounds

Cache of this display-object’s bounds-rectangle.

Member

PIXI.DisplayObject#_boundsRect

Inherited from

DDialog._boundsRect

Defined in

node_modules/pixi.js/pixi.js.d.ts:8701


_clearType

• Protected _clearType: number

Inherited from

DDialog._clearType

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:791


_closeOn

• Protected _closeOn: number

Inherited from

DDialog._closeOn

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:126


_content

• Protected Optional _content: DDialogLayeredContent<DThemeDialogLayeredContent, DDialogLayeredContentOptions<DThemeDialogLayeredContent>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:98


_corner

• Protected _corner: DCorner

Inherited from

DDialog._corner

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:775


_cursor

• Protected Optional _cursor: DStateAwareOrValueMightBe<string>

Inherited from

DDialog._cursor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:796


_destroyed

• Protected _destroyed: boolean

If the object has been destroyed via destroy(). If true, it should not be used.

Member

PIXI.DisplayObject#_destroyed

Inherited from

DDialog._destroyed

Defined in

node_modules/pixi.js/pixi.js.d.ts:8722


_enabledFilters

• Protected _enabledFilters: Filter[]

Currently enabled filters

Member

PIXI.DisplayObject#_enabledFilters

Inherited from

DDialog._enabledFilters

Defined in

node_modules/pixi.js/pixi.js.d.ts:8675


_focused

• Protected Optional _focused: null | DFocusable

Inherited from

DDialog._focused

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:127


• Protected Optional _footer: null | DDialogLayeredFooter<DThemeDialogLayeredFooter, DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:99


_gesture

• Protected _gesture: DDialogGesture<DDialogLayered<VALUE, THEME, OPTIONS>>

Inherited from

DDialog._gesture

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:137


_header

• Protected Optional _header: null | DDialogLayeredHeader<DThemeDialogLayeredHeader, DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:97


_lastDownPoint

• Protected Optional _lastDownPoint: Point

Inherited from

DDialog._lastDownPoint

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:795


_lastSortedIndex

• Protected _lastSortedIndex: number

Which index in the children array the display component was before the previous zIndex sort. Used by containers to help sort objects with the same zIndex, by using previous array index as the decider.

Member

PIXI.DisplayObject#_lastSortedIndex

Inherited from

DDialog._lastSortedIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:8644


_layer

• Protected _layer: null | DApplicationLayerLike

Inherited from

DDialog._layer

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:138


_layout

• Protected Optional _layout: DLayoutVertical<DThemeLayoutVertical, DLayoutVerticalOptions<DThemeLayoutVertical>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:95


_localBounds

• _localBounds: Bounds

Local bounds object, swapped with _bounds when using getLocalBounds().

Member

PIXI.DisplayObject#_localBounds

Inherited from

DDialog._localBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:8687


_localBoundsRect

• Protected _localBoundsRect: Bounds

Cache of this display-object’s local-bounds rectangle.

Member

PIXI.DisplayObject#_localBoundsRect

Inherited from

DDialog._localBoundsRect

Defined in

node_modules/pixi.js/pixi.js.d.ts:8708


_mask

• Protected _mask: null | Container | MaskData

The original, cached mask of the object.

Member

PIXI.DisplayObject#_mask

Inherited from

DDialog._mask

Defined in

node_modules/pixi.js/pixi.js.d.ts:8715


_mode

• Protected _mode: DDialogMode

Inherited from

DDialog._mode

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:129


_onParentChildAddedBound

• Protected Optional _onParentChildAddedBound: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

DDialog._onParentChildAddedBound

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:131


_onPrerenderBound

• Protected _onPrerenderBound: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

DDialog._onPrerenderBound

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:133


_opener

• Protected Optional _opener: null | DDialogOpener

Inherited from

DDialog._opener

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:135


_options

• Protected _options: undefined | OPTIONS

Inherited from

DDialog._options

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:771


_outline

• Protected _outline: DOutline

Inherited from

DDialog._outline

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:790


_overlay

• Protected _overlay: UtilOverlay

Inherited from

DDialog._overlay

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:128


_padding

• Protected _padding: DPadding

Inherited from

DDialog._padding

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:774


_promise

• Protected Optional _promise: Promise<VALUE>

Inherited from

DDialog._promise

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:121


_reflowable

• Protected _reflowable: DBaseReflowableContainer

Inherited from

DDialog._reflowable

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:794


_reject

• Protected Optional _reject: (reason?: any) => void

Type declaration

▸ (reason?): void

Parameters
Name Type
reason? any
Returns

void

Inherited from

DDialog._reject

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:123


_resolve

• Protected Optional _resolve: (value: VALUE | PromiseLike<VALUE>) => void

Type declaration

▸ (value): void

Parameters
Name Type
value VALUE | PromiseLike<VALUE>
Returns

void

Inherited from

DDialog._resolve

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:122


_shortcuts

• Protected Optional _shortcuts: UtilKeyboardEventShortcut[]

Inherited from

DDialog._shortcuts

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:792


_snippet

• Protected _snippet: DBaseSnippetContainer

Inherited from

DDialog._snippet

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:793


_sticky

• Protected _sticky: boolean

Inherited from

DDialog._sticky

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:132


_tempDisplayObjectParent

• Protected _tempDisplayObjectParent: Container

Member

Inherited from

DDialog._tempDisplayObjectParent

Defined in

node_modules/pixi.js/pixi.js.d.ts:8795


_title

• Protected _title: string

Inherited from

DDialog._title

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:787


_zIndex

• Protected _zIndex: number

The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.

Member

PIXI.DisplayObject#_zIndex

Inherited from

DDialog._zIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:8652


accessible

• accessible: boolean

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

Member

Memberof

PIXI.DisplayObject#

Inherited from

DDialog.accessible

Defined in

node_modules/pixi.js/pixi.js.d.ts:8538


accessibleChildren

• accessibleChildren: boolean

Setting to false will prevent any children inside this container to be accessible. Defaults to true.

Member

Memberof

PIXI.DisplayObject#

Default

true

Inherited from

DDialog.accessibleChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8592


accessibleHint

• accessibleHint: string

Sets the aria-label attribute of the shadow div

Member

Memberof

PIXI.DisplayObject#

Inherited from

DDialog.accessibleHint

Defined in

node_modules/pixi.js/pixi.js.d.ts:8553


accessiblePointerEvents

• accessiblePointerEvents: string

Specify the pointer-events the accessible div will use Defaults to auto.

Member

Memberof

PIXI.DisplayObject#

Default

'auto'

Inherited from

DDialog.accessiblePointerEvents

Defined in

node_modules/pixi.js/pixi.js.d.ts:8583


accessibleTitle

• accessibleTitle: string

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to ‘displayObject [tabIndex]’

Member

Memberof

PIXI.DisplayObject#

Inherited from

DDialog.accessibleTitle

Defined in

node_modules/pixi.js/pixi.js.d.ts:8546


accessibleType

• accessibleType: string

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Member

Memberof

PIXI.DisplayObject#

Default

'button'

Inherited from

DDialog.accessibleType

Defined in

node_modules/pixi.js/pixi.js.d.ts:8574


alpha

• alpha: number

The opacity of the object.

Member

PIXI.DisplayObject#alpha

Inherited from

DDialog.alpha

Defined in

node_modules/pixi.js/pixi.js.d.ts:8605


angle

• angle: number

The angle of the object in degrees. ‘rotation’ and ‘angle’ have the same effect on a display object; rotation is in radians, angle is in degrees.

Member

Inherited from

DDialog.angle

Defined in

node_modules/pixi.js/pixi.js.d.ts:8882


buttonMode

• buttonMode: boolean

If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive Setting this changes the ‘cursor’ property to 'pointer'.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.buttonMode = true;

Member

Memberof

PIXI.DisplayObject#

Inherited from

DDialog.buttonMode

Defined in

node_modules/pixi.js/pixi.js.d.ts:8964


cacheAsBitmap

• cacheAsBitmap: boolean

Set this to true if you want this display object to be cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to false

IMPORTANT GOTCHA - Make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

Member

Memberof

PIXI.DisplayObject#

Inherited from

DDialog.cacheAsBitmap

Defined in

node_modules/pixi.js/pixi.js.d.ts:8991


children

• Readonly children: DisplayObject[]

The array of children of this container.

Member

PIXI.Container#children

Inherited from

DDialog.children

Defined in

node_modules/pixi.js/pixi.js.d.ts:8327


cursor

• cursor: string

This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.cursor = 'wait';

See

https://developer.mozilla.org/en/docs/Web/CSS/cursor

Member

Memberof

PIXI.DisplayObject#

Inherited from

DDialog.cursor

Defined in

node_modules/pixi.js/pixi.js.d.ts:8978


filterArea

• filterArea: Rectangle

The area the filter is applied to. This is used as more of an optimization rather than figuring out the dimensions of the displayObject each frame you can set this rectangle.

Also works as an interaction mask.

Member

PIXI.DisplayObject#filterArea

Inherited from

DDialog.filterArea

Defined in

node_modules/pixi.js/pixi.js.d.ts:8661


filters

• filters: Filter[]

Sets the filters for the displayObject.

Member

PIXI.DisplayObject#filters

Inherited from

DDialog.filters

Defined in

node_modules/pixi.js/pixi.js.d.ts:8669


hitArea

• hitArea: IHitArea

Interaction shape. Children will be hit first, then this shape will be checked. Setting this will cause this shape to be checked in hit tests rather than the displayObject’s bounds.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.hitArea = new PIXI.Rectangle(0, 0, 100, 100);

Member

Memberof

PIXI.DisplayObject#

Inherited from

DDialog.hitArea

Defined in

node_modules/pixi.js/pixi.js.d.ts:8952


interactive

• interactive: boolean

Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless interactive is set to true.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.on('tap', (event) => {
   //handle event
});

Member

Memberof

PIXI.DisplayObject#

Inherited from

DDialog.interactive

Defined in

node_modules/pixi.js/pixi.js.d.ts:8940


interactiveChildren

• interactiveChildren: boolean

Determines if the children to the displayObject can be clicked/touched Setting this to false allows PixiJS to bypass a recursive hitTest function

Member

Memberof

PIXI.Container#

Inherited from

DDialog.interactiveChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8518


isMask

• isMask: boolean

Does any other displayObject use this object as a mask?

Member

PIXI.DisplayObject#isMask

Inherited from

DDialog.isMask

Defined in

node_modules/pixi.js/pixi.js.d.ts:8732


isSprite

• isSprite: boolean

used to fast check if a sprite is.. a sprite!

Member

PIXI.DisplayObject#isSprite

Inherited from

DDialog.isSprite

Defined in

node_modules/pixi.js/pixi.js.d.ts:8727


localTransform

• Readonly localTransform: Matrix

Current transform of the object based on local factors: position, scale, other stuff.

Member

Inherited from

DDialog.localTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8840


mask

• mask: null | Container | MaskData

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilities shape clipping. To remove a mask, set this property to null.

For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.

Example

const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
graphics.drawRect(50, 250, 100, 100);
graphics.endFill();

const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;

Todo

At the moment, PIXI.CanvasRenderer doesn’t support PIXI.Sprite as mask.

Member

Inherited from

DDialog.mask

Defined in

node_modules/pixi.js/pixi.js.d.ts:8918


name

• name: string

The instance name of the object.

Memberof

PIXI.DisplayObject#

Member

name

Inherited from

DDialog.name

Defined in

node_modules/pixi.js/pixi.js.d.ts:8998


parent

• parent: Container

The display object container that contains this display object.

Member

PIXI.DisplayObject#parent

Inherited from

DDialog.parent

Defined in

node_modules/pixi.js/pixi.js.d.ts:8629


pivot

• pivot: ObservablePoint

The pivot point of the displayObject that it rotates around. Assignment by value since pixi-v4.

Member

Inherited from

DDialog.pivot

Defined in

node_modules/pixi.js/pixi.js.d.ts:8861


renderable

• renderable: boolean

Can this object be rendered, if false the object will not be drawn but the updateTransform methods will still be called.

Only affects recursive calls from parent. You can ask for bounds manually.

Member

PIXI.DisplayObject#renderable

Inherited from

DDialog.renderable

Defined in

node_modules/pixi.js/pixi.js.d.ts:8623


rotation

• rotation: number

The rotation of the object in radians. ‘rotation’ and ‘angle’ have the same effect on a display object; rotation is in radians, angle is in degrees.

Member

Inherited from

DDialog.rotation

Defined in

node_modules/pixi.js/pixi.js.d.ts:8875


sortDirty

• sortDirty: boolean

Should children be sorted by zIndex at the next updateTransform call. Will get automatically set to true if a new child is added, or if a child’s zIndex changes.

Member

PIXI.Container#sortDirty

Inherited from

DDialog.sortDirty

Defined in

node_modules/pixi.js/pixi.js.d.ts:8350


sortableChildren

• sortableChildren: boolean

If set to true, the container will sort its children by zIndex value when updateTransform() is called, or manually if sortChildren() is called.

This actually changes the order of elements in the array, so should be treated as a basic solution that is not performant compared to other solutions, such as

Link

https://github.com/pixijs/pixi-display

Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.

See

PIXI.settings.SORTABLE_CHILDREN

Member

PIXI.Container#sortableChildren

Inherited from

DDialog.sortableChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8343


transform

• transform: Transform

World transform and local transform of this object. This will become read-only later, please do not assign anything there unless you know what are you doing.

Member

PIXI.DisplayObject#transform

Inherited from

DDialog.transform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8599


visible

• visible: boolean

The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually.

Member

PIXI.DisplayObject#visible

Inherited from

DDialog.visible

Defined in

node_modules/pixi.js/pixi.js.d.ts:8614


worldAlpha

• Readonly worldAlpha: number

The multiplied alpha of the displayObject.

Member

PIXI.DisplayObject#worldAlpha

Inherited from

DDialog.worldAlpha

Defined in

node_modules/pixi.js/pixi.js.d.ts:8636


worldTransform

• Readonly worldTransform: Matrix

Current transform of the object based on world (parent) factors.

Member

Inherited from

DDialog.worldTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8833


worldVisible

• Readonly worldVisible: boolean

Indicates if the object is globally visible.

Member

Inherited from

DDialog.worldVisible

Defined in

node_modules/pixi.js/pixi.js.d.ts:8898


zIndex

• zIndex: number

The zIndex of the displayObject. If a container has the sortableChildren property set to true, children will be automatically sorted by zIndex value; a higher value will mean it will be moved towards the end of the array, and thus rendered on top of other displayObjects within the same container.

Member

Inherited from

DDialog.zIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:8891


WORK_BOUNDS

▪ Static Protected Optional WORK_BOUNDS: Rectangle

Inherited from

DDialog.WORK_BOUNDS

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:119


WORK_CONTAINS_POINT

▪ Static Protected WORK_CONTAINS_POINT: Point

Inherited from

DDialog.WORK_CONTAINS_POINT

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:767

Accessors

algin

• set algin(align): void

Parameters

Name Type
align null | UtilAttachAlign

Returns

void

Inherited from

DDialog.algin

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:231


align

• get align(): null | UtilAttachAlign

Returns

null | UtilAttachAlign

Inherited from

DDialog.align

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:227


alwaysOnTop

• get alwaysOnTop(): boolean

Returns

boolean

Inherited from

DDialog.alwaysOnTop

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:235

• set alwaysOnTop(alwaysOnTop): void

Parameters

Name Type
alwaysOnTop boolean

Returns

void

Inherited from

DDialog.alwaysOnTop

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:239


background

• get background(): DBackgroundStateAware

Returns

DBackgroundStateAware

Inherited from

DDialog.background

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1471


border

• get border(): DBorderStateAware

Returns

DBorderStateAware

Inherited from

DDialog.border

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1475


content

• get content(): DDialogLayeredContent<DThemeDialogLayeredContent, DDialogLayeredContentOptions<DThemeDialogLayeredContent>>

Returns

DDialogLayeredContent<DThemeDialogLayeredContent, DDialogLayeredContentOptions<DThemeDialogLayeredContent>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:170


corner

• get corner(): DCorner

Returns

DCorner

Inherited from

DDialog.corner

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1467


• get footer(): null | DDialogLayeredFooter<DThemeDialogLayeredFooter, DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>>

Returns

null | DDialogLayeredFooter<DThemeDialogLayeredFooter, DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:195


gesture

• get gesture(): DDialogGesture<this>

Returns

DDialogGesture<this>

Inherited from

DDialog.gesture

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:243


• get header(): null | DDialogLayeredHeader<DThemeDialogLayeredHeader, DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>>

Returns

null | DDialogLayeredHeader<DThemeDialogLayeredHeader, DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:140


height

• get height(): number

Returns

number

Inherited from

DDialog.height

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1390

• set height(height): void

Parameters

Name Type
height DCoordinateSize

Returns

void

Inherited from

DDialog.height

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1394


layer

• get layer(): null | DApplicationLayerLike

Returns

null | DApplicationLayerLike

Inherited from

DDialog.layer

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:247


layout

• get layout(): DLayoutVertical<DThemeLayoutVertical, DLayoutVerticalOptions<DThemeLayoutVertical>>

Returns

DLayoutVertical<DThemeLayoutVertical, DLayoutVerticalOptions<DThemeLayoutVertical>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:106


mode

• get mode(): DDialogMode

Returns

DDialogMode

Inherited from

DDialog.mode

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:223


options

• get options(): undefined | OPTIONS

Returns

undefined | OPTIONS

Inherited from

DDialog.options

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1690


outline

• get outline(): DOutline

Returns

DOutline

Inherited from

DDialog.outline

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1479


padding

• get padding(): DPadding

Returns

DPadding

Inherited from

DDialog.padding

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1463


position

• get position(): DBasePoint

Returns

DBasePoint

Inherited from

DDialog.position

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1449


reflowable

• get reflowable(): DBaseReflowableContainer

Returns

DBaseReflowableContainer

Inherited from

DDialog.reflowable

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1120


scale

• get scale(): DBasePoint

Returns

DBasePoint

Inherited from

DDialog.scale

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1454


shadow

• get shadow(): null | DShadow

Returns

null | DShadow

Inherited from

DDialog.shadow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1853

• set shadow(shadow): void

Parameters

Name Type
shadow null | DShadow

Returns

void

Inherited from

DDialog.shadow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1857


skew

• get skew(): DBasePoint

Returns

DBasePoint

Inherited from

DDialog.skew

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1459


snippet

• get snippet(): DBaseSnippetContainer

Returns

DBaseSnippetContainer

Inherited from

DDialog.snippet

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1116


state

• get state(): DBaseStateSet

Returns

DBaseStateSet

Inherited from

DDialog.state

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1686


theme

• get theme(): THEME

Returns

THEME

Inherited from

DDialog.theme

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1694

• set theme(theme): void

Parameters

Name Type
theme THEME

Returns

void

Inherited from

DDialog.theme

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1698


title

• get title(): string

Returns

string

Inherited from

DDialog.title

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1487

• set title(title): void

Parameters

Name Type
title string

Returns

void

Inherited from

DDialog.title

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1491


type

• get type(): string

Returns

string

Inherited from

DDialog.type

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1246


unsafe

• get unsafe(): Transform

Returns

Transform

Inherited from

DDialog.unsafe

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1483


weight

• get weight(): number

Returns

number

Inherited from

DDialog.weight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1141

• set weight(weight): void

Parameters

Name Type
weight number

Returns

void

Inherited from

DDialog.weight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1145


width

• get width(): number

Returns

number

Inherited from

DDialog.width

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1331

• set width(width): void

Parameters

Name Type
width DCoordinateSize

Returns

void

Inherited from

DDialog.width

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1335


x

• get x(): number

Returns

number

Inherited from

DDialog.x

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1251

• set x(x): void

Parameters

Name Type
x DCoordinatePosition

Returns

void

Inherited from

DDialog.x

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1255


y

• get y(): number

Returns

number

Inherited from

DDialog.y

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1291

• set y(y): void

Parameters

Name Type
y DCoordinatePosition

Returns

void

Inherited from

DDialog.y

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1295

Methods

_calculateBounds

▸ _calculateBounds(): void

Returns

void

Inherited from

DDialog._calculateBounds

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2084


_recursivePostUpdateTransform

▸ _recursivePostUpdateTransform(): void

Recursively updates transform of all objects from the root to this one internal function for toLocal()

Returns

void

Inherited from

DDialog._recursivePostUpdateTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8737


_render

▸ _render(renderer): void

To be overridden by the subclasses.

Parameters

Name Type Description
renderer Renderer The renderer

Returns

void

Inherited from

DDialog._render

Defined in

node_modules/pixi.js/pixi.js.d.ts:8472


addChild

▸ addChild<TChildren>(...children): TChildren[0]

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

Type parameters

Name Type
TChildren extends DisplayObject[]

Parameters

Name Type Description
...children TChildren The DisplayObject(s) to add to the container

Returns

TChildren[0]

The first child that was added.

Inherited from

DDialog.addChild

Defined in

node_modules/pixi.js/pixi.js.d.ts:8365


addChildAt

▸ addChildAt<T>(child, index): T

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Type parameters

Name Type
T extends DisplayObject

Parameters

Name Type Description
child T The child to add
index number The index to place the child in

Returns

T

The child that was added.

Inherited from

DDialog.addChildAt

Defined in

node_modules/pixi.js/pixi.js.d.ts:8373


addListener

▸ addListener(event, fn, context?): this

Parameters

Name Type
event InteractionEventTypes
fn (event: InteractionEvent) => void
context? any

Returns

this

Inherited from

DDialog.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25521

▸ addListener(event, fn, context?): this

Parameters

Name Type
event string | symbol
fn Function
context? any

Returns

this

Inherited from

DDialog.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25523


applyTitle

▸ applyTitle(): void

Returns

void

Inherited from

DDialog.applyTitle

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1500


blur

▸ blur(recursively?): this

Parameters

Name Type
recursively? boolean

Returns

this

Inherited from

DDialog.blur

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1606


bringToFront

▸ bringToFront(): void

Returns

void

Inherited from

DDialog.bringToFront

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:409


calculateBounds

▸ calculateBounds(): void

Recalculates the bounds of the container.

Returns

void

Inherited from

DDialog.calculateBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:8436


cancel

▸ cancel(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:238


close

▸ close(): void

Returns

void

Inherited from

DDialog.close

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:482


containerUpdateTransform

▸ containerUpdateTransform(): void

Container default updateTransform, does update children of container. Will crash if there’s no parent element.

Returns

void

Memberof

PIXI.Container#

Function

containerUpdateTransform

Inherited from

DDialog.containerUpdateTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8510


containsGlobalPoint

▸ containsGlobalPoint(point): boolean

Parameters

Name Type
point Point

Returns

boolean

Inherited from

DDialog.containsGlobalPoint

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:573


containsLocalPoint

▸ containsLocalPoint(point): boolean

Parameters

Name Type
point Point

Returns

boolean

Inherited from

DDialog.containsLocalPoint

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2102


containsPoint

▸ containsPoint(point): boolean

Parameters

Name Type
point Point

Returns

boolean

Inherited from

DDialog.containsPoint

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2089


destroy

▸ destroy(): void

Returns

void

Inherited from

DDialog.destroy

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2122


disableTempParent

▸ disableTempParent(cacheParent): void

Pair method for enableTempParent

Parameters

Name Type Description
cacheParent DisplayObject actual parent of element

Returns

void

Inherited from

DDialog.disableTempParent

Defined in

node_modules/pixi.js/pixi.js.d.ts:8812


displayObjectUpdateTransform

▸ displayObjectUpdateTransform(): void

DisplayObject default updateTransform, does not update children of container. Will crash if there’s no parent element.

Returns

void

Memberof

PIXI.DisplayObject#

Function

displayObjectUpdateTransform

Inherited from

DDialog.displayObjectUpdateTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8926


doReject

▸ doReject(reason?): void

Parameters

Name Type
reason? any

Returns

void

Inherited from

DDialog.doReject

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:499


doResolve

▸ doResolve(value): void

Parameters

Name Type
value VALUE | PromiseLike<VALUE>

Returns

void

Inherited from

DDialog.doResolve

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:486


emit

▸ emit(event, ...args): boolean

Calls each of the listeners registered for a given event.

Parameters

Name Type Description
event string | symbol The event name.
...args any[] Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Inherited from

DDialog.emit

Defined in

node_modules/pixi.js/pixi.js.d.ts:25441


enableTempParent

▸ enableTempParent(): DisplayObject

Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root

const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);

Returns

DisplayObject

current parent

Inherited from

DDialog.enableTempParent

Defined in

node_modules/pixi.js/pixi.js.d.ts:8807


eventNames

▸ eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Inherited from

DDialog.eventNames

Defined in

node_modules/pixi.js/pixi.js.d.ts:25415


findFirstFocusable

▸ findFirstFocusable(focusController): null | DFocusable

Parameters

Name Type
focusController DControllerFocus

Returns

null | DFocusable

Overrides

DDialog.findFirstFocusable

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:225


focus

▸ focus(): this

Returns

this

Inherited from

DDialog.focus

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1602


focusOnClosest

▸ focusOnClosest(): void

Returns

void

Inherited from

DDialog.focusOnClosest

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2019


getAnimation

▸ getAnimation(): null | DAnimation<unknown>

Returns

null | DAnimation<unknown>

Inherited from

DDialog.getAnimation

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:296


getBounds

▸ getBounds(skipUpdate?, rect?): Rectangle

Retrieves the bounds of the displayObject as a rectangle object.

Parameters

Name Type Description
skipUpdate? boolean Setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost.
rect? Rectangle Optional rectangle to store the result of the bounds calculation.

Returns

Rectangle

The rectangular bounding area.

Inherited from

DDialog.getBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:8747


getChildAt

▸ getChildAt(index): DisplayObject

Returns the child at the specified index

Parameters

Name Type Description
index number The index to get the child at

Returns

DisplayObject

The child at the given index, if any.

Inherited from

DDialog.getChildAt

Defined in

node_modules/pixi.js/pixi.js.d.ts:8401


getChildByName

▸ getChildByName(name, deep?): DisplayObject

Returns the display object in the container.

Recursive searches are done in a preorder traversal.

Parameters

Name Type Description
name string Instance name.
deep? boolean Whether to search recursively

Returns

DisplayObject

The child with the specified name.

Method

getChildByName

Memberof

PIXI.Container#

Inherited from

DDialog.getChildByName

Defined in

node_modules/pixi.js/pixi.js.d.ts:8530


getChildIndex

▸ getChildIndex(child): number

Returns the index position of a child DisplayObject instance

Parameters

Name Type Description
child DisplayObject The DisplayObject instance to identify

Returns

number

The index position of the child display object to identify

Inherited from

DDialog.getChildIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:8387


getClearType

▸ getClearType(): number

Returns

number

Inherited from

DDialog.getClearType

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1215


getClippingRect

▸ getClippingRect(target, result): void

Returns a clipping rect.

Parameters

Name Type Description
target unknown -
result Rectangle a clipping rect

Returns

void

Inherited from

DDialog.getClippingRect

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2115


getGlobalPosition

▸ getGlobalPosition(point?, skipUpdate?): Point

Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.

Parameters

Name Type Description
point? Point The point to write the global value to.
skipUpdate? boolean Setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost.

Returns

Point

The updated point.

Method

getGlobalPosition

Memberof

PIXI.DisplayObject#

Inherited from

DDialog.getGlobalPosition

Defined in

node_modules/pixi.js/pixi.js.d.ts:9010


getHeight

▸ getHeight(): DCoordinateSize

Returns

DCoordinateSize

Inherited from

DDialog.getHeight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1398


getLocalBounds

▸ getLocalBounds(rect?, skipChildrenUpdate?): Rectangle

Retrieves the local bounds of the displayObject as a rectangle object.

Parameters

Name Type Description
rect? Rectangle Optional rectangle to store the result of the bounds calculation.
skipChildrenUpdate? boolean Setting to true will stop re-calculation of children transforms, it was default behaviour of pixi 4.0-5.2 and caused many problems to users.

Returns

Rectangle

The rectangular bounding area.

Inherited from

DDialog.getLocalBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:8445


getParentOfSize

▸ getParentOfSize(): null | { height: number ; padding: DPadding ; width: number }

Returns

null | { height: number ; padding: DPadding ; width: number }

Inherited from

DDialog.getParentOfSize

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1887


getRejectReason

▸ getRejectReason(): any

Returns

any

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:249


getResolvedValue

▸ getResolvedValue(): VALUE | PromiseLike<VALUE>

Returns

VALUE | PromiseLike<VALUE>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:247


getThemeDefault

▸ getThemeDefault(): THEME

Returns

THEME

Inherited from

DDialog.getThemeDefault

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2075


getType

▸ getType(): string

Returns

string

Overrides

DDialog.getType

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:253


getWidth

▸ getWidth(): DCoordinateSize

Returns

DCoordinateSize

Inherited from

DDialog.getWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1339


getX

▸ getX(): DCoordinatePosition

Returns

DCoordinatePosition

Inherited from

DDialog.getX

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1259


getY

▸ getY(): DCoordinatePosition

Returns

DCoordinatePosition

Inherited from

DDialog.getY

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1299


hasDirty

▸ hasDirty(): boolean

Returns

boolean

Inherited from

DDialog.hasDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1588


hasRefitableHeight

▸ hasRefitableHeight(target): target is DRefitable

Returns true if the given target has a height that doesn’t depend on its parent height.

Parameters

Name Type Description
target any a target

Returns

target is DRefitable

true if the given target has a height that doesn’t depend on its parent height.

Inherited from

DDialog.hasRefitableHeight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1831


hasRefitableWidth

▸ hasRefitableWidth(target): target is DRefitable

Returns true if the given target has a width that doesn’t depend on its parent width.

Parameters

Name Type Description
target any a target

Returns

target is DRefitable

true if the given target has a width that doesn’t depend on its parent width.

Inherited from

DDialog.hasRefitableWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1843


hide

▸ hide(): this

Returns

this

Inherited from

DDialog.hide

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1520


init

▸ init(options?): void

Parameters

Name Type
options? OPTIONS

Returns

void

Overrides

DDialog.init

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:101


initReflowable

▸ initReflowable(): void

Returns

void

Inherited from

DDialog.initReflowable

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1124


isDirty

▸ isDirty(): boolean

Returns

boolean

Inherited from

DDialog.isDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1584


isEventTarget

▸ isEventTarget(e): boolean

Parameters

Name Type
e InteractionEvent

Returns

boolean

Inherited from

DDialog.isEventTarget

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1965


isHidden

▸ isHidden(): boolean

Returns

boolean

Inherited from

DDialog.isHidden

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1530


isHierarchyDirty

▸ isHierarchyDirty(): boolean

Returns

boolean

Inherited from

DDialog.isHierarchyDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1576


isOpened

▸ isOpened(): boolean

Returns

boolean

Inherited from

DDialog.isOpened

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:478


isRefitable

▸ isRefitable(target): target is DRefitable

Parameters

Name Type
target any

Returns

target is DRefitable

Inherited from

DDialog.isRefitable

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1821


isShown

▸ isShown(): boolean

Returns

boolean

Inherited from

DDialog.isShown

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1516


listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name Type Description
event string | symbol The event name.

Returns

number

Inherited from

DDialog.listenerCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:25432


listeners

▸ listeners(event): Function[]

Return the listeners registered for a given event.

Parameters

Name Type Description
event string | symbol The event name.

Returns

Function[]

Inherited from

DDialog.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424


newContent

▸ newContent(): DDialogLayeredContent<DThemeDialogLayeredContent, DDialogLayeredContentOptions<DThemeDialogLayeredContent>>

Returns

DDialogLayeredContent<DThemeDialogLayeredContent, DDialogLayeredContentOptions<DThemeDialogLayeredContent>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:179


newContentChildren

▸ newContentChildren(theme, options?): (null | DisplayObject)[]

Parameters

Name Type
theme THEME
options? OPTIONS

Returns

(null | DisplayObject)[]

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:191


newFooter

▸ newFooter(): null | DDialogLayeredFooter<DThemeDialogLayeredFooter, DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>>

Returns

null | DDialogLayeredFooter<DThemeDialogLayeredFooter, DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:204


newHeader

▸ newHeader(): null | DDialogLayeredHeader<DThemeDialogLayeredHeader, DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>>

Returns

null | DDialogLayeredHeader<DThemeDialogLayeredHeader, DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:149


newLayout

▸ newLayout(): DLayoutVertical<DThemeLayoutVertical, DLayoutVerticalOptions<DThemeLayoutVertical>>

Returns

DLayoutVertical<DThemeLayoutVertical, DLayoutVerticalOptions<DThemeLayoutVertical>>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:115


newLayoutChildren

▸ newLayoutChildren(theme, options?): (null | DisplayObject)[]

Parameters

Name Type
theme THEME
options? OPTIONS

Returns

(null | DisplayObject)[]

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:136


newLayoutOptions

▸ newLayoutOptions(theme, options?): DLayoutVerticalOptions<DThemeLayoutVertical>

Parameters

Name Type
theme THEME
options? OPTIONS

Returns

DLayoutVerticalOptions<DThemeLayoutVertical>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:128


newPadding

▸ newPadding(theme, options?, callback?): DBasePadding

Parameters

Name Type
theme THEME
options? OPTIONS
callback? () => void

Returns

DBasePadding

Inherited from

DDialog.newPadding

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1095


off

▸ off(event, fn?, context?): this

Parameters

Name Type
event string
fn? Function
context? any

Returns

this

Inherited from

DDialog.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25534


ok

▸ ok(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:229


on

▸ on(event, fn, context?): this

Parameters

Name Type
event "removed" | "added"
fn (displayObject: DisplayObject) => void
context? any

Returns

this

Inherited from

DDialog.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25530

▸ on(event, fn, context?): this

Parameters

Name Type
event string
fn Function
context? any

Returns

this

Inherited from

DDialog.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25532


onAnimationEnd

▸ onAnimationEnd(isReverse): void

Parameters

Name Type
isReverse boolean

Returns

void

Inherited from

DDialog.onAnimationEnd

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:311


onBlur

▸ onBlur(): void

Returns

void

Inherited from

DDialog.onBlur

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1679


onCancel

▸ onCancel(reason): void

Parameters

Name Type
reason any

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:242


onChildBlur

▸ onChildBlur(blured): void

Parameters

Name Type
blured DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Returns

void

Inherited from

DDialog.onChildBlur

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1672


onChildFocus

▸ onChildFocus(focused): void

Parameters

Name Type
focused DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Returns

void

Inherited from

DDialog.onChildFocus

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:399


onChildrenChange

▸ onChildrenChange(): void

Returns

void

Inherited from

DDialog.onChildrenChange

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1128


onClose

▸ onClose(): void

Returns

void

Inherited from

DDialog.onClose

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:512


onCloseOn

▸ onCloseOn(): void

Returns

void

Inherited from

DDialog.onCloseOn

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:569


onDblClick

▸ onDblClick(e, interactionManager): boolean

Parameters

Name Type
e MouseEvent | TouchEvent
interactionManager InteractionManager

Returns

boolean

Inherited from

DDialog.onDblClick

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2051


onDown

▸ onDown(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Inherited from

DDialog.onDown

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1979


onDownThis

▸ onDownThis(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Inherited from

DDialog.onDownThis

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1986


onFocus

▸ onFocus(): void

Returns

void

Inherited from

DDialog.onFocus

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:404


onHierarchyDirty

▸ onHierarchyDirty(): void

Returns

void

Inherited from

DDialog.onHierarchyDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1580


onKeyDown

▸ onKeyDown(e): boolean

Parameters

Name Type
e KeyboardEvent

Returns

boolean

Inherited from

DDialog.onKeyDown

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:560


onKeyUp

▸ onKeyUp(e): boolean

Parameters

Name Type
e KeyboardEvent

Returns

boolean

Inherited from

DDialog.onKeyUp

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1959


onMove

▸ onMove(newX, newY, oldX, oldY): void

Parameters

Name Type
newX number
newY number
oldX number
oldY number

Returns

void

Inherited from

DDialog.onMove

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1153


onOk

▸ onOk(value): void

Parameters

Name Type
value VALUE | PromiseLike<VALUE>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:233


onOpen

▸ onOpen(): void

Returns

void

Inherited from

DDialog.onOpen

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:465


onOut

▸ onOut(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Inherited from

DDialog.onOut

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2042


onOver

▸ onOver(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Inherited from

DDialog.onOver

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2028


onParentMove

▸ onParentMove(newX, newY, oldX, oldY): void

Called when a parent moved.

Parameters

Name Type Description
newX number a new parent’s local x position
newY number a new parent’s local y position
oldX number an old parent’s local x position
oldY number an old parent’s local y position

Returns

void

Inherited from

DDialog.onParentMove

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1943


onParentResize

▸ onParentResize(parentWidth, parentHeight, parentPadding): void

Called when a parent resized.

Parameters

Name Type Description
parentWidth number a parent’s local width
parentHeight number a parent’s local height
parentPadding DPadding -

Returns

void

Inherited from

DDialog.onParentResize

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:282


onPrerender

▸ onPrerender(): void

Returns

void

Inherited from

DDialog.onPrerender

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:437


onRefit

▸ onRefit(): void

Returns

void

Inherited from

DDialog.onRefit

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1739


onReflow

▸ onReflow(): void

Returns

void

Inherited from

DDialog.onReflow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1849


onResize

▸ onResize(newWidth, newHeight, oldWidth, oldHeight): void

Parameters

Name Type
newWidth number
newHeight number
oldWidth number
oldHeight number

Returns

void

Inherited from

DDialog.onResize

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1219


onScale

▸ onScale(newX, newY, oldX, oldY): void

Parameters

Name Type
newX number
newY number
oldX number
oldY number

Returns

void

Inherited from

DDialog.onScale

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1236


onShortcut

▸ onShortcut(e): void

Parameters

Name Type
e KeyboardEvent

Returns

void

Inherited from

DDialog.onShortcut

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1133


onSkew

▸ onSkew(newX, newY, oldX, oldY): void

Parameters

Name Type
newX number
newY number
oldX number
oldY number

Returns

void

Inherited from

DDialog.onSkew

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1241


onStateChange

▸ onStateChange(newState, oldState): void

Parameters

Name Type
newState DBaseStateSet
oldState DBaseStateSet

Returns

void

Inherited from

DDialog.onStateChange

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1629


onUp

▸ onUp(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Inherited from

DDialog.onUp

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1996


onUpThis

▸ onUpThis(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Inherited from

DDialog.onUpThis

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2003


onWheel

▸ onWheel(e, deltas, global): boolean

Parameters

Name Type
e WheelEvent
deltas UtilWheelEventDeltas
global Point

Returns

boolean

Inherited from

DDialog.onWheel

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1948


once

▸ once(event, fn, context?): this

Parameters

Name Type
event "removed" | "added"
fn (displayObject: DisplayObject) => void
context? any

Returns

this

Inherited from

DDialog.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25527

▸ once(event, fn, context?): this

Parameters

Name Type
event string
fn Function
context? any

Returns

this

Inherited from

DDialog.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25529


open

▸ open(opener?): Promise<VALUE>

Opens a dialog.

Parameters

Name Type Description
opener? DDialogOpener An opener of a dialog. The dialog position is determined based on a position and a size of the opener. If the opener is undefined, the dialog is placed at the center of the screen.

Returns

Promise<VALUE>

a value of this dialog

Inherited from

DDialog.open

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:344


reflow

▸ reflow(): void

Returns

void

Inherited from

DDialog.reflow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1712


removeAllListeners

▸ removeAllListeners(event?): this

Parameters

Name Type
event? InteractionEventTypes

Returns

this

Inherited from

DDialog.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25516

▸ removeAllListeners(event?): this

Parameters

Name Type
event? string | symbol

Returns

this

Inherited from

DDialog.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25517


removeChild

▸ removeChild<TChildren>(...children): TChildren[0]

Removes one or more children from the container.

Type parameters

Name Type
TChildren extends DisplayObject[]

Parameters

Name Type Description
...children TChildren The DisplayObject(s) to remove

Returns

TChildren[0]

The first child that was removed.

Inherited from

DDialog.removeChild

Defined in

node_modules/pixi.js/pixi.js.d.ts:8408


removeChildAt

▸ removeChildAt(index): DisplayObject

Removes a child from the specified index position.

Parameters

Name Type Description
index number The index to get the child from

Returns

DisplayObject

The child that was removed.

Inherited from

DDialog.removeChildAt

Defined in

node_modules/pixi.js/pixi.js.d.ts:8415


removeChildren

▸ removeChildren(beginIndex?, endIndex?): DisplayObject[]

Removes all children from this container that are within the begin and end indexes.

Parameters

Name Type Description
beginIndex? number The beginning position.
endIndex? number The ending position. Default value is size of the container.

Returns

DisplayObject[]

List of removed children

Inherited from

DDialog.removeChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8423


removeListener

▸ removeListener(event, fn?, context?): this

Parameters

Name Type
event InteractionEventTypes
fn? (event: InteractionEvent) => void
context? any

Returns

this

Inherited from

DDialog.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25513

▸ removeListener(event, fn?, context?): this

Parameters

Name Type
event string | symbol
fn? Function
context? any

Returns

this

Inherited from

DDialog.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25515


render

▸ render(renderer): void

Parameters

Name Type
renderer Renderer

Returns

void

Inherited from

DDialog.render

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2060


renderAdvanced

▸ renderAdvanced(renderer): void

Render the object using the WebGL renderer and advanced features.

Parameters

Name Type Description
renderer Renderer The renderer

Returns

void

Inherited from

DDialog.renderAdvanced

Defined in

node_modules/pixi.js/pixi.js.d.ts:8465


resize

▸ resize(width?, height?): boolean

Parameters

Name Type
width? number
height? number

Returns

boolean

Inherited from

DDialog.resize

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1165


setChildIndex

▸ setChildIndex(child, index): void

Changes the position of an existing child in the display object container

Parameters

Name Type Description
child DisplayObject The child DisplayObject instance for which you want to change the index number
index number The resulting index number for the child display object

Returns

void

Inherited from

DDialog.setChildIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:8394


setFocused

▸ setFocused(isFocused): this

Parameters

Name Type
isFocused boolean

Returns

this

Inherited from

DDialog.setFocused

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1592


setHeight

▸ setHeight(height): void

Parameters

Name Type
height DCoordinateSize

Returns

void

Inherited from

DDialog.setHeight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1402


setParent

▸ setParent(container): Container

Set the parent Container of this DisplayObject.

Parameters

Name Type Description
container Container The Container to add this DisplayObject to.

Returns

Container

The Container that this DisplayObject was added to.

Inherited from

DDialog.setParent

Defined in

node_modules/pixi.js/pixi.js.d.ts:8775


setTransform

▸ setTransform(x?, y?, scaleX?, scaleY?, rotation?, skewX?, skewY?, pivotX?, pivotY?): DisplayObject

Convenience function to set the position, scale, skew and pivot at once.

Parameters

Name Type Description
x? number The X position
y? number The Y position
scaleX? number The X scale value
scaleY? number The Y scale value
rotation? number The rotation
skewX? number The X skew value
skewY? number The Y skew value
pivotX? number The X pivot value
pivotY? number The Y pivot value

Returns

DisplayObject

The DisplayObject instance

Inherited from

DDialog.setTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:8790


setWidth

▸ setWidth(width): void

Parameters

Name Type
width DCoordinateSize

Returns

void

Inherited from

DDialog.setWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1343


setX

▸ setX(x): void

Parameters

Name Type
x DCoordinatePosition

Returns

void

Inherited from

DDialog.setX

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1268


setY

▸ setY(y): void

Parameters

Name Type
y DCoordinatePosition

Returns

void

Inherited from

DDialog.setY

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1308


show

▸ show(): this

Returns

this

Inherited from

DDialog.show

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1507


sortChildren

▸ sortChildren(): void

Sorts children by zIndex. Previous order is mantained for 2 children with the same zIndex.

Returns

void

Inherited from

DDialog.sortChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8427


swapChildren

▸ swapChildren(child, child2): void

Swaps the position of 2 Display Objects within this container.

Parameters

Name Type Description
child DisplayObject First display object to swap
child2 DisplayObject Second display object to swap

Returns

void

Inherited from

DDialog.swapChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:8380


toAlign

▸ toAlign(mode, theme, options?): null | UtilAttachAlign

Parameters

Name Type
mode DDialogMode
theme THEME
options? OPTIONS

Returns

null | UtilAttachAlign

Inherited from

DDialog.toAlign

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:212


toCloseOn

▸ toCloseOn(mode, theme, options?): number

Parameters

Name Type
mode DDialogMode
theme THEME
options? OPTIONS

Returns

number

Inherited from

DDialog.toCloseOn

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:196


toContentOptions

▸ toContentOptions(theme, options?): DDialogLayeredContentOptions<DThemeDialogLayeredContent>

Parameters

Name Type
theme THEME
options? OPTIONS

Returns

DDialogLayeredContentOptions<DThemeDialogLayeredContent>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:183


toCursor

▸ toCursor(cursor, state): string

Parameters

Name Type
cursor DStateAwareOrValueMightBe<string>
state DBaseStateSet

Returns

string

Inherited from

DDialog.toCursor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1099


toDirty

▸ toDirty(): boolean

Returns

boolean

Inherited from

DDialog.toDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1534


toFooterOptions

▸ toFooterOptions(theme, options?): undefined | null | DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>

Parameters

Name Type
theme THEME
options? OPTIONS

Returns

undefined | null | DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:212


toGestureOptions

▸ toGestureOptions(mode, theme, options?): DDialogGestureOptions

Parameters

Name Type
mode DDialogMode
theme THEME
options? OPTIONS

Returns

DDialogGestureOptions

Inherited from

DDialog.toGestureOptions

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:251


toGlobal

▸ toGlobal(position, point?, skipUpdate?): Point

Calculates the global position of the display object.

Parameters

Name Type Description
position IPointData The world origin to calculate from.
point? Point A Point object in which to store the value, optional (otherwise will create a new Point).
skipUpdate? boolean Should we skip the update transform.

Returns

Point

A point object representing the position of this object.

Inherited from

DDialog.toGlobal

Defined in

node_modules/pixi.js/pixi.js.d.ts:8757


toHasDirty

▸ toHasDirty(): boolean

Returns

boolean

Inherited from

DDialog.toHasDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1543


toHeaderOptions

▸ toHeaderOptions(theme, options?): undefined | null | DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>

Parameters

Name Type
theme THEME
options? OPTIONS

Returns

undefined | null | DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:157


toHierarchyDirty

▸ toHierarchyDirty(): boolean

Returns

boolean

Inherited from

DDialog.toHierarchyDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1559


toLayoutOptions

▸ toLayoutOptions(theme, options?): DLayoutVerticalOptions<DThemeLayoutVertical>

Parameters

Name Type
theme THEME
options? OPTIONS

Returns

DLayoutVerticalOptions<DThemeLayoutVertical>

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:119


toLocal

▸ toLocal(position, from?, point?, skipUpdate?): Point

Calculates the local position of the display object relative to another point.

Parameters

Name Type Description
position IPointData The world origin to calculate from.
from? DisplayObject The DisplayObject to calculate the global position from.
point? Point A Point object in which to store the value, optional (otherwise will create a new Point).
skipUpdate? boolean Should we skip the update transform

Returns

Point

A point object representing the position of this object

Inherited from

DDialog.toLocal

Defined in

node_modules/pixi.js/pixi.js.d.ts:8768


toParentHasDirty

▸ toParentHasDirty(): void

Returns

void

Inherited from

DDialog.toParentHasDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1552


toParentHierarchyDirty

▸ toParentHierarchyDirty(): void

Returns

void

Inherited from

DDialog.toParentHierarchyDirty

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1569


toParentResized

▸ toParentResized(): void

Returns

void

Inherited from

DDialog.toParentResized

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:1880


updateTransform

▸ updateTransform(): void

Returns

void

Inherited from

DDialog.updateTransform

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:2069


mixin

▸ mixin(source): void

Mixes all enumerable properties and methods from a source object to DisplayObject.

Parameters

Name Type Description
source any The source of properties and methods to mix in.

Returns

void

Inherited from

DDialog.mixin

Defined in

node_modules/pixi.js/pixi.js.d.ts:9230