docs » plugins.core.watchfolders.manager.panel


CommandPost Preferences Panel.

API Overview

  • Constants - Useful values which cannot be changed
  • Constructors - API calls which return an object, typically one that offers API methods
  • Methods - API calls which can only be made on an object returned by a constructor

API Documentation

Constants

DEFAULT_PRIORITY

Signature plugins.core.watchfolders.manager.panel.DEFAULT_PRIORITY
Type Constant
Description The default priority for panels.

HANDLER_PRIORITY

Signature plugins.core.watchfolders.manager.panel.HANDLER_PRIORITY
Type Constant
Description The default priority for handler scripts.

Constructors

new

Signature plugins.core.watchfolders.manager.panel.new(priority, id) -> plugins.core.watchfolders.manager.panel
Type Constructor
Description Constructs a new panel with the specified priority and ID.
Parameters
  • * priority - Defines the order in which the panel appears.
  • * id - The unique ID for the panel.
  • * webview - The webview the panel is attached to.

Methods

addCheckbox

Signature plugins.core.watchfolders.manager.panel:addCheckbox(priority, params) -> panel
Type Method
Description Adds a checkbox to the panel with the specified priority and params.
Parameters
  • `priority` - The priority number for the checkbox.
  • `params` - The set of parameters for the checkbox.
Returns
  • The panel.
  • Notes:
  • * The `params` can contain the following fields:
  • ** `id` - (optional) The unique ID. If none is provided, one will be generated.
  • ** `name` - (optional) The name of the checkbox field.
  • ** `label` - (optional) The text label to display after the checkbox.
  • ** `onchange` - (optional) a function that will get called when the checkbox value changes. It will be passed two parameters, `id` and `params`, the latter of which is a table containing the `value` and `checked` values of the checkbox.
  • ** `class` - (optional) the CSS class list to apply to the checkbox.
Notes
  • * The `params` can contain the following fields:
  • ** `id` - (optional) The unique ID. If none is provided, one will be generated.
  • ** `name` - (optional) The name of the checkbox field.
  • ** `label` - (optional) The text label to display after the checkbox.
  • ** `onchange` - (optional) a function that will get called when the checkbox value changes. It will be passed two parameters, `id` and `params`, the latter of which is a table containing the `value` and `checked` values of the checkbox.
  • ** `class` - (optional) the CSS class list to apply to the checkbox.

addContent

Signature plugins.core.watchfolders.manager.panel:addContent(priority, content) -> panel
Type Method
Description Adds the specified content to the panel, with the specified priority order.
Parameters
  • * `priority` - the priority order of the content.
  • * `content` - a value that can be converted to a string.
  • * `unescaped` - if `true`, the content will not be escaped. Defaults to true.
Returns
  • * The panel.

results matching ""

    No results matching ""