Class PrintProcessor

************************************ Processor class *******************************************

Implements

IPrintProcessor

Index

Constructors

Properties

formatter functionDefaults? globals? mf? onError possibleTargets stylesheets FIELD_FUNCTION_PREFIX FIELD_FUNCTION_TYPE conditions fieldIterators functions itemIterators itemSorter labelIterators

Methods

addRows addScriptInfo applyDepth enumeratePossibleTargets evaluateCondition extractClassesFromTable getCustomStylesheet getItemFormatter getRiskControlCategories getSubTableCells getTableData hasMergeMacro mergeCells prepareProcessing processBlockFormatter processFieldsFormatter processFunctionMacro processItem processListFormatter processMacros processPrintFormatterMacro processSection processTableFormatter processTraceFormatter sortItems addConditionFunction addFieldIterator addFunction addItemIterator addItemSorter addLabelIterator editFunctionOptions editStyle functionHasOptions getAllFunctions getAllIterators getCdataAsJSON getCdataAsText getConditionFunction getFieldAndLabelsIteratorsDropdown getFieldFunction getFieldFunctionId getFieldIterator getFunction getFunctions getItemConditionDropdown getItemIterator getItemIteratorsDropdown getItemSorter getItemSorterDropdown getItemSorters getJsonConfig getLabelIterator getUserName openEditor showOptionsEditor

Constructors

constructor

new PrintProcessor(): PrintProcessor
Returns PrintProcessor
- Defined in print/src/PrintProcessor.ts:102

Properties

`Private` formatter

formatter: IPrintCustomFormatter = ...

`Private` `Optional` functionDefaults

functionDefaults?: IGlobalPrintFunctionParams

`Optional` globals

globals?: IPrintGlobals

`Private` `Optional` mf

mf?: JQuery

`Private` onError

onError: ((message) => void) = ...

Type declaration

- (message): void
- Parameters
  - message: string
  Returns void

`Private` possibleTargets

possibleTargets: string[] = []

`Private` stylesheets

stylesheets: {
[key: string]: string;
} = {}

Type declaration

[key: string]: string

`Static` FIELD_FUNCTION_PREFIX

FIELD_FUNCTION_PREFIX: string = "_field_"

`Static` FIELD_FUNCTION_TYPE

FIELD_FUNCTION_TYPE: string = "fieldtype"

`Static` conditions

conditions: IConditionFunctionMap = {}

`Static` fieldIterators

fieldIterators: IPrintIteratorMap = {}

`Static` functions

functions: IPrintFunctionMap = {}

`Static` itemIterators

itemIterators: IPrintIteratorMap = {}

`Static` itemSorter

itemSorter: IPrintSorterMap = {}

`Static` labelIterators

labelIterators: IPrintIteratorMap = {}

Methods

`Private` addRows

addRows(rowsContent, formatter, formatterId, parameters, selection, depth, redlining): Promise<void>
Parameters
- rowsContent: IPrintRowContent[]
- formatter: IPrintFormatterTable
- formatterId: string
- parameters: IPrintTableMacro
- selection: string[]
- depth: number
- redlining: null | string[]
Returns Promise<void>
- Defined in print/src/PrintProcessor.ts:849

`Private` addScriptInfo

addScriptInfo(fct, info): string
Parameters
- fct: string
- info: string
Returns string
- Defined in print/src/PrintProcessor.ts:1185

`Private` applyDepth

applyDepth(content, depth): string
Parameters
- content: string
- depth: number
Returns string
- Defined in print/src/PrintProcessor.ts:1144

`Private` enumeratePossibleTargets

enumeratePossibleTargets(target): void
Parameters
- target: string
Returns void
- Defined in print/src/PrintProcessor.ts:1265

`Private` evaluateCondition

evaluateCondition(condition, params, itemOrFolderRef, object, selection): Promise<null | boolean>
Parameters
- condition: undefined | string
- params: undefined | IPrintConditionParams
- itemOrFolderRef: string
- object: JQuery
- selection: null | string[]
Returns Promise<null | boolean>
- Defined in print/src/PrintProcessor.ts:1220

`Private` extractClassesFromTable

extractClassesFromTable(beforeString): string
Parameters
- beforeString: string
Returns string
- Defined in print/src/PrintProcessor.ts:813

getCustomStylesheet

getCustomStylesheet(): string
Misc helper

Returns string
Implementation of IPrintProcessor.getCustomStylesheet
- Defined in print/src/PrintProcessor.ts:1133

`Private` getItemFormatter

getItemFormatter(uid): null | IPrintFormatter
Parameters
- uid: string
Returns null | IPrintFormatter
- Defined in print/src/PrintProcessor.ts:1719

`Private` getRiskControlCategories

getRiskControlCategories(category): string[]
Parameters
- category: JQuery
Returns string[]
- Defined in print/src/PrintProcessor.ts:160

`Private` getSubTableCells

getSubTableCells(formatterId, parameters, itemOrFolder): Promise<IPrintRenderedCell[][]>
Parameters
- formatterId: string
- parameters: IPrintMacroParams
- itemOrFolder: string
Returns Promise<IPrintRenderedCell[][]>
- Defined in print/src/PrintProcessor.ts:1047

getTableData

getTableData(tableId, selection): Promise<string>
Parameters
- tableId: string
- selection: string[]
Returns Promise<string>
Implementation of IPrintProcessor.getTableData
- Defined in print/src/PrintProcessor.ts:297

`Private` hasMergeMacro

hasMergeMacro(render): boolean
Parameters
- render: string
Returns boolean
- Defined in print/src/PrintProcessor.ts:1173

`Private` mergeCells

mergeCells(cells): string[]
Helper for building tables
Parameters
- cells: string[]
Returns string[]
- Defined in print/src/PrintProcessor.ts:790

prepareProcessing

prepareProcessing(mf, onError, format): void
Iterator Blocks
Parameters
- mf: JQuery
- onError: ((message) => void)
  - - (message): void
    - Parameters
      message: string
      Returns void
- format: string
Returns void
Implementation of IPrintProcessor.prepareProcessing
- Defined in print/src/PrintProcessor.ts:117

`Private` processBlockFormatter

processBlockFormatter(formatter, itemOrFolder): Promise<string>
Parameters
- formatter: IPrintFormatterBlock
- itemOrFolder: string
Returns Promise<string>
- Defined in print/src/PrintProcessor.ts:328

`Private` processFieldsFormatter

processFieldsFormatter(formatter, itemOrFolder): Promise<string>
Parameters
- formatter: IPrintFormatterFields
- itemOrFolder: string
Returns Promise<string>
- Defined in print/src/PrintProcessor.ts:350

`Private` processFunctionMacro

processFunctionMacro(macro, script, formatting, itemOrFolder, depth, callerId, printFunctionParams, redlining): Promise<string>
Parameters
- macro: IPrintFunctionMacro
- script: string
- formatting: string
- itemOrFolder: string
- depth: number
- callerId: string
- printFunctionParams: any
- redlining: null | string[]
Returns Promise<string>
- Defined in print/src/PrintProcessor.ts:689

`Private` processItem

processItem(formatter, itemOrFolder): Promise<string>
Main Processing functions to handle items from the print project
Parameters
- formatter: IPrintFormatter
- itemOrFolder: string
Returns Promise<string>
- Defined in print/src/PrintProcessor.ts:307

`Private` processListFormatter

processListFormatter(macro, selection, depth, redlining): Promise<string>
Parameters
- macro: IPrintItemMacro
- selection: string[]
- depth: number
- redlining: null | string[]
Returns Promise<string>
- Defined in print/src/PrintProcessor.ts:490

`Private` processMacros

processMacros(formatting, callerId, printFunctionParams, itemOrFolder, depth, redlining): Promise<string>
processing of "json" macros like {execute:"function", parameters:{...}}
Parameters
- formatting: string
- callerId: string
- printFunctionParams: any
- itemOrFolder: string
- depth: number
- redlining: null | string[]
Returns Promise<string>
- Defined in print/src/PrintProcessor.ts:594

`Private` processPrintFormatterMacro

processPrintFormatterMacro(macro, script, formatting, itemOrFolder): Promise<string>
Parameters
- macro: IPrintItemMacro
- script: string
- formatting: string
- itemOrFolder: string
Returns Promise<string>
- Defined in print/src/PrintProcessor.ts:669

processSection

processSection(formatter, section, projectOverwrites, selection, possibleTargets): Promise<IProcessResult>
Parameters
- formatter: IPrintCustomFormatter
- section: ICustomSection
- projectOverwrites: IPrintFunctionParamsOverwrites
- selection: string[]
- possibleTargets: string[]
Returns Promise<IProcessResult>
Implementation of IPrintProcessor.processSection
- Defined in print/src/PrintProcessor.ts:185

`Private` processTableFormatter

processTableFormatter(macro, selection, redlining): Promise<string>
Parameters
- macro: IPrintTableMacro
- selection: string[]
- redlining: null | string[]
Returns Promise<string>
- Defined in print/src/PrintProcessor.ts:554

`Private` processTraceFormatter

processTraceFormatter(formatter, item, depth): Promise<string>
Parameters
- formatter: IPrintFormatterTraces
- item: string
- depth: number
Returns Promise<string>
- Defined in print/src/PrintProcessor.ts:439

`Private` sortItems

sortItems(itemIds, params): void
Parameters
- itemIds: string[]
- params: IPrintItemIteratorParams
Returns void
- Defined in print/src/PrintProcessor.ts:1284

`Static` addConditionFunction

addConditionFunction(uid, fctn): void
Parameters
- uid: string
- fctn: IConditionFunction
Returns void
- Defined in print/src/PrintProcessor.ts:1838

`Static` addFieldIterator

addFieldIterator(uid, iterator): void
Parameters
- uid: string
- iterator: IPrintIterator
Returns void
- Defined in print/src/PrintProcessor.ts:1798

`Static` addFunction

addFunction(uid, fctn): void
Parameters
- uid: string
- fctn: IPrintFunction
Returns void
- Defined in print/src/PrintProcessor.ts:1810

`Static` addItemIterator

addItemIterator(uid, iterator): void
Parameters
- uid: string
- iterator: IPrintIterator
Returns void
- Defined in print/src/PrintProcessor.ts:1753

`Static` addItemSorter

addItemSorter(uid, sorter): void
Parameters
- uid: string
- sorter: IPrintSorter
Returns void
- Defined in print/src/PrintProcessor.ts:1726

`Static` addLabelIterator

addLabelIterator(uid, iterator): void
Parameters
- uid: string
- iterator: IPrintIterator
Returns void
- Defined in print/src/PrintProcessor.ts:1786

`Static` editFunctionOptions

editFunctionOptions(currentValue, onUpdate): void
Parameters
- currentValue: string
- onUpdate: ((newOptions) => void)
  - - (newOptions): void
    - Parameters
      newOptions: string
      Returns void
Returns void
- Defined in print/src/PrintProcessor.ts:1336

`Static` editStyle

editStyle(wrap): void
Parameters
- wrap: JQuery
Returns void
- Defined in print/src/PrintProcessor.ts:1658

`Static` functionHasOptions

functionHasOptions(functionUid): boolean
Parameters
- functionUid: string
Returns boolean
- Defined in print/src/PrintProcessor.ts:1330

`Static` getAllFunctions

getAllFunctions(): IPrintBaseFunctionMap
Returns IPrintBaseFunctionMap
- Defined in print/src/PrintProcessor.ts:1859

`Static` getAllIterators

getAllIterators(): IPrintBaseFunctionMap
Returns IPrintBaseFunctionMap
- Defined in print/src/PrintProcessor.ts:1870

`Static` getCdataAsJSON

getCdataAsJSON(node): any
Parameters
- node: Element
Returns any
- Defined in print/src/PrintProcessor.ts:1889

`Static` getCdataAsText

getCdataAsText(node, escapeHtmlEntities): string
Parameters
- node: Element
- escapeHtmlEntities: boolean
Returns string
- Defined in print/src/PrintProcessor.ts:1930

`Static` getConditionFunction

getConditionFunction(uid): null | IConditionFunction
Parameters
- uid: string
Returns null | IConditionFunction
- Defined in print/src/PrintProcessor.ts:1843

`Static` getFieldAndLabelsIteratorsDropdown

getFieldAndLabelsIteratorsDropdown(): IDropdownOption[]
Returns IDropdownOption[]
- Defined in print/src/PrintProcessor.ts:1991

`Static` getFieldFunction

getFieldFunction(uid): null | IPrintFunction
Parameters
- uid: string
Returns null | IPrintFunction
- Defined in print/src/PrintProcessor.ts:1821

`Static` getFieldFunctionId

getFieldFunctionId(uid): string
Parameters
- uid: string
Returns string
- Defined in print/src/PrintProcessor.ts:1818

`Static` getFieldIterator

getFieldIterator(uid): null | IPrintFieldIterator
Parameters
- uid: string
Returns null | IPrintFieldIterator
- Defined in print/src/PrintProcessor.ts:1803

`Static` getFunction

getFunction(uid): null | IPrintFunction
Parameters
- uid: string
Returns null | IPrintFunction
- Defined in print/src/PrintProcessor.ts:1813

`Static` getFunctions

getFunctions(group): IPrintFunctionMap
********************************* manage formatters ***********************************
Parameters
- group: string
Returns IPrintFunctionMap
- Defined in print/src/PrintProcessor.ts:1317

`Static` getItemConditionDropdown

getItemConditionDropdown(): IDropdownOption[]
Returns IDropdownOption[]
- Defined in print/src/PrintProcessor.ts:1849

`Static` getItemIterator

getItemIterator(uid, quiet?): null | IPrintItemIterator
Parameters
- uid: string
- Optional quiet: boolean
Returns null | IPrintItemIterator
- Defined in print/src/PrintProcessor.ts:1757

`Static` getItemIteratorsDropdown

getItemIteratorsDropdown(items, folders, allowNoIterator): IDropdownOption[]
Parameters
- items: boolean
- folders: boolean
- allowNoIterator: boolean
Returns IDropdownOption[]
- Defined in print/src/PrintProcessor.ts:1773

`Static` getItemSorter

getItemSorter(uid): null | IPrintSorter
Parameters
- uid: string
Returns null | IPrintSorter
- Defined in print/src/PrintProcessor.ts:1737

`Static` getItemSorterDropdown

getItemSorterDropdown(): IDropdownOption[]
Returns IDropdownOption[]
- Defined in print/src/PrintProcessor.ts:1742

`Static` getItemSorters

getItemSorters(): IPrintSorterMap
Returns IPrintSorterMap
- Defined in print/src/PrintProcessor.ts:1731

`Static` getJsonConfig

getJsonConfig(config, mf): any
Parameters
- config: string
- mf: JQuery
Returns any
- Defined in print/src/PrintProcessor.ts:1877

`Static` getLabelIterator

getLabelIterator(uid): null | IPrintLabelIterator
Parameters
- uid: string
Returns null | IPrintLabelIterator
- Defined in print/src/PrintProcessor.ts:1791

`Static` getUserName

getUserName(user, mf, first, last, login, email): string
Parameters
- user: string
- mf: JQuery
- first: boolean
- last: boolean
- login: boolean
- email: boolean
Returns string
- Defined in print/src/PrintProcessor.ts:1964

`Static` openEditor

openEditor(fct, params, onUpdate): boolean
Parameters
- fct: IPrintBaseFunction
- params: IAttributePrimitiveParams
- onUpdate: ((newParams) => void)
  - - (newParams): void
    - Parameters
      newParams: IAttributePrimitiveParams
      Returns void
Returns boolean
- Defined in print/src/PrintProcessor.ts:1434

`Static` showOptionsEditor

showOptionsEditor(fctName, currentValue, onUpdate): void
Parameters
- fctName: string
- currentValue: string
- onUpdate: ((newValue) => void)
  - - (newValue): void
    - Parameters
      newValue: string
      Returns void
Returns void
- Defined in print/src/PrintProcessor.ts:1357

Class PrintProcessor

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PrintProcessor

Properties

Private formatter

Private Optional functionDefaults

Optional globals

Private Optional mf

Private onError

Type declaration

Parameters

message: string

Returns void

Private possibleTargets

Private stylesheets

Type declaration

[key: string]: string

Static FIELD_FUNCTION_PREFIX

Static FIELD_FUNCTION_TYPE

Static conditions

Static fieldIterators

Static functions

Static itemIterators

Static itemSorter

Static labelIterators

Methods

Private addRows

Parameters

rowsContent: IPrintRowContent[]

formatter: IPrintFormatterTable

formatterId: string

parameters: IPrintTableMacro

selection: string[]

depth: number

redlining: null | string[]

Returns Promise<void>

Private addScriptInfo

Parameters

fct: string

info: string

Returns string

Private applyDepth

Parameters

content: string

depth: number

Returns string

Private enumeratePossibleTargets

Parameters

target: string

Returns void

Private evaluateCondition

Parameters

condition: undefined | string

params: undefined | IPrintConditionParams

itemOrFolderRef: string

object: JQuery

selection: null | string[]

Returns Promise<null | boolean>

Private extractClassesFromTable

Parameters

beforeString: string

Returns string

getCustomStylesheet

Returns string

Private getItemFormatter

Parameters

uid: string

Returns null | IPrintFormatter

Private getRiskControlCategories

Parameters

category: JQuery

Returns string[]

Private getSubTableCells

Parameters

`Private` formatter

`Private` `Optional` functionDefaults

`Optional` globals

`Private` `Optional` mf

`Private` onError

`Private` possibleTargets

`Private` stylesheets

`Static` FIELD_FUNCTION_PREFIX

`Static` FIELD_FUNCTION_TYPE

`Static` conditions

`Static` fieldIterators

`Static` functions

`Static` itemIterators

`Static` itemSorter

`Static` labelIterators

`Private` addRows

`Private` addScriptInfo

`Private` applyDepth

`Private` enumeratePossibleTargets

`Private` evaluateCondition

`Private` extractClassesFromTable

`Private` getItemFormatter

`Private` getRiskControlCategories

`Private` getSubTableCells

`Private` hasMergeMacro

`Private` mergeCells

`Private` processBlockFormatter

`Private` processFieldsFormatter

`Private` processFunctionMacro

`Private` processItem

`Private` processListFormatter

`Private` processMacros

`Private` processPrintFormatterMacro