PermissionControl

PermissionControl

A generic application for configuring permissions for various Entity types

Constructor

new PermissionControl()

Source:

Extends

Members

(static) defaultOptions

Source:

_dragDrop :Array.<DragDrop>

Source:
Inherited From:

DragDrop workflow handlers which are active for this Application

Type:

_element :jQuery

Source:
Inherited From:

An internal reference to the HTML element this application renders

Type:
  • jQuery

_scrollPositions :Object|null

Source:
Inherited From:

Track the most recent scroll positions for any vertically scrolling containers

Type:
  • Object | null

_searchFilters :Array.<SearchFilter>

Source:
Inherited From:

SearchFilter handlers which are active for this Application

Type:

_tabs :Array.<Tabs>

Source:
Inherited From:

Tab navigation handlers which are active for this Application

Type:

appId :number

Source:
Inherited From:

The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT

Type:
  • number

editors :Object

Source:
Inherited From:

Keep track of any mce editors which may be active as part of this form The values of this Array are inner-objects with references to the MCE editor and other metadata

Type:
  • Object

element :jQuery|HTMLElement

Source:
Inherited From:

Return the active application element, if it currently exists in the DOM

Type:
  • jQuery | HTMLElement

entity :Entity

Source:
Inherited From:

A convenience accessor for the object property, which in the case of a BaseEntitySheet is an Entity instance.

Type:

filepickers :Array.<FilePicker>

Source:
Inherited From:

Keep track of any FilePicker instances which are associated with this form The values of this Array are inner-objects with references to the FilePicker instances and other metadata

Type:

form :HTMLElement

Source:
Inherited From:

A convenience reference to the form HTMLElement

Type:
  • HTMLElement

id

Source:
Inherited From:

Return the CSS application ID which uniquely references this UI element

object :*

Source:
Inherited From:

The object target which we are using this form to modify

Type:
  • *

options :Object

Source:
Inherited From:

The options provided to this application upon initialization

Type:
  • Object

popOut :boolean

Source:
Inherited From:

Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered

Type:
  • boolean

position :Object

Source:
Inherited From:

Track the current position and dimensions of the Application UI

Type:
  • Object

rendered :boolean

Source:
Inherited From:

Return a flag for whether the Application instance is currently rendered

Type:
  • boolean

template :string

Source:
Inherited From:

The path to the HTML template file which should be used to render the inner content of the app

Type:
  • string

Methods

_createEditor()

Source:
Inherited From:
Deprecated:
  • since 0.7.3
See:

_getHeaderButtons()

Source:
Inherited From:

activateEditor(name, options, initialContent)

Source:
Inherited From:

Activate a named TinyMCE text editor

Parameters:
Name Type Description
name string

The named data field which the editor modifies.

options object

TinyMCE initialization options passed to TextEditor.create

initialContent string

Initial text content for the editor area.

activateListeners(html)

Source:
Inherited From:

Activate the default set of listeners for the Entity sheet These listeners handle basic stuff like form submission or updating images

Parameters:
Name Type Description
html JQuery

The rendered template ready to have listeners attached

bringToTop()

Source:
Inherited From:

Bring the application to the top of the rendering stack

(async) maximize() → {Promise.<void>}

Source:
Inherited From:

Maximize the pop-out window, expanding it to its original size Take no action for applications which are not of the pop-out variety or are already maximized

Returns:

A Promise which resolves once the maximization action has completed

Type
Promise.<void>

(async) minimize() → {Promise.<void>}

Source:
Inherited From:

Minimize the pop-out window, collapsing it to a small tab Take no action for applications which are not of the pop-out variety or apps which are already minimized

Returns:

A Promise which resolves once the minimization action has completed

Type
Promise.<void>

(async) saveEditor(name, removeopt) → {Promise.<void>}

Source:
Inherited From:

Handle saving the content of a specific editor by name

Parameters:
Name Type Attributes Description
name string

The named editor to save

remove boolean <optional>

Remove the editor after saving its content

Returns:
Type
Promise.<void>

setPosition(left, top, width, height, scale) → {Object}

Source:
Inherited From:

Set the application position and store it's new location.

Parameters:
Name Type Description
left number | null

The left offset position in pixels

top number | null

The top offset position in pixels

width number | null

The application width in pixels

height number | string | null

The application height in pixels

scale number | null

The application scale as a numeric factor where 1.0 is default

Returns:

The updated position object for the application containing the new values

Type
Object

(async) submit(optionsopt) → {FormApplication}

Source:
Inherited From:

Submit the contents of a Form Application, processing its content as defined by the Application

Parameters:
Name Type Attributes Description
options object <optional>

Options passed to the _onSubmit event handler

Returns:

Return a self-reference for convenient method chaining

Type
FormApplication