Options
All
  • Public
  • Public/Protected
  • All
Menu

Top-level class, representing a Catavolt 'Pane' definition. All 'Context' classes have a composite PaneDef that defines the Pane along with a single record or a list of records. See {@EntityRecord} Context classes, while similar to PaneDef and subclasses, contain both the corresponding subtype of pane definition PaneDef (i.e. describing this UI component, layout, etc.) and also the 'data record(s)' as one or more EntityRec(s)

Hierarchy

Index

Constructors

Private constructor

  • Parameters

    • paneRef: number

    Returns PaneContext

Properties

Private _binaryCache

_binaryCache: object

Type declaration

  • [index: string]: Array<Binary>

Private _lastRefreshTime

_lastRefreshTime: Date = new Date(0)

Private _paneRef

_paneRef: number = null

Private _parentContext

_parentContext: FormContext = null

entityRecDef

entityRecDef: EntityRecDef

isDestroyed

isDestroyed: boolean

Has this 'Pane' been destroyed?

Static Private ANNO_NAME_KEY

ANNO_NAME_KEY: string = "com.catavolt.annoName"

Static BINARY_CHUNK_SIZE

BINARY_CHUNK_SIZE: number = 256 * 1024

Static Private CHAR_CHUNK_SIZE

CHAR_CHUNK_SIZE: number = 128 * 1000

Static Private PROP_NAME_KEY

PROP_NAME_KEY: string = "com.catavolt.propName"

Accessors

actionSource

  • Get the action source for this Pane

    Returns ActionSource

dialogAlias

  • get dialogAlias(): string
  • Get the dialog alias

    Returns string

dialogRedirection

error

  • Return the error associated with this pane, if any

    Returns DialogException

formDef

  • Get the underlying form definition FormDef for this Pane. If this is not a FormContext this will be the FormDef of the owning/parent Form

    Returns FormDef

hasError

  • get hasError(): boolean
  • Returns whether or not this pane loaded properly

    Returns boolean

isRefreshNeeded

  • get isRefreshNeeded(): boolean
  • Returns whether or not the data in this pane is out of date

    Returns boolean

lastRefreshTime

  • get lastRefreshTime(): Date
  • set lastRefreshTime(time: Date): void
  • Get the last time this pane's data was refreshed

    Returns Date

  • Get the last time this pane's data was refreshed

    Parameters

    • time: Date

    Returns void

menuDefs

  • Get the all MenuDef's associated with this Pane

    Returns Array<MenuDef>

Private offlineCapable

  • get offlineCapable(): boolean
  • Returns boolean

paneDef

  • Get the underlying @{link PaneDef} associated with this Context

    Returns PaneDef

paneRef

  • get paneRef(): number
  • set paneRef(paneRef: number): void
  • Get the numeric value, representing this Pane's place in the parent FormContext's list of child panes. See FormContext.childrenContexts

    Returns number

  • Get the numeric value, representing this Pane's place in the parent FormContext's list of child panes. See FormContext.childrenContexts

    Parameters

    • paneRef: number

    Returns void

paneTitle

  • get paneTitle(): string
  • Get the title of this Pane

    Returns string

parentContext

sessionContext

  • Get the session information

    Returns SessionContext

viewDescs

  • Get the all ViewDesc's associated with this Pane

    Returns Array<ViewDesc>

Methods

binaryAt

  • Load a Binary property from a record

    Parameters

    Returns Future<Binary>

findMenuDefAt

  • findMenuDefAt(actionId: string): MenuDef
  • Find a menu def on this Pane with the given actionId

    Parameters

    • actionId: string

    Returns MenuDef

formatForRead

  • formatForRead(prop: Prop, propName: string): string
  • Get a string representation of this property suitable for 'reading'

    Parameters

    • prop: Prop
    • propName: string

    Returns string

formatForWrite

  • formatForWrite(prop: Prop, propName: string): string
  • Get a string representation of this property suitable for 'writing'

    Parameters

    • prop: Prop
    • propName: string

    Returns string

getSelectedViewId

Protected initialize

  • initialize(): void
  • Returns void

openView

parseValue

  • parseValue(formattedValue: any, propName: string): any
  • Parses a value to prepare for 'writing' back to the server

    Parameters

    • formattedValue: any
    • propName: string

    Returns any

propDefAtName

  • propDefAtName(propName: string): PropDef
  • Get the propery definition for a property name

    Parameters

    • propName: string

    Returns PropDef

readBinaries

Protected readBinary

  • Parameters

    Returns Future<Binary>

writeAttachment

  • Parameters

    Returns Future<void>

writeAttachments

  • Parameters

    Returns Future<Array<Try<void>>>

writeBinaries

Static resolveSettingsFromNavRequest

Generated using TypeDoc