Options
All
  • Public
  • Public/Protected
  • All
Menu

A PaneDef represents a Catavolt 'Pane' definition. A Pane can be thought of as a 'panel' or UI component that is responsible for displaying a data record or records. The Pane describes 'how' and 'where' the data will be displayed, as well as surrounding 'meta' data (i.e. the Pane title, the Pane's menus). The Pane itself does not contain the record or records to be displayed, but may be combined with a {@link EntityRecord}(s) to display the data.

Hierarchy

Index

Constructors

Private constructor

Properties

Private _dialogRedirection

_dialogRedirection: DialogRedirection

Private _entityRecDef

_entityRecDef: EntityRecDef

Private _label

_label: string

Private _menuDefs

_menuDefs: Array<MenuDef>

Private _name

_name: string

Private _paneId

_paneId: string

Private _settings

_settings: StringDictionary

Private _title

_title: string

Private _viewDescs

_viewDescs: Array<ViewDesc>

Accessors

dialogHandle

dialogRedirection

entityRecDef

  • Get the entity record definition

    Returns EntityRecDef

  • Get the entity record definition

    Parameters

    Returns void

label

  • get label(): string
  • Get the label for this Pane

    Returns string

menuDefs

  • get menuDefs(): Array<MenuDef>
  • set menuDefs(menuDefs: Array<MenuDef>): void
  • Get the all MenuDef's associated with this Pane

    Returns Array<MenuDef>

  • Get the all MenuDef's associated with this Pane

    Parameters

    Returns void

name

  • get name(): string
  • Returns string

paneId

  • get paneId(): string
  • Returns string

settings

title

  • get title(): string
  • Returns string

viewDescs

  • Returns Array<ViewDesc>

Methods

findTitle

  • findTitle(): string
  • Find the title for this Pane

    Returns string

Static Private fromOpenPaneResult

Generated using TypeDoc