Options
All
  • Public
  • Public/Protected
  • All
Menu

PaneContext Subtype that represents a 'Query Pane'. A 'Query' represents and is backed by a list of Records and a single 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 _lastQueryFr

_lastQueryFr: Future<QueryResult>

Private _offlineRecs

_offlineRecs: Array<EntityRec>

Private _queryState

_queryState: QueryState

Private _scroller

_scroller: QueryScroller

Private _settings

_settings: StringDictionary

Static BINARY_CHUNK_SIZE

BINARY_CHUNK_SIZE: number = 256 * 1024

Accessors

actionSource

dialogAlias

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

    Returns string

dialogRedirection

entityRecDef

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 Query Pane is destroyed

    Returns boolean

Private isDestroyedSetting

  • get isDestroyedSetting(): boolean
  • Returns boolean

Private isGlobalRefreshSetting

  • get isGlobalRefreshSetting(): boolean
  • Returns boolean

Private isLocalRefreshSetting

  • get isLocalRefreshSetting(): 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

lastQueryFr

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 offlineRecs

  • get offlineRecs(): Array<EntityRec>
  • set offlineRecs(offlineRecs: Array<EntityRec>): void
  • Returns Array<EntityRec>

  • Parameters

    Returns void

paneDef

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

    Returns PaneDef

paneMode

  • get paneMode(): string
  • Get the pane mode

    Returns string

paneRef

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

paneTitle

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

    Returns string

parentContext

scroller

  • Get the associated QueryScroller

    Returns QueryScroller

sessionContext

viewDescs

Methods

binaryAt

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

isBinary

  • Returns whether or not a column is of a binary type

    Parameters

    Returns boolean

newScroller

  • Creates a new QueryScroller with default buffer size of 50

    Returns QueryScroller

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 this action associated with the given MenuDef on this Pane. The targets array is expected to be an array of object ids.

    Parameters

    • menuDef: MenuDef
    • targets: Array<string>

    Returns Future<NavRequest>

propDefAtName

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

    Parameters

    • propName: string

    Returns PropDef

query

readBinaries

Protected readBinary

refresh

  • Clear the QueryScroller's buffer and perform this query

    Returns Future<Array<EntityRec>>

setScroller

  • Creates a new QueryScroller with the given values

    Parameters

    Returns QueryScroller

settings

  • Get the settings associated with this Query

    Returns StringDictionary

Private updatePaneDef

writeAttachment

writeAttachments

writeBinaries

Static resolveSettingsFromNavRequest

Generated using TypeDoc