Class CreateDialog

constructor

• new CreateDialog(data?, options?): CreateDialog

• Parameters

  • Optionaldata: object = {}

    Initial item data
  • Optionaloptions: {
        options: undefined | object;
        pack: any;
        parent: any;
        resolve: undefined | Function;
        types: string[];
    } = {}

    Optional configuration

    • options: undefined | object

      FormApplication options

    • pack: any

      Pack reference given to Item.create()

    • parent: any

      Parent reference given to Item.create()

    • resolve: undefined | Function

      Resolve callback

    • types: string[]

      Array of types to limit the choices to.

  Returns CreateDialog

createData

pack

parent

resolve

types

initialData

• get initialData(): {}

• Returns {}

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

title

• get title(): string

• An Application window should define its own title definition logic which may be dynamic depending on its data

  Returns string

StaticdefaultOptions

• get defaultOptions(): {
      classes: string[];
      closeOnSubmit: boolean;
      height: string;
      submitOnChange: boolean;
      submitOnClose: boolean;
  }

• Assign the default options which are supported by the entity edit sheet.

  Returns {
      classes: string[];
      closeOnSubmit: boolean;
      height: string;
      submitOnChange: boolean;
      submitOnClose: boolean;
  }

  The default options for this FormApplication class

  • classes: string[]

  • closeOnSubmit: boolean

  • height: string

  • submitOnChange: boolean

  • submitOnClose: boolean

  See

  Application.defaultOptions

  Default Value

  foundry.utils.mergeObject(super.defaultOptions, {
    classes: ["form"],
    closeOnSubmit: true,
    editable: true,
    sheetConfig: false,
    submitOnChange: false,
    submitOnClose: false
  });
  Copy

_createItem

• _createItem(event): Promise<void>

• Parameters

  • event: Event

  Returns Promise<void>

_onTypeChange

• _onTypeChange(_event): void

• Parameters

  • _event: any

  Returns void

_updateCreationData

• _updateCreationData(data?): object

• Parameters

  • data: {} = {}

  Returns object

_updateObject

• _updateObject(event, formData): void

• This method is called upon form submission after form data is validated

  Parameters

  • event: any

    The initial triggering submission event
  • formData: any

    The object of validated form data with which to update the object

  Returns void

  A Promise which resolves once the update operation has completed

activateListeners

• activateListeners(jq): void

• Parameters

  • jq: JQuery<HTMLElement>

    jQuery HTML instance

  Returns void

close

• close(options?): Promise<void>

• Parameters

  • options: {} = {}

    (default: {})

  Returns Promise<void>

getData

• getData(): {
      defaultName: any;
      folder: any;
      folders: {
          [k: string]: T;
      };
      hasFolders: boolean;
      name: any;
      subtype: any;
      subtypes: null | {};
      type: any;
      types: {
          [k: string]: T;
      };
  }

• Returns {
      defaultName: any;
      folder: any;
      folders: {
          [k: string]: T;
      };
      hasFolders: boolean;
      name: any;
      subtype: any;
      subtypes: null | {};
      type: any;
      types: {
          [k: string]: T;
      };
  }

  • defaultName: any

  • folder: any

  • folders: {
        [k: string]: T;
    }

    • [k: string]: T

  • hasFolders: boolean

  • name: any

  • subtype: any

  • subtypes: null | {}

  • type: any

  • types: {
        [k: string]: T;
    }

    • [k: string]: T

getDefaultName

• getDefaultName(form?): any

• Parameters

  • form: boolean = true

  Returns any

getSubtypes

• getSubtypes(type): null | {}

• Parameters

  • type: any

  Returns null | {}

StaticwaitPrompt

• waitPrompt(data?, options?): Promise<null | Item>

• Wait for dialog to the resolved.

  Parameters

  • Optionaldata: object

    Initial data to pass to the constructor.
  • Optionaloptions: object = {}

    Options to pass to the constructor.

  Returns Promise<null | Item>

  Created item or null.