Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CvFormPanelProps

Hierarchy

  • CvProps
    • CvFormPanelProps

Index

Properties

Optional actionListeners

actionListeners: Array<function>

Register to receive {@link CvEvent}s of type {@link CvActionFiredResult}

Optional catavolt

catavolt: AppContext

The Catavolt SDK entry point, an instance of the sdk {AppContext} which is always available to components. A singleton instance is used by the underlying components to interact with the sdk.

Optional displayPropChangeListeners

displayPropChangeListeners: Array<function>

Register to receive notification of changes to display property values This is primarily to allow urls to react to these changes and update accordingly

Optional displayProperties

displayProperties: CvDisplayProperties

Mechanism to provide display 'settings' that are not maintained by the catavolt server

Optional eventRegistry

eventRegistry: CvEventRegistry

The {@link CvEventRegistry} handles decoupled communication between components. Any component may subscribe to and publish {@link CvEvent}s. See also {@link CvListener} and {@link CvEventType}

Optional formComponentProvider

formComponentProvider: CvFormComponentProvider

Provide a custom renderer for the entire form. See CvFormComponentProvider

Optional formContext

formContext: FormContext

The sdk {FormContext} to use for this form panel. If not provided, the {@link CvScopeContext} will be upwardly traversed to attempt to find a matching instance.

Optional layoutOverrideElem

layoutOverrideElem: any

A FormLayout component to use instead of the one supplied by the server meta data

Optional navTarget

navTarget: string

Provide a target for any navigations that originate from this component. The navTarget should correspond to the 'targetId' value of the coresident {@link CvNavigation} or CvNavigator. This is useful for single page apps where components may be coresident.

Optional navigationListeners

navigationListeners: Array<function>

Register to receive {@link CvEvent}s of type {@link CvNavigationResult}

Optional renderer

renderer: function

Allows for a component's rendering logic to be overridden and completely customized. The first argument, the {@link CvContext}, exposes the {@link CvScopeContext} which provides the relevant SDK object for use by the renderer. {@link CvScopeContext.scopeObj} will always be an SDK object exposing the data related to the current component.

Type declaration

    • (cvContext: CvContext, callbackObj?: any): __type
    • Parameters

      • cvContext: CvContext
      • Optional callbackObj: any

      Returns __type

Optional stateChangeListeners

stateChangeListeners: Array<function>

Register to receive {@link CvEvent}s of type {@link CvStateChangeResult}

Generated using TypeDoc