Class ChangeEditor

Change Editor

Since

PF1 v10

Hierarchy

any
- ChangeEditor

Index

Constructors

constructor

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

Properties

change

change: ItemChange

`Static` DEFAULT_OPTIONS

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

Type declaration

actions: {
copyUuid: any;
}
- copyUuid: any
classes: string[]
form: {
    closeOnSubmit: boolean;
    handler: ((event, form, formData) => Promise<void>);
    submitOnChange: boolean;
    submitOnClose: boolean;
}
- closeOnSubmit: boolean
- handler: ((event, form, formData) => Promise<void>)
  - - (event, form, formData): Promise<void>
    - Private
      Update the object with the new change data from the form.
      Parameters
      event: SubmitEvent
      The originating form submission event
      
      form: HTMLFormElement
      The form element that was submitted
      
      formData: FormDataExtended
      Processed data for the submitted form
      Returns Promise<void>
- submitOnChange: boolean
- submitOnClose: boolean
position: {
width: number;
}
- width: number
sheetConfig: boolean
tag: string
window: {
minimizable: boolean;
resizable: boolean;
}
- minimizable: boolean
- resizable: boolean

`Static` PARTS

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

Type declaration

form: {
template: string;
}
- template: string

Accessors

actor

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

id

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

item

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

title

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

Methods

_onChangeTargetControl

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

`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/change-editor.mjs:231

_openHelpBrowser

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

_prepareContext

_prepareContext(): Promise<{
    actor: ActorPF;
    change: ItemChange;
    config: config;
    isAdd: boolean;
    isDeferred: boolean;
    isSet: boolean;
    isValid: boolean;
    isValidOp: boolean;
    isValidType: boolean;
    item: ItemPF;
    label: any;
}>
Internal
Returns Promise<{
    actor: ActorPF;
    change: ItemChange;
    config: config;
    isAdd: boolean;
    isDeferred: boolean;
    isSet: boolean;
    isValid: boolean;
    isValidOp: boolean;
    isValidType: boolean;
    item: ItemPF;
    label: any;
}>
Inherit Doc
Async
- Defined in module/applications/change-editor.mjs:116

_validateFormula

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

`Static` `Private` #onCopyUuid

#onCopyUuid(event): void
Internal
Copy the UUID of the current item to the clipboard
Parameters
- event: Event
Returns void
Static
- Defined in module/applications/change-editor.mjs:61

`Static` `Private` _updateObject

_updateObject(event, form, formData): Promise<void>
Private
Update the object with the new change data from the form.
Parameters
- event: SubmitEvent
  The originating form submission event
- form: HTMLFormElement
  The form element that was submitted
- formData: FormDataExtended
  Processed data for the submitted form
Returns Promise<void>
- Defined in module/applications/change-editor.mjs:284

`Static` wait

wait(change, options?): Promise<void | ChangeEditor>
Parameters
- change: ItemChange
  Change to modify
- options: object = {}
  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:253

Class ChangeEditor

Since

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

change: any

options: any

Returns ChangeEditor

Properties

change

Static DEFAULT_OPTIONS

Type declaration

actions: { copyUuid: any; }

copyUuid: any

classes: string[]

form: { closeOnSubmit: boolean; handler: ((event, form, formData) => Promise<void>); submitOnChange: boolean; submitOnClose: boolean; }

closeOnSubmit: boolean

handler: ((event, form, formData) => Promise<void>)

Parameters

event: SubmitEvent

form: HTMLFormElement

formData: FormDataExtended

Returns Promise<void>

submitOnChange: boolean

submitOnClose: boolean

position: { width: number; }

width: number

sheetConfig: boolean

tag: string

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

minimizable: boolean

resizable: boolean

Static PARTS

Type declaration

form: { template: string; }

template: string

Accessors

actor

Returns ActorPF

id

Returns string

item

Returns ItemPF

title

Returns string

Methods

_onChangeTargetControl

Parameters

event: Event

Returns void

Protected _onRender

Parameters

context: ApplicationRenderContext

options: RenderOptions

Returns void

_openHelpBrowser

Parameters

event: Event

Returns void

_prepareContext

Returns Promise<{ actor: ActorPF; change: ItemChange; config: config; isAdd: boolean; isDeferred: boolean; isSet: boolean; isValid: boolean; isValidOp: boolean; isValidType: boolean; item: ItemPF; label: any; }>

Inherit Doc

Async

_validateFormula

Parameters

el: HTMLElement

Returns Promise<void>

Static Private #onCopyUuid

Parameters

event: Event

Returns void

Static

Static Private _updateObject

Parameters

`Static` DEFAULT_OPTIONS

actions: {
copyUuid: any;
}

form: {
closeOnSubmit: boolean;
handler: ((event, form, formData) => Promise<void>);
submitOnChange: boolean;
submitOnClose: boolean;
}

position: {
width: number;
}

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

`Static` PARTS

form: {
template: string;
}

`Protected` _onRender

Returns Promise<{
actor: ActorPF;
change: ItemChange;
config: config;
isAdd: boolean;
isDeferred: boolean;
isSet: boolean;
isValid: boolean;
isValidOp: boolean;
isValidType: boolean;
item: ItemPF;
label: any;
}>

`Static` `Private` #onCopyUuid

`Static` `Private` _updateObject

`Static` wait