Class ItemSelector

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

Hierarchy

AbstractDocumentSelector
- ItemSelector

Index

Constructors

constructor

new ItemSelector(options): ItemSelector
Parameters
- options: any
Returns ItemSelector
Inherited from AbstractDocumentSelector.constructor
- Defined in module/applications/abstract-document-selector.mjs:49

Properties

selected

selected: any

The currently selected document ID

`Static` DEFAULT_OPTIONS

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

Type declaration

actor: undefined
filterFunc: undefined
includeNone: boolean
items: undefined
selected: null
window: {
title: string;
}
- title: string

`Static` PARTS

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

Type declaration

footer: {
template: string;
}
- template: string
form: {
scrollable: string[];
template: string;
}
- scrollable: string[]
- template: string

Methods

_getSections

_getSections(): Promise<{
    documents: any;
    id: string;
    label: string;
}[]>
Get the list of sections to show in the selector. Categories are supposed to have their permissions correctly applied and display error messages, if they are not accessible.

Returns Promise<{
    documents: any;
    id: string;
    label: string;
}[]>
Async
Abstract
Overrides AbstractDocumentSelector._getSections
- Defined in module/applications/item-selector.mjs:30

_initializeApplicationOptions

_initializeApplicationOptions(options): any
Parameters
- options: any
Returns any
- Defined in module/applications/item-selector.mjs:22

_onChangeForm

_onChangeForm(formConfig, event): void
Internal
The event handler for changes to form input elements
Parameters
- formConfig: ApplicationFormConfiguration
  The configuration of the form being changed
- event: Event
  The triggering event
Returns void
Inherited from AbstractDocumentSelector._onChangeForm
- Defined in module/applications/abstract-document-selector.mjs:133

`Protected` _onRender

_onRender(context, options): 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:115

_prepareContext

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

`Static` wait

wait(options): Promise<null | string>
Render selector and wait for it to resolve.
Parameters
- options: object
  Options
Returns Promise<null | string>
- Document ID or null if cancelled.
Inherited from AbstractDocumentSelector.wait
- Defined in module/applications/abstract-document-selector.mjs:236

Class ItemSelector

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: any

Returns ItemSelector

Properties

selected

Static DEFAULT_OPTIONS

Type declaration

actor: undefined

filterFunc: undefined

includeNone: boolean

items: undefined

selected: null

window: { title: string; }

title: string

Static PARTS

Type declaration

footer: { template: string; }

template: string

form: { scrollable: string[]; template: string; }

scrollable: string[]

template: string

Methods

_getSections

Returns Promise<{ documents: any; id: string; label: string; }[]>

Async

Abstract

_initializeApplicationOptions

Parameters

options: any

Returns any

_onChangeForm

Parameters

formConfig: ApplicationFormConfiguration

event: Event

Returns void

Protected _onRender

Parameters

context: ApplicationRenderContext

options: RenderOptions

Returns void

_prepareContext

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

Inherit Doc

Async

Static wait

Parameters

options: object

Returns Promise<null | string>

Settings

Member Visibility

Theme

On This Page

`Static` DEFAULT_OPTIONS

window: {
title: string;
}

`Static` PARTS

footer: {
template: string;
}

form: {
scrollable: string[];
template: string;
}

Returns Promise<{
documents: any;
id: string;
label: string;
}[]>

`Protected` _onRender

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

`Static` wait