Class AbstractDocumentSelector

An abstract class for a document selector application.

Abstract

Hierarchy

any
- AbstractDocumentSelector
  - ItemSelector
  - ActorSelector

Index

Constructors

constructor

new AbstractDocumentSelector(options): AbstractDocumentSelector
Parameters
- options: any
Returns AbstractDocumentSelector
Overrides HandlebarsApplicationMixin(ApplicationV2).constructor
- Defined in module/applications/abstract-document-selector.mjs:49

Properties

selected

selected: any

The currently selected document ID

`Static` DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    classes: string[];
    form: {
        closeOnSubmit: boolean;
        handler: (() => void);
        submitOnChange: boolean;
        submitOnClose: boolean;
    };
    includeNone: string;
    position: {
        width: number;
    };
    search: {
        compositioning: boolean;
        delay: number;
        effectiveSearch: string;
        event: null;
        value: string;
    };
    sheetConfig: boolean;
    tag: string;
    window: {
        minimizable: boolean;
        resizable: boolean;
        title: string;
    };
} = ...

Type declaration

classes: string[]
form: {
    closeOnSubmit: boolean;
    handler: (() => void);
    submitOnChange: boolean;
    submitOnClose: boolean;
}
- closeOnSubmit: boolean
- handler: (() => void)
  - - (): void
    - Private
      Submit the form selection and resolve the stored promise, if provided
      
      Returns void
- submitOnChange: boolean
- submitOnClose: boolean
includeNone: string
position: {
width: number;
}
- width: number
search: {
    compositioning: boolean;
    delay: number;
    effectiveSearch: string;
    event: null;
    value: string;
}
- compositioning: boolean
- delay: number
- effectiveSearch: string
- event: null
- value: string
sheetConfig: boolean
tag: string
window: {
    minimizable: boolean;
    resizable: boolean;
    title: string;
}
- minimizable: boolean
- resizable: boolean
- 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

`Private` _getSections

_getSections(): Promise<DocumentSelectorSection[]>
Private
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<DocumentSelectorSection[]>
Async
Abstract
- Defined in module/applications/abstract-document-selector.mjs:214

_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
- 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
- Defined in module/applications/abstract-document-selector.mjs:115

`Private` _onSearch

_onSearch(event): void
Private
Handle search input events
Parameters
- event: any
Returns void
- Defined in module/applications/abstract-document-selector.mjs:162

`Private` _onSearchComposition

_onSearchComposition(event): void
Private
Handle the beginning of a search composition event
Parameters
- event: any
Returns void
- Defined in module/applications/abstract-document-selector.mjs:150

_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
- Defined in module/applications/abstract-document-selector.mjs:71

`Private` _searchFilterCommit

_searchFilterCommit(): void
Private
Kick off search

Returns void
- Defined in module/applications/abstract-document-selector.mjs:193

`Static` `Private` _submit

_submit(): void
Private
Submit the form selection and resolve the stored promise, if provided

Returns void
- Defined in module/applications/abstract-document-selector.mjs:223

`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.
- Defined in module/applications/abstract-document-selector.mjs:236

Class AbstractDocumentSelector

Abstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: any

Returns AbstractDocumentSelector

Properties

selected

Static DEFAULT_OPTIONS

Type declaration

classes: string[]

form: { closeOnSubmit: boolean; handler: (() => void); submitOnChange: boolean; submitOnClose: boolean; }

closeOnSubmit: boolean

handler: (() => void)

Returns void

submitOnChange: boolean

submitOnClose: boolean

includeNone: string

position: { width: number; }

width: number

search: { compositioning: boolean; delay: number; effectiveSearch: string; event: null; value: string; }

compositioning: boolean

delay: number

effectiveSearch: string

event: null

value: string

sheetConfig: boolean

tag: string

window: { minimizable: boolean; resizable: boolean; title: string; }

minimizable: boolean

resizable: boolean

title: string

Static PARTS

Type declaration

footer: { template: string; }

template: string

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

scrollable: string[]

template: string

Methods

Private _getSections

Returns Promise<DocumentSelectorSection[]>

Async

Abstract

_onChangeForm

Parameters

formConfig: ApplicationFormConfiguration

event: Event

Returns void

Protected _onRender

Parameters

context: ApplicationRenderContext

options: RenderOptions

Returns void

Private _onSearch

Parameters

event: any

Returns void

Private _onSearchComposition

Parameters

event: any

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

Private _searchFilterCommit

Returns void

Static Private _submit

Returns void

Static wait

Parameters

options: object

Returns Promise<null | string>

`Static` DEFAULT_OPTIONS

form: {
closeOnSubmit: boolean;
handler: (() => void);
submitOnChange: boolean;
submitOnClose: boolean;
}

position: {
width: number;
}

search: {
compositioning: boolean;
delay: number;
effectiveSearch: string;
event: null;
value: string;
}

window: {
minimizable: boolean;
resizable: boolean;
title: string;
}

`Static` PARTS

footer: {
template: string;
}

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

`Private` _getSections

`Protected` _onRender

`Private` _onSearch

`Private` _onSearchComposition

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;
}>

`Private` _searchFilterCommit

`Static` `Private` _submit

`Static` wait