docs » plugins.core.watchfolders.manager.panel


Watch Folder Panel Manager.

API Overview

API Documentation

Constructors

new

Signature plugins.core.watchfolders.manager.panel.new(priority, id) -> panel object
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.
Returns
  • A panel object

Methods

addButton

Signature plugins.core.watchfolders.manager.panel:addButton(priority, params, itemFn, customWidth) -> panel
Type Method
Description Adds a button to the panel with the specified priority and params.
Parameters
  • `priority` - The priority number for the button.
  • `params` - The set of parameters for the button.
Returns
  • The panel.

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.

addContent

Signature plugins.core.watchfolders.manager.panel:addContent(priority, content[, escaped]) -> 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.
  • `escaped` - if `true`, the content will be escaped.
Returns
  • The panel object

addHandler

Signature plugins.core.watchfolders.manager.panel:addHandler(event, id, handlerFn, keys) -> none
Type Method
Description Adds a handler
Parameters
  • event - The JavaScript event as string
  • id - The ID as string
  • handlerFn - The handler function
  • keys - Table of keys
Returns
  • The panel object

addHeading

Signature plugins.core.watchfolders.manager.panel:addHeading(priority, text, level) -> panel
Type Method
Description Adds a heading to the panel with the specified priority and text.
Parameters
  • `priority` - The priority number for the heading.
  • `text` - The content of the heading as a string.
  • `level` - The level of the heading.
Returns
  • The panel object

addParagraph

Signature plugins.core.watchfolders.manager.panel:addParagraph(priority, content[, escaped[, class]]) -> panel
Type Method
Description Adds a paragraph to the panel with the specified priority and content.
Parameters
  • `priority` - The priority number for the paragraph.
  • `content` - The content you want to include as a string.
  • `escaped` - Whether or not the HTML is escaped as a boolean.
  • `class` - The class name as a string.
Returns
  • The panel object

addPassword

Signature plugins.core.watchfolders.manager.panel:addPassword(priority, params) -> panel
Type Method
Description Adds a password textbox to the panel with the specified priority and params.
Parameters
  • `priority` - The priority number for the password.
  • `params` - The set of parameters for the password.
Returns
  • The panel.

addSelect

Signature plugins.core.watchfolders.manager.panel:addSelect(priority, params) -> panel
Type Method
Description Adds a select to the panel with the specified priority and params.
Parameters
  • `priority` - The priority number for the select.
  • `params` - The set of parameters for the select.
Returns
  • The panel.

addTextbox

Signature plugins.core.watchfolders.manager.panel:addTextbox(priority, params) -> panel
Type Method
Description Adds a textbox to the panel with the specified priority and params.
Parameters
  • `priority` - The priority number for the textbox.
  • `params` - The set of parameters for the textbox.
Returns
  • The panel.

generateContent

Signature plugins.core.watchfolders.manager.panel:generateContent() -> string
Type Method
Description Gets generated toolbar content
Parameters
  • None
Returns
  • A string of generated content

getToolbarItem

Signature plugins.core.watchfolders.manager.panel:getToolbarItem() -> table
Type Method
Description Returns a Toolbar Item
Parameters
  • None
Returns
  • Table of Toolbar Item Values

results matching ""

    No results matching ""