Class ItemSheetPF_Container

Override and extend the core ItemSheet implementation to handle game system specific item types

Hierarchy (View Summary)

ItemSheetPF
- ItemSheetPF_Container

Index

Constructors

constructor

new ItemSheetPF_Container(...args: any[]): ItemSheetPF_Container
Parameters
- ...args: any[]
Returns ItemSheetPF_Container
Overrides ItemSheetPF.constructor
- Defined in module/applications/item/container-sheet.mjs:17

Properties

`Internal`_activeEdits

_activeEdits: Record<string, string> = {}

item

item: ItemContainerPF

`Static`_warnedAppV1

_warnedAppV1: boolean = true

`Static` `Internal` `Experimental`ACTIONS

ACTIONS: {
    __proto__: null;
    adjustQuantity: Object;
    convertCurrency: (
        ...this: any,
        event: PointerEvent,
        target: HTMLElement,
    ) => Promise<void>;
    createItem: Object;
    deleteItem: Object;
    displayItemCard: Object;
    dupeItem: Object;
    editItem: Object;
    takeItem: Object;
    toggleIdentified: Object;
    toggleItemSummary: Object;
    useItem: Object;
} = ...

Temporary action mapping until AppV2 conversion.

Type Declaration

__proto__: null
adjustQuantity: Object
convertCurrency: (...this: any, event: PointerEvent, target: HTMLElement) => Promise<void>
createItem: Object
deleteItem: Object
displayItemCard: Object
dupeItem: Object
editItem: Object
takeItem: Object
toggleIdentified: Object
toggleItemSummary: Object
useItem: Object

`Static`BASE_APPLICATION

BASE_APPLICATION: typeof ItemSheetPF = ...

Todo

Remove with AppV2 conversion

`Static` `Internal`EDIT_TRACKING

EDIT_TRACKING: string[] = ...

Which fields to track edits for

`Static`WHEEL_UPDATE_SCOPES

WHEEL_UPDATE_SCOPES: string[] = ...

Accessors

abortSignal

get abortSignal(): any
Returns any
Inherited from <types>.abortSignal
- Defined in module/applications/item/item-sheet.mjs:17

template

get template(): string
Return a dynamic reference to the HTML template path used to render this Item Sheet

Returns string
Overrides ItemSheetPF.template
- Defined in module/applications/item/container-sheet.mjs:71

title

get title(): string
Returns string
Inherited from <types>.title
- Defined in module/applications/item/item-sheet.mjs:218

`Static`defaultOptions

get defaultOptions(): InsertKeys<
    {},
    {
        classes: readonly ["pf1", "sheet", "item"];
        dragDrop: readonly [
            {
                dragSelector: "li.item[data-item-id]";
                dropSelector: ".tab[data-tab=\"contents\"]";
            },
            { dragSelector: ".tab.changes li.change" },
            { dragSelector: "label.denomination" },
        ];
        scrollY: readonly [
            ".tab",
            ".buff-flags",
            ".editor-content",
            ".inventory-body",
        ];
        width: 800;
    },
>
Returns InsertKeys<
    {},
    {
        classes: readonly ["pf1", "sheet", "item"];
        dragDrop: readonly [
            {
                dragSelector: "li.item[data-item-id]";
                dropSelector: ".tab[data-tab=\"contents\"]";
            },
            { dragSelector: ".tab.changes li.change" },
            { dragSelector: "label.denomination" },
        ];
        scrollY: readonly [
            ".tab",
            ".buff-flags",
            ".editor-content",
            ".inventory-body",
        ];
        width: 800;
    },
>
Default Value
```
foundry.utils.mergeObject(super.defaultOptions, {
  template: "templates/sheets/item-sheet.html",
  width: 500,
  closeOnSubmit: false,
  submitOnClose: true,
  submitOnChange: true,
  resizable: true,
  baseApplication: "ItemSheet",
  id: "item",
  secrets: [{parentSelector: ".editor"}]
})
```
Overrides ItemSheetPF.defaultOptions
- Defined in module/applications/item/container-sheet.mjs:28

Methods

_applySectionFilter

_applySectionFilter(
item: Item<"base" | ModuleSubType>,
section: object,
): boolean
Internal
Filters item by sheet section config.
Parameters
- item: Item<"base" | ModuleSubType>
  Item to filter
- section: object
  Section to filter by
Returns boolean
- Defined in module/applications/item/container-sheet.mjs:152

`Protected`_canDragDrop

_canDragDrop(): boolean
Protected
Allow non-GM to drag&drop actions and items (for containers) to this sheet.

Returns boolean
Inherited from ItemSheetPF._canDragDrop
- Defined in module/applications/item/item-sheet.mjs:2258

_canDragStart

_canDragStart(selector: any): boolean
By default, returns true only for GM
Parameters
- selector: any
Returns boolean
Inherited from ItemSheetPF._canDragStart
- Defined in module/applications/item/item-sheet.mjs:2204

_commitSpanTextInputValue

_commitSpanTextInputValue(event: Event, target: HTMLElement): Promise<void>
Internal
Submit input value
Parameters
- event: Event
- target: HTMLElement
Returns Promise<void>
Throws
Inherited from ItemSheetPF._commitSpanTextInputValue
- Defined in module/applications/item/item-sheet.mjs:2038

_getContentSources

_getContentSources(): object[]
Returns object[]
Inherited from ItemSheetPF._getContentSources
- Defined in module/applications/item/item-sheet.mjs:1076

_getSidebarTooltipContent

_getSidebarTooltipContent(event: PointerEvent, target: HTMLElement): string
Internal
Get Sidebar Tooltip Content
Parameters
- event: PointerEvent
- target: HTMLElement
Returns string
Inherited from ItemSheetPF._getSidebarTooltipContent
- Defined in module/applications/item/item-sheet.mjs:1402

_getUniqueActionName

_getUniqueActionName(base: string): string
Internal
Get Unique Action Name
Parameters
- base: string
Returns string
Inherited from ItemSheetPF._getUniqueActionName
- Defined in module/applications/item/item-sheet.mjs:2741

_initializeActions

_initializeActions(): void
Internal
Returns void
Todo
Remove with AppV2 conversion
Inherited from ItemSheetPF._initializeActions
- Defined in module/applications/item/item-sheet.mjs:63

_onChange

_onChange(event: any, target: any): boolean
Nameless Change Event

Handler for any change event that did not target an element with name.
Parameters
- event: any
- target: any
Returns boolean
- True if the change was handled, false otherwise.
Overrides ItemSheetPF._onChange
- Defined in module/applications/item/container-sheet.mjs:312

_onChangeDrop

_onChangeDrop(event: DragEvent, data: object): Promise<void>
Internal
Handle pf1.components.ItemChange drop events.
Parameters
- event: DragEvent
  The originating drop event
- data: object
  The data extracted from the drop event
Returns Promise<void>
Inherited from ItemSheetPF._onChangeDrop
- Defined in module/applications/item/item-sheet.mjs:2495

`Protected`_onClick

_onClick(event: PointerEvent, target: HTMLElement): boolean
Protected
Non-action button clicks
Parameters
- event: PointerEvent
  Triggering event
- target: HTMLElement
  Click target
Returns boolean
- True if this click was handled, false otherwise
Inherited from ItemSheetPF._onClick
- Defined in module/applications/item/item-sheet.mjs:1660

`Protected`_onClickAction

_onClickAction(event: PointerEvent, target: HTMLElement): boolean
Protected
Handle action button clicks
Parameters
- event: PointerEvent
  Triggering event
- target: HTMLElement
  Action element
Returns boolean
- true if handler was found, false otherwise.
Inherited from ItemSheetPF._onClickAction
- Defined in module/applications/item/item-sheet.mjs:1644

`Protected`_onContext

_onContext(event: PointerEvent, target: HTMLElement): boolean
Protected
Non-action context clicks
Parameters
- event: PointerEvent
  Triggering event
- target: HTMLElement
  Click target
Returns boolean
- True if this click was handled, false otherwise
Inherited from ItemSheetPF._onContext
- Defined in module/applications/item/item-sheet.mjs:1723

`Protected`_onContextAction

_onContextAction(event: PointerEvent, target: HTMLElement): boolean
Protected
Handle right-click actions
Parameters
- event: PointerEvent
- target: HTMLElement
Returns boolean
- True if click was handled, false otherwise.
Inherited from ItemSheetPF._onContextAction
- Defined in module/applications/item/item-sheet.mjs:1706

_onDisplaySidebarTooltip

_onDisplaySidebarTooltip(
event: PointerEvent,
target: HTMLElement,
): Promise<void>
Internal
Open sidebar tooltip
Parameters
- event: PointerEvent
- target: HTMLElement
Returns Promise<void>
Inherited from ItemSheetPF._onDisplaySidebarTooltip
- Defined in module/applications/item/item-sheet.mjs:2876

_onDragStart

_onDragStart(event: DragEvent): void
Parameters
- event: DragEvent
Returns void
Overrides ItemSheetPF._onDragStart
- Defined in module/applications/item/container-sheet.mjs:533

_onDrop

_onDrop(event: DragEvent): void | Promise<false | void | ItemContainerPF>
Parameters
- event: DragEvent
Returns void | Promise<false | void | ItemContainerPF>
Overrides ItemSheetPF._onDrop
- Defined in module/applications/item/container-sheet.mjs:569

_onDropCurrency

_onDropCurrency(event: DragEvent, data: object): void
Internal
Parameters
- event: DragEvent
- data: object
Returns void
- Defined in module/applications/item/container-sheet.mjs:599

`Protected`_onDropGeneric

_onDropGeneric(event: DragEvent, data: object): void
Protected
On drop of unrecognized data
Parameters
- event: DragEvent
- data: object
Returns void
Inherited from ItemSheetPF._onDropGeneric
- Defined in module/applications/item/item-sheet.mjs:2428

_onDropItem

_onDropItem(
event: DragEvent,
data: object,
): Promise<false | void | ItemContainerPF>
Internal
Parameters
- event: DragEvent
- data: object
Returns Promise<false | void | ItemContainerPF>
- Defined in module/applications/item/container-sheet.mjs:617

_onFinishWheelUpdate

_onFinishWheelUpdate(target: any): undefined | object
Finalize Wheel Update
Parameters
- target: any
Returns undefined | object
- object with wheel element info, undefined if this is not valid element
Overrides ItemSheetPF._onFinishWheelUpdate
- Defined in module/applications/item/container-sheet.mjs:290

_onHoverPriceTooltip

_onHoverPriceTooltip(event: any, content: any, identified?: boolean): void
Parameters
- event: any
- content: any
- identified: boolean = true
Returns void
Inherited from ItemSheetPF._onHoverPriceTooltip
- Defined in module/applications/item/item-sheet.mjs:1443

_onHoverWeightTooltip

_onHoverWeightTooltip(event: any, content: any): void
Parameters
- event: any
- content: any
Returns void
Inherited from ItemSheetPF._onHoverWeightTooltip
- Defined in module/applications/item/item-sheet.mjs:1419

_onLinksDrop

_onLinksDrop(event: DragEvent, data: object): Promise<void>
Internal
Handle drop into links
Parameters
- event: DragEvent
- data: object
Returns Promise<void>
Inherited from ItemSheetPF._onLinksDrop
- Defined in module/applications/item/item-sheet.mjs:2463

_onOpenChangeMenu

_onOpenChangeMenu(event: PointerEvent): Promise<void>
Internal
Open static tooltip for a Change
Parameters
- event: PointerEvent
Returns Promise<void>
Inherited from ItemSheetPF._onOpenChangeMenu
- Defined in module/applications/item/item-sheet.mjs:2896

_onPointerEnter

_onPointerEnter(event: PointerEvent): void
Internal
Pointer Enter event handler delegate
Parameters
- event: PointerEvent
Returns void
Inherited from ItemSheetPF._onPointerEnter
- Defined in module/applications/item/item-sheet.mjs:1854

_onPointerLeave

_onPointerLeave(event: PointerEvent): void
Internal
Pointer Leave event handler delegate
Parameters
- event: PointerEvent
Returns void
Inherited from ItemSheetPF._onPointerLeave
- Defined in module/applications/item/item-sheet.mjs:1873

_onPostRender

_onPostRender(html: HTMLElement): Promise<void>
Internal
Post-Render handling

Sheet handling that is not needed for rendering
Parameters
- html: HTMLElement
Returns Promise<void>
Inherited from ItemSheetPF._onPostRender
- Defined in module/applications/item/item-sheet.mjs:1611

_onSortItem

_onSortItem(event: any, itemData: any): undefined | Promise<void>
Parameters
- event: any
- itemData: any
Returns undefined | Promise<void>
- Defined in module/applications/item/container-sheet.mjs:798

_onSpanTextInput

_onSpanTextInput(
    event: PointerEvent,
    target: HTMLElement,
    callback: Function,
): void
Internal
Edit input
Parameters
- event: PointerEvent
- target: HTMLElement
- callback: Function
Returns void
Inherited from ItemSheetPF._onSpanTextInput
- Defined in module/applications/item/item-sheet.mjs:1924

_onTextDrop

_onTextDrop(
event: DragEvent,
dropData: object,
): Promise<undefined | Partial<AnyObject>>
Internal
Handle dropping content-linkable data to <textarea> or text <input>
Parameters
- event: DragEvent
- dropData: object
Returns Promise<undefined | Partial<AnyObject>>
Inherited from ItemSheetPF._onTextDrop
- Defined in module/applications/item/item-sheet.mjs:2437

_prepareAlignments

_prepareAlignments(): {}
Returns {}
Inherited from ItemSheetPF._prepareAlignments
- Defined in module/applications/item/item-sheet.mjs:1086

`Protected`_prepareContents

_prepareContents(context: object): void
Protected
Parameters
- context: object
  Render context
Returns void
- Defined in module/applications/item/container-sheet.mjs:227

_prepareContentSource

_prepareContentSource(context: any): void
Parameters
- context: any
Returns void
Inherited from ItemSheetPF._prepareContentSource
- Defined in module/applications/item/item-sheet.mjs:1055

`Protected`_prepareItem

_prepareItem(item: ItemPhysicalPF, context: object): object
Protected
Parameters
- item: ItemPhysicalPF
  Item document
- context: object
  Render context
Returns object
- Item render data
- Defined in module/applications/item/container-sheet.mjs:183

_prepareItemFlags

_prepareItemFlags(context: any): void
Parameters
- context: any
Returns void
Inherited from ItemSheetPF._prepareItemFlags
- Defined in module/applications/item/item-sheet.mjs:1180

_prepareItemForSection

_prepareItemForSection(item: object, section: object, context: object): void
Internal
Parameters
- item: object
  Item render data
- section: object
  Section configuration
- context: object
  Render context
Returns void
- Defined in module/applications/item/container-sheet.mjs:168

_prepareLinks

_prepareLinks(context: any): Promise<void>
Parameters
- context: any
Returns Promise<void>
Inherited from ItemSheetPF._prepareLinks
- Defined in module/applications/item/item-sheet.mjs:1102

_prepareScriptCalls

_prepareScriptCalls(context: any): Promise<void>
Parameters
- context: any
Returns Promise<void>
Inherited from ItemSheetPF._prepareScriptCalls
- Defined in module/applications/item/item-sheet.mjs:1187

_render

_render(force: any, options: any): Promise<void>
Parameters
- force: any
- options: any
Returns Promise<void>
Inherited from ItemSheetPF._render
- Defined in module/applications/item/item-sheet.mjs:227

_renderInner

_renderInner(...args: any[]): Promise<JQuery<HTMLElement>>
Parameters
- ...args: any[]
Returns Promise<JQuery<HTMLElement>>
Overrides ItemSheetPF._renderInner
- Defined in module/applications/item/container-sheet.mjs:253

_selectContentSource

_selectContentSource(sources: any): any
Parameters
- sources: any
Returns any
Inherited from ItemSheetPF._selectContentSource
- Defined in module/applications/item/item-sheet.mjs:1068

_toggleItemSummary

_toggleItemSummary(
elem: HTMLElement,
options?: { animation?: boolean; rollData?: object },
): Promise<void>
Internal
Toggle Item Summary
Parameters
- elem: HTMLElement
- Optionaloptions: { animation?: boolean; rollData?: object } = {}
  Additional options
Returns Promise<void>
- Defined in module/applications/item/container-sheet.mjs:420

`Protected`_updateObject

_updateObject(event: any, formData: any): Promise<unknown>
Protected
Extend the parent class _updateObject method to ensure that damage ends up in an Array
Parameters
- event: any
- formData: any
Returns Promise<unknown>
Inherited from ItemSheetPF._updateObject
- Defined in module/applications/item/item-sheet.mjs:1236

_validateFormula

_validateFormula(el: HTMLElement): Promise<void>
Internal
Validate input formula for basic errors.
Parameters
- el: HTMLElement
Returns Promise<void>
Inherited from ItemSheetPF._validateFormula
- Defined in module/applications/item/item-sheet.mjs:1487

activateListeners

activateListeners(html: any): void
Activate listeners for interactive item sheet events
Parameters
- html: any
Returns void
Overrides ItemSheetPF.activateListeners
- Defined in module/applications/item/container-sheet.mjs:271

close

close(options: any): Promise<void>
Parameters
- options: any
Returns Promise<void>
Overrides ItemSheetPF.close
- Defined in module/applications/item/container-sheet.mjs:78

getData

getData(): Promise<
    {
        actor: null
        | ActorPF;
        canClassLink: boolean;
        config: config;
        cssClass: string;
        data: any;
        document: ItemPF;
        editable: boolean;
        embedded: boolean;
        inContainer: boolean;
        isGM: boolean;
        item: ItemPF;
        itemType: string;
        labels: Record<string, string>;
        name: string;
        owned: boolean;
        owner: boolean;
        rollData: object;
        system: SystemOfType<"base" | ModuleSubType>;
        tag: any;
    },
>
Prepare item sheet data Start with the base item data and extending with additional properties for rendering.

Returns Promise<
    {
        actor: null
        | ActorPF;
        canClassLink: boolean;
        config: config;
        cssClass: string;
        data: any;
        document: ItemPF;
        editable: boolean;
        embedded: boolean;
        inContainer: boolean;
        isGM: boolean;
        item: ItemPF;
        itemType: string;
        labels: Record<string, string>;
        name: string;
        owned: boolean;
        owner: boolean;
        rollData: object;
        system: SystemOfType<"base" | ModuleSubType>;
        tag: any;
    },
>
Overrides ItemSheetPF.getData
- Defined in module/applications/item/container-sheet.mjs:89

`Static`_onConvertCurrency

_onConvertCurrency(
    ...this: any,
    event: PointerEvent,
    target: HTMLElement,
): Promise<void>
Internal
Convert Currency
Parameters
- ...this: any
- event: PointerEvent
- target: HTMLElement
Returns Promise<void>
- Defined in module/applications/item/container-sheet.mjs:786

`Static`_onDeleteCardNote

_onDeleteCardNote(
    ...this: any,
    event: PointerEvent,
    target: HTMLElement,
): Promise<void>
Internal
Control effect notes and footnotes
Parameters
- ...this: any
- event: PointerEvent
- target: HTMLElement
Returns Promise<void>
Inherited from ItemSheetPF._onDeleteCardNote
- Defined in module/applications/item/item-sheet.mjs:3321

`Static`_onDuplicateChange

_onDuplicateChange(...this: any, event: PointerEvent, target: HTMLElement): void
Duplicate Change
Parameters
- ...this: any
- event: PointerEvent
- target: HTMLElement
Returns void
Inherited from ItemSheetPF._onDuplicateChange
- Defined in module/applications/item/item-sheet.mjs:2953

`Static`_onEditChange

_onEditChange(...this: any, event: PointerEvent, target: HTMLElement): void
Internal
Edit Change
Parameters
- ...this: any
- event: PointerEvent
  Click event
- target: HTMLElement
Returns void
Inherited from ItemSheetPF._onEditChange
- Defined in module/applications/item/item-sheet.mjs:2930

`Static`inheritanceChain

inheritanceChain(): Generator<typeof ItemSheetPF, void, unknown>
Copy of AppV2 function

Returns Generator<typeof ItemSheetPF, void, unknown>
Todo
Remove with AppV2 conversion
Inherited from ItemSheetPF.inheritanceChain
- Defined in module/applications/item/item-sheet.mjs:88

Class ItemSheetPF_Container

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ItemSheetPF_Container

Properties

Internal_activeEdits

item

Static_warnedAppV1

Static Internal ExperimentalACTIONS

Type Declaration

__proto__: null

adjustQuantity: Object

convertCurrency: (...this: any, event: PointerEvent, target: HTMLElement) => Promise<void>

createItem: Object

deleteItem: Object

displayItemCard: Object

dupeItem: Object

editItem: Object

takeItem: Object

toggleIdentified: Object

toggleItemSummary: Object

useItem: Object

StaticBASE_APPLICATION

Todo

Static InternalEDIT_TRACKING

StaticWHEEL_UPDATE_SCOPES

Accessors

abortSignal

Returns any

template

Returns string

title

Returns string

StaticdefaultOptions

Default Value

Methods

_applySectionFilter

Parameters

Returns boolean

Protected_canDragDrop

Returns boolean

_canDragStart

Parameters

Returns boolean

_commitSpanTextInputValue

Parameters

Returns Promise<void>

Throws

_getContentSources

Returns object[]

_getSidebarTooltipContent

Parameters

Returns string

_getUniqueActionName

Parameters

Returns string

_initializeActions

Returns void

Todo

_onChange

Parameters

Returns boolean

_onChangeDrop

Parameters

Returns Promise<void>

Protected_onClick

Parameters

Returns boolean

Protected_onClickAction

Parameters

Returns boolean

Protected_onContext

Parameters

`Internal`_activeEdits

`Static`_warnedAppV1

`Static` `Internal` `Experimental`ACTIONS

proto: null

`Static`BASE_APPLICATION

`Static` `Internal`EDIT_TRACKING

`Static`WHEEL_UPDATE_SCOPES

`Static`defaultOptions

`Protected`_canDragDrop

`Protected`_onClick

`Protected`_onClickAction

`Protected`_onContext

`Protected`_onContextAction

`Protected`_onDropGeneric

`Protected`_prepareContents

`Protected`_prepareItem