Class ListDef

PaneDef Subtype that describes a List Pane

Hierarchy

PaneDef
- ListDef

Index

Constructors

constructor

Properties

Methods

Constructors

Private constructor

new ListDef(paneId: string, name: string, label: string, title: string, menuDefs: Array<MenuDef>, viewDescs: Array<ViewDesc>, entityRecDef: EntityRecDef, dialogRedirection: DialogRedirection, settings: StringDictionary, _style: string, _initialColumns: number, _activeColumnDefs: Array<ColumnDef>, _columnsStyle: string, _defaultActionId: string, _graphicalMarkup: string): ListDef

Overrides PaneDef.constructor
- Defined in catavolt/dialog.ts:2581
Parameters
- paneId: string
- name: string
- label: string
- title: string
- menuDefs: Array<MenuDef>
- viewDescs: Array<ViewDesc>
- entityRecDef: EntityRecDef
- dialogRedirection: DialogRedirection
- settings: StringDictionary
- _style: string
- _initialColumns: number
- _activeColumnDefs: Array<ColumnDef>
- _columnsStyle: string
- _defaultActionId: string
- _graphicalMarkup: string
Returns ListDef

Properties

Private _activeColumnDefs

_activeColumnDefs: Array<ColumnDef>

Private _columnsStyle

_columnsStyle: string

Private _defaultActionId

_defaultActionId: string

Private _graphicalMarkup

_graphicalMarkup: string

Private _initialColumns

_initialColumns: number

Private _style

_style: string

Accessors

activeColumnDefs

get activeColumnDefs(): Array<ColumnDef>
set activeColumnDefs(activeColumnDefs: Array<ColumnDef>): void

- Defined in catavolt/dialog.ts:2619
Returns Array<ColumnDef>
- Defined in catavolt/dialog.ts:2623
Parameters
- activeColumnDefs: Array<ColumnDef>
Returns void

columnsStyle

get columnsStyle(): string

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

defaultActionId

get defaultActionId(): string
set defaultActionId(defaultActionId: string): void

- Defined in catavolt/dialog.ts:2631
Returns string
- Defined in catavolt/dialog.ts:2635
Parameters
- defaultActionId: string
Returns void

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

graphicalMarkup

get graphicalMarkup(): string

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

initialColumns

get initialColumns(): number

- Defined in catavolt/dialog.ts:2643
Returns number

isDefaultStyle

get isDefaultStyle(): boolean

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

isDetailsFormStyle

get isDetailsFormStyle(): boolean

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

isFormStyle

get isFormStyle(): boolean

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

isTabularStyle

get isTabularStyle(): boolean

- Defined in catavolt/dialog.ts:2659
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

style

get style(): string

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

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 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