Options
All
  • Public
  • Public/Protected
  • All
Menu

PanContext Subtype that represents an 'Editor Dialog'. An 'Editor' represents and is backed by a single Record and Record definition. See Record and RecordDef.

Hierarchy

Index

Properties

Private _buffer

_buffer: RecordBuffer

availableViews

availableViews: ViewDescriptor[]

children

children: Dialog[] = []

description

description: string

dialogClassName

dialogClassName: string

dialogMode

dialogMode: DialogMode

domainClassName

domainClassName: string

header

header: View

id

id: string

recordDef

recordDef: RecordDef

recordId

recordId: string

referringObject

referringObject: ReferringObject

selectedViewId

selectedViewId: string

sessionId

sessionId: string

tenantId

tenantId: string

type

view

view: View

viewMode

viewMode: ViewMode

Static BINARY_CHUNK_SIZE

BINARY_CHUNK_SIZE: number = 128 * 1024

Static SEARCH_DIALOG_CLASS

SEARCH_DIALOG_CLASS: string = "SearchQueryModel"

Accessors

anyChildNeedsRefresh

  • get anyChildNeedsRefresh(): boolean

attributeCells

Private buffer

catavolt

constants

  • get constants(): string[]

error

hasError

  • get hasError(): boolean

isDestroyed

  • get isDestroyed(): boolean

isReadMode

  • get isReadMode(): boolean

isReadViewMode

  • get isReadViewMode(): boolean

isRefreshNeeded

  • get isRefreshNeeded(): boolean

isWriteMode

  • get isWriteMode(): boolean

labelsByPropName

lastRefreshTime

  • get lastRefreshTime(): Date
  • set lastRefreshTime(time: Date): void

menu

paneTitle

  • get paneTitle(): string

propertyDefs

props

record

recordNow

viewDescs

Methods

changeViewMode

destroy

  • destroy(): Promise<void>

findMenuAt

  • findMenuAt(actionId: string): Menu

formatForRead

  • formatForRead(prop: Property, propName: string): string

formatForWrite

  • formatForWrite(prop: Property, propName: string): string

getAvailableValues

  • getAvailableValues(propName: string): Promise<any[]>

Protected getProperty

Private getWriteableRecord

Private initBuffer

  • initBuffer(record: Record): void

initialize

Protected invokeMenuAction

Protected invokeMenuActionWithId

isBinary

isReadModeFor

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

    Parameters

    • propName: string

    Returns boolean

isSignature

newLargePropertyWithDataUrl

newLargePropertyWithEncodedData

  • newLargePropertyWithEncodedData(encodedData: string, mimeType?: string): LargeProperty

newProperty

  • newProperty(name: string, value: any): Property

openView

openViewWithId

  • openViewWithId(viewId: string): Promise<Dialog>

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 Menu on this EditorDialog 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 Promise<Redirection>

    | Redirection>}

performMenuActionWithId

  • performMenuActionWithId(actionId: string): Promise<Redirection>

processSideEffects

  • processSideEffects(propertyName: string, value: any): Promise<void>
  • Properties whose PropertyDef.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 EditorDialog.getAvailableValues. When a value is selected, other properties' available values may change. (i.e. Country, State, City dropdowns)

    Parameters

    • propertyName: string
    • value: any

    Returns Promise<void>

propDefAtName

read

readLargeProperties

  • readLargeProperties(recordId: string): Promise<LargeProperty[]>

readLargeProperty

  • readLargeProperty(propertyName: string, recordId?: string): Promise<LargeProperty>

setLargePropertyWithDataUrl

  • setLargePropertyWithDataUrl(name: string, dataUrl: string): Property

setLargePropertyWithEncodedData

  • setLargePropertyWithEncodedData(name: string, encodedData: string, mimeType?: string): Property
  • Set a binary property with base64 encoded data

    Parameters

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

    Returns Property

setPropertyValue

  • setPropertyValue(name: string, value: any): Property
  • Set the value of a property in this Record. 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 Property

streamLargeProperty

  • Stream the encoded chunks of a large property without retaining them The streamConsumer will receive Base64 encoded chunks with callbacks. hasMore will be false with the final chunk.

    Parameters

    • streamConsumer: StreamConsumer
    • propertyName: string
    • Optional recordId: string

    Returns Promise<LargeProperty>

Protected updateSettingsWithNewDialogProperties

  • updateSettingsWithNewDialogProperties(referringObject: ReferringObject): void

write

Protected writeAttachment

  • writeAttachment(attachment: Attachment): Promise<void>

Protected writeAttachments

  • writeAttachments(record: Record): Promise<void[]>

Protected writeLargeProperties

  • writeLargeProperties(record: Record): Promise<void[]>

Protected writeLargeProperty

  • writeLargeProperty(propertyName: string, largeProperty: LargeProperty): Promise<void>

Static getSubType

Static isSearchDialog

  • isSearchDialog(dialog: any): boolean

Static loadLargeProperty

  • loadLargeProperty(getPropertyFn: function, streamConsumer?: StreamConsumer, propertyName?: string, recordId?: string): Promise<LargeProperty>

Generated using TypeDoc