Class ControlCore<T, F, A>`Abstract`

Type Parameters

Hierarchy

ControlCoreBase<F, A>
- ControlCore

Constructors

constructor

new ControlCore<T, F, A>(pluginConfig, fieldHandler, control?): ControlCore<T, F, A>
Type Parameters
- T extends IPluginFieldOptionsBase
- F extends IPluginFieldHandler<A>
- A extends IPluginFieldValueBase
Parameters
- pluginConfig: IPluginConfig<IServerSettingsBase, IProjectSettingsBase>
- fieldHandler: F
- Optional control: JQuery
Returns ControlCore<T, F, A>
Inherited from ControlCoreBase.constructor
- Defined in ts/sdk/plugins/ControlCore.ts:71

Properties

`Protected` _root

_root: JQuery

`Protected` controlConfig

controlConfig: IPluginFieldParameterBase<T>

disableDelayedShow

disableDelayedShow: boolean

`Protected` editor

editor: JQuery

fieldHandler

fieldHandler: F

needsLatest

needsLatest: boolean

`Protected` originalValue

originalValue: IPluginFieldValueBase

pluginConfig

pluginConfig: IPluginConfig<IServerSettingsBase, IProjectSettingsBase>

`Protected` settings

settings: IControlOptions

`Static` defaultOptions

defaultOptions: IControlOptions = ...

Methods

`Protected` createHelp

createHelp(settings): JQuery
Parameters
- settings: IBaseControlOptions
Returns JQuery
Inherited from ControlCoreBase.createHelp
- Defined in build/js/core/common/UI/Controls/BaseControl.d.ts:72

destroy

destroy(): void
Returns void
Inherited from ControlCoreBase.destroy
- Defined in ts/sdk/plugins/ControlCore.ts:175

getFieldHandler

getFieldHandler(): F
Returns F
Inherited from ControlCoreBase.getFieldHandler
- Defined in build/js/core/common/UI/Controls/BaseControl.d.ts:70

getGroup

getGroup(): string
CUSTOM SECTION

Returns string
Inherited from ControlCoreBase.getGroup
- Defined in ts/sdk/plugins/ControlCore.ts:187

getHelp

getHelp(): string
Returns string
Inherited from ControlCoreBase.getHelp
- Defined in ts/sdk/plugins/ControlCore.ts:191

getName

getName(): string
Returns string
Inherited from ControlCoreBase.getName
- Defined in ts/sdk/plugins/ControlCore.ts:198

getValueAsync

getValueAsync(): Promise<string>
this method is called by the UI to retrieve the string to be saved in the database

Returns Promise<string>
Inherited from ControlCoreBase.getValueAsync
- Defined in ts/sdk/plugins/ControlCore.ts:127

hasChangedAsync

hasChangedAsync(): Promise<boolean>
this method is called by the UI to figure out if the control's value changed

Returns Promise<boolean>
Inherited from ControlCoreBase.hasChangedAsync
- Defined in ts/sdk/plugins/ControlCore.ts:154

init

init(options): void
Parameters
- options: IControlOptions
Returns void
Inherited from ControlCoreBase.init
- Defined in ts/sdk/plugins/ControlCore.ts:81

`Protected` initEditor

initEditor(): void
method to call to initialize the editor, e.g. to attach handlers to checkboxes etc

Returns void
Inherited from ControlCoreBase.initEditor
- Defined in ts/sdk/plugins/ControlCore.ts:122

`Protected` `Abstract` isSame

isSame(a, b): any
Parameters
- a: IPluginFieldValueBase
- b: IPluginFieldValueBase
Returns any
Inherited from ControlCoreBase.isSame
- Defined in ts/sdk/plugins/ControlCore.ts:165

refresh

refresh(): void
Returns void
Inherited from ControlCoreBase.refresh
- Defined in ts/sdk/plugins/ControlCore.ts:167

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>
Inherited from ControlCoreBase.renderAsync
- Defined in ts/sdk/plugins/ControlCore.ts:202

`Protected` renderControl

renderControl(readOnly, params?): JQuery
this method renders a user input field in an item.
Parameters
- readOnly: boolean
- Optional params: IPluginPrintParamsBase
Returns JQuery
Read Only
is set to true if the user cannot edit the data (e.g. in history or while printing)

Params
are can be parameter added by the printing configuration, to configure how something should be printed
Overrides ControlCoreBase.renderControl
- Defined in ts/sdk/plugins/ControlCore.ts:249

`Protected` `Abstract` renderEditor

renderEditor(fieldId, value, options): JQuery
Parameters
- fieldId: string
- value: IPluginFieldValueBase
- options: IPluginFieldOptionsBase
Returns JQuery
Inherited from ControlCoreBase.renderEditor
- Defined in ts/sdk/plugins/ControlCore.ts:147

`Protected` `Abstract` renderPrint

renderPrint(fieldId, value, options, params): JQuery
Parameters
- fieldId: string
- value: IPluginFieldValueBase
- options: IPluginFieldOptionsBase
- params: IPluginPrintParamsBase
Returns JQuery
Inherited from ControlCoreBase.renderPrint
- Defined in ts/sdk/plugins/ControlCore.ts:140

resizeItem

resizeItem(): void
Returns void
Inherited from ControlCoreBase.resizeItem
- Defined in ts/sdk/plugins/ControlCore.ts:181

setFieldHandler

setFieldHandler(fieldHandler): void
Parameters
- fieldHandler: F
Returns void
Inherited from ControlCoreBase.setFieldHandler
- Defined in build/js/core/common/UI/Controls/BaseControl.d.ts:71

setValue

setValue(newValue, reset?): void
Parameters
- newValue: string
- Optional reset: boolean
Returns void
Inherited from ControlCoreBase.setValue
- Defined in ts/sdk/plugins/ControlCore.ts:171

Generated using TypeDoc