Class ContentSourceEditor

Hierarchy

DocumentSheet
- ContentSourceEditor

Index

Constructors

Accessors

Methods

_canDragDrop _canDragStart _getHeaderButtons _onAction _onDragStart _onDrop _onDropContentSource _updateObject activateListeners getData open

Constructors

constructor

new ContentSourceEditor(object, options?): ContentSourceEditor
Parameters
- object: Document<any, any, Metadata<any>>
  Some object or entity which is the target to be updated.
- Optionaloptions: Partial<DocumentSheetOptions>
  Additional options which modify the rendering of the sheet. (default: {})
Returns ContentSourceEditor
Remarks
Foundry allows passing no value to the constructor at all.
Inherited from DocumentSheet.constructor
- Defined in node_modules/@league-of-foundry-developers/foundry-vtt-types/src/foundry/client/apps/form.d.ts:64
new ContentSourceEditor(...args): ContentSourceEditor
Parameters
- Rest...args: [Document<any, any, Metadata<any>>, Partial<DocumentSheetOptions>?]
Returns ContentSourceEditor
Inherited from DocumentSheet.constructor
- Defined in node_modules/@league-of-foundry-developers/foundry-vtt-types/src/foundry/client/apps/form.d.ts:65

Accessors

template

get template(): string
The path to the HTML template file which should be used to render the inner content of the app

Returns string
Overrides DocumentSheet.template
- Defined in module/applications/content-source-editor.mjs:9

title

get title(): string
Returns string
Overrides DocumentSheet.title
- Defined in module/applications/content-source-editor.mjs:2

`Static`defaultOptions

get defaultOptions(): {
    classes: string[];
    closeOnSubmit: boolean;
    dragDrop: {
        dragSelector: string;
        dropSelector: null;
    }[];
    height: string;
    resizable: boolean;
    sheetConfig: boolean;
    submitOnChange: boolean;
    submitOnClose: boolean;
    tabs: {
        contentSelector: string;
        group: string;
        navSelector: string;
    }[];
    width: number;
}
Returns {
    classes: string[];
    closeOnSubmit: boolean;
    dragDrop: {
        dragSelector: string;
        dropSelector: null;
    }[];
    height: string;
    resizable: boolean;
    sheetConfig: boolean;
    submitOnChange: boolean;
    submitOnClose: boolean;
    tabs: {
        contentSelector: string;
        group: string;
        navSelector: string;
    }[];
    width: number;
}
- classes: string[]
- closeOnSubmit: boolean
- dragDrop: {
  dragSelector: string;
  dropSelector: null;
  }[]
- height: string
- resizable: boolean
- sheetConfig: boolean
- submitOnChange: boolean
- submitOnClose: boolean
- tabs: {
      contentSelector: string;
      group: string;
      navSelector: string;
  }[]
- width: number
Default Value
```
foundry.utils.mergeObject(super.defaultOptions, {
  classes: ["sheet"],
  template: `templates/sheets/${this.name.toLowerCase()}.html`,
  viewPermission: CONST.DOCUMENT_PERMISSION_LEVELS.LIMITED,
  sheetConfig: true
});
```
Overrides DocumentSheet.defaultOptions
- Defined in module/applications/content-source-editor.mjs:13

Methods

_canDragDrop

_canDragDrop(selector): boolean
Internal
Parameters
- selector: string
Returns boolean
Overrides DocumentSheet._canDragDrop
- Defined in module/applications/content-source-editor.mjs:146

_canDragStart

_canDragStart(selector): boolean
Internal
Parameters
- selector: string
Returns boolean
Overrides DocumentSheet._canDragStart
- Defined in module/applications/content-source-editor.mjs:135

_getHeaderButtons

_getHeaderButtons(): HeaderButton[]
Returns HeaderButton[]
Overrides DocumentSheet._getHeaderButtons
- Defined in module/applications/content-source-editor.mjs:72

_onAction

_onAction(event): Promise<undefined>
Internal
Parameters
- event: Event
Returns Promise<undefined>
- Defined in module/applications/content-source-editor.mjs:81

_onDragStart

_onDragStart(event): undefined | false
Internal
Parameters
- event: DragEvent
Returns undefined | false
Overrides DocumentSheet._onDragStart
- Defined in module/applications/content-source-editor.mjs:156

_onDrop

_onDrop(event): Promise<void>
Internal
Parameters
- event: DragEvent
Returns Promise<void>
Overrides DocumentSheet._onDrop
- Defined in module/applications/content-source-editor.mjs:182

_onDropContentSource

_onDropContentSource(event, dropData): Promise<void>
Internal
Handle content source drop
Parameters
- event: DragEvent
- dropData: object
Returns Promise<void>
Remarks
- Does not work correctly when dealing with
- Defined in module/applications/content-source-editor.mjs:201

_updateObject

_updateObject(event, updateData): Promise<undefined | Document<any, any, Metadata<any>>>
Parameters
- event: any
- updateData: any
Returns Promise<undefined | Document<any, any, Metadata<any>>>
Overrides DocumentSheet._updateObject
- Defined in module/applications/content-source-editor.mjs:261

activateListeners

activateListeners(jq): void
Internal
Parameters
- jq: JQuery<HTMLElement>
Returns void
Overrides DocumentSheet.activateListeners
- Defined in module/applications/content-source-editor.mjs:240

getData

getData(): object
Internal
Returns object
Overrides DocumentSheet.getData
- Defined in module/applications/content-source-editor.mjs:41

`Static`open

open(document): ContentSourceEditor
Open editor application for defined document.
Parameters
- document: Item | Actor
  Item or Actor reference
Returns ContentSourceEditor
Reference to opened application.
- Defined in module/applications/content-source-editor.mjs:254

Class ContentSourceEditor

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ContentSourceEditor

Remarks

Parameters

Returns ContentSourceEditor

Accessors

template

Returns string

title

Returns string

StaticdefaultOptions

classes: string[]

closeOnSubmit: boolean

dragDrop: { dragSelector: string; dropSelector: null; }[]

height: string

resizable: boolean

sheetConfig: boolean

submitOnChange: boolean

submitOnClose: boolean

tabs: { contentSelector: string; group: string; navSelector: string; }[]

width: number

Default Value

Methods

_canDragDrop

Parameters

Returns boolean

_canDragStart

Parameters

Returns boolean

_getHeaderButtons

Returns HeaderButton[]

_onAction

Parameters

Returns Promise<undefined>

_onDragStart

Parameters

Returns undefined | false

_onDrop

Parameters

Returns Promise<void>

_onDropContentSource

Parameters

Returns Promise<void>

Remarks

_updateObject

Parameters

Returns Promise<undefined | Document<any, any, Metadata<any>>>

activateListeners

Parameters

Returns void

getData

Returns object

Staticopen

Parameters

Returns ContentSourceEditor

Settings

On This Page

`Static`defaultOptions

dragDrop: {
dragSelector: string;
dropSelector: null;
}[]

tabs: {
contentSelector: string;
group: string;
navSelector: string;
}[]

`Static`open