Class ChangeEditor

Change Editor

Since

PF1 v10

Hierarchy

any
- ChangeEditor

Index

Constructors

constructor

new ChangeEditor(options: any): ChangeEditor
Internal
Parameters
- options: any
Returns ChangeEditor
Overrides HandlebarsApplicationMixin(NoAutocomplete(DocumentSheetV2)).constructor
- Defined in module/applications/change-editor.mjs:47

Properties

change

change: ItemChange

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actions: {
        copyUuid: {
            buttons: number[];
            handler: (...this: any, event: PointerEvent) => void;
        };
    };
    classes: string[];
    form: {
        closeOnSubmit: boolean;
        handler: Object;
        submitOnChange: boolean;
        submitOnClose: boolean;
    };
    position: { width: number };
    sheetConfig: boolean;
    tag: string;
    window: { minimizable: boolean; resizable: boolean };
} = ...

`Static`PARTS

PARTS: { form: { template: string } } = ...

Accessors

actor

get actor(): ActorPF
Returns ActorPF
- Defined in module/applications/change-editor.mjs:69

id

get id(): string
Returns string
- Defined in module/applications/change-editor.mjs:101

inParent

get inParent(): boolean
Test if this Change is in its declared parent.

Returns boolean
- Defined in module/applications/change-editor.mjs:269

item

get item(): ItemPF
Returns ItemPF
- Defined in module/applications/change-editor.mjs:78

title

get title(): string
Returns string
- Defined in module/applications/change-editor.mjs:88

Methods

_initializeApplicationOptions

_initializeApplicationOptions(options: object): object
Override to fix DocumentSheet ignoring get id
Parameters
- options: object
  App options
Returns object
- Defined in module/applications/change-editor.mjs:58

_onChangeTargetControl

_onChangeTargetControl(event: Event): void
Internal
Parameters
- event: Event
Returns void
- Defined in module/applications/change-editor.mjs:175

`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
- Defined in module/applications/change-editor.mjs:296

_openHelpBrowser

_openHelpBrowser(event: Event): void
Internal
Show the help browser
Parameters
- event: Event
Returns void
- Defined in module/applications/change-editor.mjs:217

`Protected`_prepareContext

_prepareContext(): Promise<
    {
        actor: ActorPF;
        change: ItemChange;
        config: config;
        cssClass: string;
        editable: any;
        isAdd: boolean;
        isCustom: boolean;
        isDeferred: boolean;
        isSet: boolean;
        isSimple: boolean;
        isValid: boolean;
        isValidOp: boolean;
        isValidType: boolean;
        item: ItemPF;
        label: string;
        priority: { early: boolean; late: boolean; normal: boolean };
        values: {
            priority: { early: undefined | number; late: undefined | number };
        };
    },
>
Protected
Returns Promise<
    {
        actor: ActorPF;
        change: ItemChange;
        config: config;
        cssClass: string;
        editable: any;
        isAdd: boolean;
        isCustom: boolean;
        isDeferred: boolean;
        isSet: boolean;
        isSimple: boolean;
        isValid: boolean;
        isValidOp: boolean;
        isValidType: boolean;
        item: ItemPF;
        label: string;
        priority: { early: boolean; late: boolean; normal: boolean };
        values: {
            priority: { early: undefined | number; late: undefined | number };
        };
    },
>
Inherit Doc
- Defined in module/applications/change-editor.mjs:123

_validateFormula

_validateFormula(el: HTMLElement): Promise<void>
Internal
Validate input formula for basic errors.
Parameters
- el: HTMLElement
Returns Promise<void>
- Defined in module/applications/change-editor.mjs:232

getID

getID(options: object): string
Internal
HACK: To deal with AppV2 and DocumentSheetV2 behaviour
Parameters
- options: object
Returns string
- Defined in module/applications/change-editor.mjs:112

render

render(options: object, _options: object): Promise<any>
HACK: Override to force close the dialog when the Change is deleted
Parameters
- options: object
  Options
- _options: object
  Legacy options
Returns Promise<any>
- Defined in module/applications/change-editor.mjs:280

`Static`wait

wait(
options: { change: ItemChange },
oldOptions?: object,
): Promise<void | ChangeEditor>
Parameters
- options: { change: ItemChange }
  Application options
  - change: ItemChange
    Change to modify
- oldOptions: object = {}
  Deprecated application options
Returns Promise<void | ChangeEditor>
- Promise that resolves when the app is closed. Returns application instance if no new instance was created.
- Defined in module/applications/change-editor.mjs:345

Class ChangeEditor

Since

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ChangeEditor

Properties

change

StaticDEFAULT_OPTIONS

StaticPARTS

Accessors

actor

Returns ActorPF

id

Returns string

inParent

Returns boolean

item

Returns ItemPF

title

Returns string

Methods

_initializeApplicationOptions

Parameters

Returns object

_onChangeTargetControl

Parameters

Returns void

Protected_onRender

Parameters

Returns void

_openHelpBrowser

Parameters

Returns void

Protected_prepareContext

Inherit Doc

_validateFormula

Parameters

Returns Promise<void>

getID

Parameters

Returns string

render

Parameters

Returns Promise<any>

Staticwait

Parameters

change: ItemChange

Returns Promise<void | ChangeEditor>

Settings

On This Page

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Protected`_onRender

`Protected`_prepareContext

`Static`wait