Class ContentSourceEditor

Hierarchy

  • DocumentSheet
    • ContentSourceEditor

Constructors

constructor

Accessors

template title defaultOptions

Methods

_canDragDrop _canDragStart _getHeaderButtons _onAction _onDragStart _onDrop _onDropContentSource _updateObject activateListeners getData open

Constructors

constructor

  • Parameters

    • object: Document<any, any, Metadata<any>>

      Some object or entity which is the target to be updated.

    • Optional options: 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.

  • Parameters

    • Rest ...args: [Document<any, any, Metadata<any>>, Partial<DocumentSheetOptions>?]

    Returns ContentSourceEditor

Accessors

template

title

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

Methods

_canDragDrop

_canDragStart

_getHeaderButtons

_onAction

_onDragStart

_onDrop

_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

_updateObject

  • _updateObject(event, updateData): Promise<undefined | Document<any, any, Metadata<any>>>

  • Parameters

    • event: any
    • updateData: any

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

activateListeners

getData

Static open

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc