Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Accessors

Methods

Properties

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

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

clearSearchValues

  • clearSearchValues(): void

clearSortValues

  • clearSortValues(): void

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[]>

getKeywordSearchValue

Protected getProperty

getPropertyNameForSearchPropertyName

  • getPropertyNameForSearchPropertyName(searchPropertyName: string): string

getSearchOpPropertyDefForName

  • getSearchOpPropertyDefForName(propName: string): PropertyDef

getSearchOpPropertyForName

  • getSearchOpPropertyForName(propName: string): Property

getSearchValuePropertyDefForName

  • getSearchValuePropertyDefForName(propName: string): PropertyDef

getSearchValuePropertyForName

  • getSearchValuePropertyForName(propName: string): Property

getSearchablePropertyNames

  • getSearchablePropertyNames(): string[]

getSortDirectionPropertyDefForName

  • getSortDirectionPropertyDefForName(propName: string): PropertyDef

getSortDirectionPropertyForName

  • getSortDirectionPropertyForName(propName: string): Property

getSortPriorityPropertyDefForName

  • getSortPriorityPropertyDefForName(propName: string): PropertyDef

getSortPriorityPropertyForName

  • getSortPriorityPropertyForName(propName: string): Property

getSortablePropertyNames

  • getSortablePropertyNames(): string[]

initialize

Protected invokeMenuAction

Protected invokeMenuActionWithId

isAscending

  • isAscending(propName: string): boolean
  • Returns whether or not the sort direction for a property is set to ascending

    Parameters

    • propName: string

    Returns boolean

isBinary

isDescending

  • isDescending(propName: string): boolean
  • Returns whether or not the sort direction for a property is set to descending

    Parameters

    • propName: string

    Returns boolean

isReadModeFor

  • isReadModeFor(propName: string): 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>

propDefAtName

read

readLargeProperties

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

readLargeProperty

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

reopenSearch

setAscending

  • setAscending(propName: string, sortFieldPriority?: number): void
  • Set the sort direction for a property to ascending

    Parameters

    • propName: string
    • Default value sortFieldPriority: number = 0

    Returns void

setDescending

  • setDescending(propName: string, sortFieldPriority?: number): void
  • Set the sort direction for a property to descending

    Parameters

    • propName: string
    • Default value sortFieldPriority: number = 0

    Returns void

setKeywordSearchValue

  • setKeywordSearchValue(keyword: string): void
  • Set the search value for the keyword search. This is a global substring search across all properties

    Parameters

    • keyword: string

    Returns void

setLargePropertyWithDataUrl

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

setLargePropertyWithEncodedData

  • setLargePropertyWithEncodedData(name: string, encodedData: string, mimeType?: string): 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

setSearchValue

  • setSearchValue(propName: string, searchValue: string): void
  • Set the search value for a property

    Parameters

    • propName: string
    • searchValue: string

    Returns void

setSearchValueOperation

  • setSearchValueOperation(propName: string, operator: FilterOperator): void

setSortValue

  • setSortValue(propName: string, sortDirection?: SortDirection, sortFieldPriority?: number): void

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>

submitSearch

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