Class ControlCoreBase<T, AAA>Abstract

constructor

• new ControlCoreBase<T, AAA>(pluginConfig, fieldHandler, control?): ControlCoreBase<T, AAA>

• Type Parameters

  • T extends IPluginFieldHandler<AAA>

  • AAA extends IPluginFieldValueBase

  Parameters

  • pluginConfig: IPluginConfig<IServerSettingsBase, IProjectSettingsBase>

  • fieldHandler: T

  • Optional control: JQuery

  Returns ControlCoreBase<T, AAA>

pluginConfig

Static defaultOptions

destroy

• destroy(): void

• Returns void

getGroup

• getGroup(): string

• CUSTOM SECTION

  Returns string

getHelp

• getHelp(): string

• Returns string

getName

• getName(): string

• Returns string

getValueAsync

• getValueAsync(): Promise<string>

• this method is called by the UI to retrieve the string to be saved in the database

  Returns Promise<string>

hasChangedAsync

• hasChangedAsync(): Promise<boolean>

• this method is called by the UI to figure out if the control's value changed

  Returns Promise<boolean>

init

• init(options): void

• Parameters

  • options: IControlOptions

  Returns void

refresh

• refresh(): void

• Returns void

renderAsync

• renderAsync(overwrites, paramsIn, itemOrFolderRef, itemOrFolder, mf, globals, possibleTargets, onError): Promise<string>

• Parameters

  • overwrites: IGlobalPrintFunctionParams

  • paramsIn: IPrintFunctionParams

  • itemOrFolderRef: string

  • itemOrFolder: JQuery

  • mf: JQuery

  • globals: IPrintGlobals

  • possibleTargets: string[]

  • onError: ((message) => void)

    • • (message): void

      • Parameters

        • message: string

        Returns void

  Returns Promise<string>

resizeItem

• resizeItem(): void

• Returns void

setValue

• setValue(newValue, reset?): void

• Parameters

  • newValue: string

  • Optional reset: boolean

  Returns void