Class ItemSelector

A specialized form application for selecting an Item from a list of available choices

Used for example with ammo selector.

Hierarchy (View Summary)

AbstractDocumentSelector
- ItemSelector

Index

Constructors

constructor

new ItemSelector(__namedParameters: { selected: any }): ItemSelector
Parameters
- __namedParameters: { selected: any }
Returns ItemSelector
Inherited from AbstractDocumentSelector.constructor
- Defined in module/applications/abstract-document-selector.mjs:64

Properties

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actor: undefined;
    empty: boolean;
    filterFunc: undefined;
    items: undefined;
    selected: null;
    window: { title: string };
} = ...

`Static`PARTS

PARTS: {
footer: { template: string };
form: { scrollable: string[]; template: string };
} = ...

Accessors

documents

get documents(): Item<"base" | ModuleSubType>[]
Returns Item<"base" | ModuleSubType>[]
Overrides <types>.documents
- Defined in module/applications/item-selector.mjs:29

promise

get promise(): Promise<any>
Returns Promise<any>
Inherited from <types>.promise
- Defined in module/applications/abstract-document-selector.mjs:73

selected

get selected(): string
Returns string
Inherited from <types>.selected
- Defined in module/applications/abstract-document-selector.mjs:16

Methods

_initializeApplicationOptions

_initializeApplicationOptions(options: any): any
Initialize configuration options for the Application instance. The default behavior of this method is to intelligently merge options for each class with those of their parents.
- Array-based options are concatenated
- Inner objects are merged
- Otherwise, properties in the subclass replace those defined by a parent
Parameters
- options: any
  Options provided directly to the constructor
Returns any
Configured options for the application instance
Overrides AbstractDocumentSelector._initializeApplicationOptions
- Defined in module/applications/item-selector.mjs:22

_onClose

_onClose(options: any): void
Actions performed after closing the Application. Post-close steps are not awaited by the close process.
Parameters
- options: any
  Provided render options
Returns void
Inherited from AbstractDocumentSelector._onClose
- Defined in module/applications/abstract-document-selector.mjs:210

`Protected`_onRender

_onRender(context: ApplicationRenderContext, options: RenderOptions): void
Protected
Attach event listeners to the rendered application form.
Parameters
- context: ApplicationRenderContext
  Prepared context data
- options: RenderOptions
  Provided render options
Returns void
Inherited from AbstractDocumentSelector._onRender
- Defined in module/applications/abstract-document-selector.mjs:139

_prepareContext

_prepareContext(): Promise<
    {
        buttons: { label: string; type: string }[];
        document: any;
        empty: {
            document: { id: string; img: string; name: string };
            include: any;
        };
        searchTerm: any;
        sections: DocumentSelectorSection[];
        selected: string;
        showSectionHeaders: boolean;
    },
>
Internal
Returns Promise<
    {
        buttons: { label: string; type: string }[];
        document: any;
        empty: {
            document: { id: string; img: string; name: string };
            include: any;
        };
        searchTerm: any;
        sections: DocumentSelectorSection[];
        selected: string;
        showSectionHeaders: boolean;
    },
>
Inherit Doc
Inherited from AbstractDocumentSelector._prepareContext
- Defined in module/applications/abstract-document-selector.mjs:88

`Static`wait

wait(options: object): Promise<null | string | false | Document<any, any, null>>
Render selector and wait for it to resolve.
Parameters
- options: object
  Options
Returns Promise<null | string | false | Document<any, any, null>>
- Document or string for selected item, null if cancelled, or false or empty string if none were selected.
Inherited from AbstractDocumentSelector.wait
- Defined in module/applications/abstract-document-selector.mjs:225

Class ItemSelector

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ItemSelector

Properties

`Static`DEFAULT_OPTIONS

`Static`PARTS

Accessors

documents

Returns Item<"base" | ModuleSubType>[]

promise

Returns Promise<any>

selected

Returns string

Methods

_initializeApplicationOptions

Parameters

Returns any

_onClose

Parameters

Returns void

`Protected`_onRender

Parameters

Returns void

_prepareContext

Inherit Doc

`Static`wait

Parameters

Returns Promise<null | string | false | Document<any, any, null>>

Settings

On This Page

Class ItemSelector

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ItemSelector

Properties

StaticDEFAULT_OPTIONS

StaticPARTS

Accessors

documents

Returns Item<"base" | ModuleSubType>[]

promise

Returns Promise<any>

selected

Returns string

Methods

_initializeApplicationOptions

Parameters

Returns any

_onClose

Parameters

Returns void

Protected_onRender

Parameters

Returns void

_prepareContext

Returns Promise< { buttons: { label: string; type: string }[]; document: any; empty: { document: { id: string; img: string; name: string }; include: any; }; searchTerm: any; sections: DocumentSelectorSection[]; selected: string; showSectionHeaders: boolean; },>

Inherit Doc

Staticwait

Parameters

Returns Promise<null | string | false | Document<any, any, null>>

Settings

On This Page

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Protected`_onRender

Returns Promise<
{
buttons: { label: string; type: string }[];
document: any;
empty: {
document: { id: string; img: string; name: string };
include: any;
};
searchTerm: any;
sections: DocumentSelectorSection[];
selected: string;
showSectionHeaders: boolean;
},
>

`Static`wait