Class FormContextBuilder

Utility to construct a FormContext hierarchy from a DialogRedirection.

Hierarchy

FormContextBuilder

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new FormContextBuilder(): FormContextBuilder

- Defined in catavolt/dialog.ts:5578
Returns FormContextBuilder

Properties

Private _actionSource

_actionSource: ActionSource

Private _dialogRedirection

_dialogRedirection: DialogRedirection

Private _initialFormXOpenFr

_initialFormXOpenFr: Future<XOpenDialogModelResult>

Private _initialXFormDefFr

_initialXFormDefFr: Future<XFormDef>

Private _sessionContext

_sessionContext: SessionContext

Accessors

actionSource

get actionSource(): ActionSource

- Defined in catavolt/dialog.ts:5588
Get the action source for this Pane

Returns ActionSource

dialogRedirection

get dialogRedirection(): DialogRedirection

- Defined in catavolt/dialog.ts:5676
Get the DialogRedirection with which this Form was constructed

Returns DialogRedirection

sessionContext

get sessionContext(): SessionContext

- Defined in catavolt/dialog.ts:5680
Returns SessionContext

Methods

build

build(): Future<FormContext>

- Defined in catavolt/dialog.ts:5592
Returns Future<FormContext>

Private buildFormModelForNestedForm

buildFormModelForNestedForm(topFormXOpen: XOpenDialogModelResult, formModelComp: XFormModelComp, childFormModelComps: Array<XFormModelComp>): XFormModel

- Defined in catavolt/dialog.ts:5685
Parameters
- topFormXOpen: XOpenDialogModelResult
- formModelComp: XFormModelComp
- childFormModelComps: Array<XFormModelComp>
Returns XFormModel

buildFromOpenForm

buildFromOpenForm(formXOpen: XOpenDialogModelResult, isEditor: boolean): Future<FormContext>

- Defined in catavolt/dialog.ts:5613
Parameters
- formXOpen: XOpenDialogModelResult
- isEditor: boolean
Returns Future<FormContext>

Private completeOpenPromise

completeOpenPromise(flattened: Array<any>): Try<FormDef>

- Defined in catavolt/dialog.ts:5693
Parameters
- flattened: Array<any>
Returns Try<FormDef>

Private containsNestedForms

containsNestedForms(formXOpen: XOpenDialogModelResult, xFormDef: XFormDef): boolean

- Defined in catavolt/dialog.ts:5734
Parameters
- formXOpen: XOpenDialogModelResult
- xFormDef: XFormDef
Returns boolean

Private createChildrenContexts

createChildrenContexts(formDef: FormDef): Array<PaneContext>

- Defined in catavolt/dialog.ts:5740
Parameters
- formDef: FormDef
Returns Array<PaneContext>

Private fetchChildrenActiveColDefs

fetchChildrenActiveColDefs(formXOpen: XOpenDialogModelResult): Future<Array<Try<XGetActiveColumnDefsResult>>>

- Defined in catavolt/dialog.ts:5770
Parameters
- formXOpen: XOpenDialogModelResult
Returns Future<Array<Try<XGetActiveColumnDefsResult>>>

Private fetchChildrenMenuDefs

fetchChildrenMenuDefs(formXOpen: XOpenDialogModelResult): Future<Array<Try<Array<MenuDef>>>>

- Defined in catavolt/dialog.ts:5778
Parameters
- formXOpen: XOpenDialogModelResult
Returns Future<Array<Try<Array<MenuDef>>>>

Private fetchChildrenPrintMarkupXMLs

fetchChildrenPrintMarkupXMLs(formXOpen: XOpenDialogModelResult): Future<Array<Try<string>>>

- Defined in catavolt/dialog.ts:5804
Parameters
- formXOpen: XOpenDialogModelResult
Returns Future<Array<Try<string>>>

Private fetchChildrenViewDescs

fetchChildrenViewDescs(formXOpen: XOpenDialogModelResult): Future<Array<Try<XGetAvailableViewDescsResult>>>

- Defined in catavolt/dialog.ts:5786
Parameters
- formXOpen: XOpenDialogModelResult
Returns Future<Array<Try<XGetAvailableViewDescsResult>>>

Private fetchChildrenXPaneDefs

fetchChildrenXPaneDefs(formXOpen: XOpenDialogModelResult, xFormDef: XFormDef): Future<Array<Try<XPaneDef>>>

- Defined in catavolt/dialog.ts:5794
Parameters
- formXOpen: XOpenDialogModelResult
- xFormDef: XFormDef
Returns Future<Array<Try<XPaneDef>>>

Private fetchXFormDef

fetchXFormDef(dialogHandle: DialogHandle, formPaneId: string): Future<XFormDef>

- Defined in catavolt/dialog.ts:5818
Parameters
- dialogHandle: DialogHandle
- formPaneId: string
Returns Future<XFormDef>

Private fetchXFormDefWithXOpenResult

fetchXFormDefWithXOpenResult(xformOpenResult: XOpenDialogModelResult): Future<XFormDef>

- Defined in catavolt/dialog.ts:5812
Parameters
- xformOpenResult: XOpenDialogModelResult
Returns Future<XFormDef>

Private loadNestedForms

loadNestedForms(formXOpen: XOpenDialogModelResult, xFormDef: XFormDef): Array<Future<FormContext>>

- Defined in catavolt/dialog.ts:5830
Parameters
- formXOpen: XOpenDialogModelResult
- xFormDef: XFormDef
Returns Array<Future<FormContext>>

Private openChildren

openChildren(formXOpen: XOpenDialogModelResult): Future<Array<Try<XOpenDialogModelResult>>>

- Defined in catavolt/dialog.ts:5871
Parameters
- formXOpen: XOpenDialogModelResult
Returns Future<Array<Try<XOpenDialogModelResult>>>

Private retrieveChildFormContexts

retrieveChildFormContexts(flattened: Array<any>): Array<FormContext>

- Defined in catavolt/dialog.ts:5890
Parameters
- flattened: Array<any>
Returns Array<FormContext>

Static createWithInitialForm

createWithInitialForm(initialFormXOpenFr: Future<XOpenDialogModelResult>, initialXFormDefFr: Future<XFormDef>, dialogRedirection: DialogRedirection, actionSource: ActionSource, sessionContext: SessionContext): FormContextBuilder

- Defined in catavolt/dialog.ts:5517
Parameters
- initialFormXOpenFr: Future<XOpenDialogModelResult>
- initialXFormDefFr: Future<XFormDef>
- dialogRedirection: DialogRedirection
- actionSource: ActionSource
- sessionContext: SessionContext
Returns FormContextBuilder

Static createWithRedirection

createWithRedirection(dialogRedirection: DialogRedirection, actionSource: ActionSource, sessionContext: SessionContext): FormContextBuilder

- Defined in catavolt/dialog.ts:5507
Parameters
- dialogRedirection: DialogRedirection
- actionSource: ActionSource
- sessionContext: SessionContext
Returns FormContextBuilder

Static fetchChildActiveColDefs

fetchChildActiveColDefs(redirection: DialogRedirection, sessionContext: SessionContext): Future<XGetActiveColumnDefsResult>

- Defined in catavolt/dialog.ts:5531
Parameters
- redirection: DialogRedirection
- sessionContext: SessionContext
Returns Future<XGetActiveColumnDefsResult>

Static fetchChildMenuDefs

fetchChildMenuDefs(redirection: DialogRedirection, sessionContext: SessionContext): Future<Array<MenuDef>>

- Defined in catavolt/dialog.ts:5539
Parameters
- redirection: DialogRedirection
- sessionContext: SessionContext
Returns Future<Array<MenuDef>>

Static fetchChildPrintMarkupXML

fetchChildPrintMarkupXML(child: XFormModelComp): Future<string>

- Defined in catavolt/dialog.ts:5559
Parameters
- child: XFormModelComp
Returns Future<string>

Static fetchChildViewDescs

fetchChildViewDescs(redirection: DialogRedirection, sessionContext: SessionContext): Future<XGetAvailableViewDescsResult>

- Defined in catavolt/dialog.ts:5547
Parameters
- redirection: DialogRedirection
- sessionContext: SessionContext
Returns Future<XGetAvailableViewDescsResult>

Static fetchChildXPaneDef

fetchChildXPaneDef(dialogHandle: DialogHandle, paneId: string, sessionContext: SessionContext): Future<XPaneDef>

- Defined in catavolt/dialog.ts:5555
Parameters
- dialogHandle: DialogHandle
- paneId: string
- sessionContext: SessionContext
Returns Future<XPaneDef>

Static getFlattenedResults

getFlattenedResults(arrayOfTries: Array<Try<any>>): Try<Array<any>>

- Defined in catavolt/dialog.ts:5571
Parameters
- arrayOfTries: Array<Try<any>>
Returns Try<Array<any>>

Generated using TypeDoc