Class FormDef

PaneDef Subtype that describes a Form Pane

Hierarchy

PaneDef
- FormDef

Index

Constructors

constructor

Properties

Methods

Constructors

Private constructor

new FormDef(paneId: string, name: string, label: string, title: string, menuDefs: Array<MenuDef>, viewDescs: Array<ViewDesc>, entityRecDef: EntityRecDef, dialogRedirection: DialogRedirection, settings: StringDictionary, _formLayout: string, _formStyle: string, _borderStyle: string, _headerDef: DetailsDef, _childrenDefs: Array<PaneDef>): FormDef

Overrides PaneDef.constructor
- Defined in catavolt/dialog.ts:2230
Parameters
- paneId: string
- name: string
- label: string
- title: string
- menuDefs: Array<MenuDef>
- viewDescs: Array<ViewDesc>
- entityRecDef: EntityRecDef
- dialogRedirection: DialogRedirection
- settings: StringDictionary
- _formLayout: string
- _formStyle: string
- _borderStyle: string
- _headerDef: DetailsDef
- _childrenDefs: Array<PaneDef>
Returns FormDef

Properties

Private _borderStyle

_borderStyle: string

Private _childrenDefs

_childrenDefs: Array<PaneDef>

Private _formLayout

_formLayout: string

Private _formStyle

_formStyle: string

Private _headerDef

_headerDef: DetailsDef

Accessors

borderStyle

get borderStyle(): string

- Defined in catavolt/dialog.ts:2268
Returns string

childrenDefs

get childrenDefs(): Array<PaneDef>

- Defined in catavolt/dialog.ts:2272
Returns Array<PaneDef>

dialogHandle

get dialogHandle(): DialogHandle

Inherited from PaneDef.dialogHandle
- Defined in catavolt/dialog.ts:1895
Get the DialogHandle associated with this PaneDef

Returns DialogHandle

dialogRedirection

get dialogRedirection(): DialogRedirection

Inherited from PaneDef.dialogRedirection
- Defined in catavolt/dialog.ts:1903
Get the DialogRedirection with which this Pane was constructed

Returns DialogRedirection

entityRecDef

get entityRecDef(): EntityRecDef
set entityRecDef(entityRecDef: EntityRecDef): void

Inherited from PaneDef.entityRecDef
- Defined in catavolt/dialog.ts:1911
Get the entity record definition

Returns EntityRecDef
Inherited from PaneDef.entityRecDef
- Defined in catavolt/dialog.ts:1915
Get the entity record definition

Parameters
- entityRecDef: EntityRecDef
Returns void

formLayout

get formLayout(): string

- Defined in catavolt/dialog.ts:2276
Returns string

formStyle

get formStyle(): string

- Defined in catavolt/dialog.ts:2280
Returns string

headerDef

get headerDef(): DetailsDef

- Defined in catavolt/dialog.ts:2284
Returns DetailsDef

isCompositeForm

get isCompositeForm(): boolean

- Defined in catavolt/dialog.ts:2288
Returns boolean

isFlowingLayout

get isFlowingLayout(): boolean

- Defined in catavolt/dialog.ts:2292
Returns boolean

isFlowingTopDownLayout

get isFlowingTopDownLayout(): boolean

- Defined in catavolt/dialog.ts:2296
Returns boolean

isFourBoxSquareLayout

get isFourBoxSquareLayout(): boolean

- Defined in catavolt/dialog.ts:2300
Returns boolean

isHorizontalLayout

get isHorizontalLayout(): boolean

- Defined in catavolt/dialog.ts:2304
Returns boolean

isOptionsFormLayout

get isOptionsFormLayout(): boolean

- Defined in catavolt/dialog.ts:2308
Returns boolean

isTabsLayout

get isTabsLayout(): boolean

- Defined in catavolt/dialog.ts:2312
Returns boolean

isThreeBoxOneLeftLayout

get isThreeBoxOneLeftLayout(): boolean

- Defined in catavolt/dialog.ts:2316
Returns boolean

isThreeBoxOneOverLayout

get isThreeBoxOneOverLayout(): boolean

- Defined in catavolt/dialog.ts:2320
Returns boolean

isThreeBoxOneRightLayout

get isThreeBoxOneRightLayout(): boolean

- Defined in catavolt/dialog.ts:2324
Returns boolean

isThreeBoxOneUnderLayout

get isThreeBoxOneUnderLayout(): boolean

- Defined in catavolt/dialog.ts:2328
Returns boolean

isTopDownLayout

get isTopDownLayout(): boolean

- Defined in catavolt/dialog.ts:2332
Returns boolean

isTwoVerticalLayout

get isTwoVerticalLayout(): boolean

- Defined in catavolt/dialog.ts:2336
Returns boolean

label

get label(): string

Inherited from PaneDef.label
- Defined in catavolt/dialog.ts:1937
Get the label for this Pane

Returns string

menuDefs

get menuDefs(): Array<MenuDef>
set menuDefs(menuDefs: Array<MenuDef>): void

Inherited from PaneDef.menuDefs
- Defined in catavolt/dialog.ts:1945
Get the all MenuDef's associated with this Pane

Returns Array<MenuDef>
Inherited from PaneDef.menuDefs
- Defined in catavolt/dialog.ts:1949
Get the all MenuDef's associated with this Pane

Parameters
- menuDefs: Array<MenuDef>
Returns void

name

get name(): string

Inherited from PaneDef.name
- Defined in catavolt/dialog.ts:1953
Returns string

paneId

get paneId(): string

Inherited from PaneDef.paneId
- Defined in catavolt/dialog.ts:1957
Returns string

settings

get settings(): StringDictionary

Inherited from PaneDef.settings
- Defined in catavolt/dialog.ts:1961
Returns StringDictionary

title

get title(): string

Inherited from PaneDef.title
- Defined in catavolt/dialog.ts:1965
Returns string

viewDescs

get viewDescs(): Array<ViewDesc>

Inherited from PaneDef.viewDescs
- Defined in catavolt/dialog.ts:1969
Returns Array<ViewDesc>

Methods

findTitle

findTitle(): string

Inherited from PaneDef.findTitle
- Defined in catavolt/dialog.ts:1923
Find the title for this Pane

Returns string

Static Private fromOpenFormResult

fromOpenFormResult(formXOpenResult: XOpenDialogModelResult, formXFormDef: XFormDef, formMenuDefs: Array<MenuDef>, formViewDesc: XGetAvailableViewDescsResult, childrenXOpens: Array<XOpenDialogModelResult>, childrenXPaneDefs: Array<XPaneDef>, childrenXActiveColDefs: Array<XGetActiveColumnDefsResult>, childrenMenuDefs: Array<Array<MenuDef>>, childrenViewDescs: Array<XGetAvailableViewDescsResult>, childrenPrintMarkupXML: Array<string>): Try<FormDef>

- Defined in catavolt/dialog.ts:2194
Parameters
- formXOpenResult: XOpenDialogModelResult
- formXFormDef: XFormDef
- formMenuDefs: Array<MenuDef>
- formViewDesc: XGetAvailableViewDescsResult
- childrenXOpens: Array<XOpenDialogModelResult>
- childrenXPaneDefs: Array<XPaneDef>
- childrenXActiveColDefs: Array<XGetActiveColumnDefsResult>
- childrenMenuDefs: Array<Array<MenuDef>>
- childrenViewDescs: Array<XGetAvailableViewDescsResult>
- childrenPrintMarkupXML: Array<string>
Returns Try<FormDef>

Static Private fromOpenPaneResult

fromOpenPaneResult(childXOpenResult: XOpenDialogModelResult, childXComp: XFormModelComp, childXPaneDef: XPaneDef, childXActiveColDefs: XGetActiveColumnDefsResult, childMenuDefs: Array<MenuDef>, childViewDesc: XGetAvailableViewDescsResult, printMarkupXML: string): Try<PaneDef>

Inherited from PaneDef.fromOpenPaneResult
- Defined in catavolt/dialog.ts:1782
Parameters
- childXOpenResult: XOpenDialogModelResult
- childXComp: XFormModelComp
- childXPaneDef: XPaneDef
- childXActiveColDefs: XGetActiveColumnDefsResult
- childMenuDefs: Array<MenuDef>
- childViewDesc: XGetAvailableViewDescsResult
- printMarkupXML: string
Returns Try<PaneDef>

Generated using TypeDoc