Options
All
  • Public
  • Public/Protected
  • All
Menu

PanContext Subtype that represents an 'Editor Pane'. An 'Editor' represents and is backed by a single Record and Record definition. See EntityRec and EntityRecDef. 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 _buffer

_buffer: EntityBuffer

Private _editorState

_editorState: EditorState

Private _entityRecDef

_entityRecDef: EntityRecDef

Private _isFirstReadComplete

_isFirstReadComplete: boolean

Private _settings

_settings: StringDictionary

Static BINARY_CHUNK_SIZE

BINARY_CHUNK_SIZE: number = 256 * 1024

Static Private GPS_ACCURACY

GPS_ACCURACY: string = "com.catavolt.core.domain.GeoFix.accuracy"

Static Private GPS_SECONDS

GPS_SECONDS: string = "com.catavolt.core.domain.GeoFix.seconds"

Accessors

actionSource

buffer

  • Get the current buffered record

    Returns EntityBuffer

dialogAlias

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

    Returns string

dialogRedirection

entityRec

  • Get the associated entity record

    Returns EntityRec

entityRecDef

entityRecNow

  • Get the current version of the entity record, with any pending changes present

    Returns EntityRec

error

formDef

hasError

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

    Returns boolean

isDestroyed

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

    Returns boolean

Private isDestroyedSetting

  • get isDestroyedSetting(): boolean
  • Returns boolean

isFirstReadComplete

  • get isFirstReadComplete(): boolean
  • Returns whether or not the buffers contain valid data via a successful read operation.

    Returns boolean

Private isGlobalRefreshSetting

  • get isGlobalRefreshSetting(): boolean
  • Returns boolean

Private isLocalRefreshSetting

  • get isLocalRefreshSetting(): boolean
  • Returns boolean

isReadMode

  • get isReadMode(): boolean
  • Returns whether or not this Editor is in 'read' mode

    Returns boolean

Private isReadModeSetting

  • get isReadModeSetting(): boolean
  • Returns boolean

isRefreshNeeded

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

    Returns boolean

Private isRefreshSetting

  • get isRefreshSetting(): boolean
  • Returns boolean

isWriteMode

  • get isWriteMode(): boolean
  • Returns whether or not this property is 'writable'

    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

paneDef

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

    Returns PaneDef

Private paneModeSetting

  • get paneModeSetting(): string
  • Returns string

paneRef

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

paneTitle

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

    Returns string

parentContext

sessionContext

settings

  • Get this Editor Pane's settings

    Returns StringDictionary

viewDescs

Methods

binaryAt

changePaneMode

  • Toggle the current mode of this Editor

    Parameters

    Returns Future<EntityRecDef>

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

getAvailableValues

  • getAvailableValues(propName: string): Future<Array<Object>>
  • Get the possible values for a 'constrained value' property

    Parameters

    • propName: string

    Returns Future<Array<Object>>

getSelectedViewId

Private initBuffer

  • Parameters

    Returns void

Private initialize

  • initialize(): void

isBinary

  • Returns whether or not this cell definition contains a binary value

    Parameters

    Returns boolean

isReadModeFor

  • isReadModeFor(propName: string): boolean
  • Returns whether or not this property is read-only

    Parameters

    • propName: string

    Returns boolean

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 EditorPane. Given that the Editor could possibly be destroyed as a result of this action, any provided pending writes will be saved if present.

    Parameters

    Returns Future<NavRequest>

processSideEffects

  • processSideEffects(propertyName: string, value: any): Future<void>
  • Properties whose PropDef.canCauseSideEffects value is true, may change other underlying values in the model. This method will update those underlying values, given the property name that is changing, and the new value. This is frequently used with EditorContext.getAvailableValues. When a value is seleted, other properties available values may change. (i.e. Country, State, City dropdowns)

    Parameters

    • propertyName: string
    • value: any

    Returns Future<void>

propDefAtName

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

    Parameters

    • propName: string

    Returns PropDef

Private putSetting

  • putSetting(key: string, value: any): void
  • Parameters

    • key: string
    • value: any

    Returns void

Private putSettings

  • Parameters

    Returns void

read

  • Read (load) the EntityRec assocated with this Editor The record must be read at least once to initialize the Context

    Returns Future<EntityRec>

readBinaries

Protected readBinary

Private removeSpecialProps

requestedAccuracy

  • requestedAccuracy(): number
  • Get the requested GPS accuracy

    Returns number

requestedTimeoutSeconds

  • requestedTimeoutSeconds(): number
  • Get the requested GPS timeout in seconds

    Returns number

setBinaryPropWithDataUrl

  • setBinaryPropWithDataUrl(name: string, dataUrl: string): void

setBinaryPropWithEncodedData

  • setBinaryPropWithEncodedData(name: string, encodedData: string, mimeType: string): void
  • Set a binary property with base64 encoded data

    Parameters

    • name: string
    • encodedData: string
    • mimeType: string

    Returns void

setPropValue

  • setPropValue(name: string, value: any): any
  • Set the value of a property in this {@link EntityRecord}. Values may be already constructed target types (CodeRef, TimeValue, Date, etc.) or primitives, in which case the values will be parsed and objects constructed as necessary.

    Parameters

    • name: string
    • value: any

    Returns any

Private updatePaneDef

write

writeAttachment

writeAttachments

writeBinaries

Static resolveSettingsFromNavRequest

Generated using TypeDoc