Options
All
  • Public
  • Public/Protected
  • All
Menu

PaneContext Subtype that represents a Catavolt Form Definition A form is a 'container' composed of child panes of various concrete types. A FormContext parallels this design, and contains a list of 'child' contexts See also FormDef. 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

Properties

Private _actionSource

_actionSource: ActionSource

Private _childrenContexts

_childrenContexts: Array<PaneContext>

Private _destroyed

_destroyed: boolean = false

Private _dialogRedirection

_dialogRedirection: DialogRedirection

Private _formDef

_formDef: FormDef

Private _offlineCapable

_offlineCapable: boolean

Private _offlineData

_offlineData: boolean

Private _offlineProps

_offlineProps: StringDictionary

Private _sessionContext

_sessionContext: SessionContext

Static BINARY_CHUNK_SIZE

BINARY_CHUNK_SIZE: number = 256 * 1024

Accessors

actionSource

childrenContexts

  • Get the list of child contexts that 'compose' this Form

    Returns Array<PaneContext>

dialogAlias

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

    Returns string

dialogRedirection

entityRecDef

error

formDef

  • Get the underlying Form definition for this FormContext

    Returns FormDef

hasError

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

    Returns boolean

Private headerContext

  • Returns PaneContext

Private isAnyChildDestroyed

  • get isAnyChildDestroyed(): boolean
  • Returns boolean

isDestroyed

  • get isDestroyed(): boolean
  • Returns whether or not this Form is destroyed

    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

Private offlineCapable

  • get offlineCapable(): boolean

Private offlineProps

paneDef

  • Get the underlying form definition associated with this FormContext

    Returns PaneDef

paneRef

  • get paneRef(): number
  • set paneRef(paneRef: number): void

paneTitle

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

    Returns string

parentContext

sessionContext

viewDescs

Methods

binaryAt

close

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

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

performMenuAction

  • Perform the action associated with the given MenuDef on this Form

    Parameters

    Returns Future<NavRequest>

Private processNavRequestForDestroyed

  • processNavRequestForDestroyed(navRequest: NavRequest): void
  • Parameters

    Returns void

propDefAtName

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

    Parameters

    • propName: string

    Returns PropDef

readBinaries

Protected readBinary

writeAttachment

writeAttachments

writeBinaries

Static resolveSettingsFromNavRequest

Generated using TypeDoc