Class: ViewPanel

ViewPanel(args)

new ViewPanel(args)

Parameters:
Name Type Description
args ExtViewPanelConstructorArgs
Source:

Members

contentRootViewNode :HTMLElement

Type:
  • HTMLElement
Source:

currentlyActiveBaseRoute :string

Type:
  • string
Source:

currentlyActiveFullQuery :string

Type:
  • string
Source:

currentlyActiveFullQuery

Server-side rendering of view panels NOT allowed. So, directly calls, asking for view template.
Source:

currentlyActivePanelNavId :string

Type:
  • string
Source:

dataResponseHostPipeline :genericParamFunction.<HOST_PIPELINE_DATA>

USE THIS PIPELINE ONLY TO PASS DATA. AND CHOOSE HOW YOU WILL DESTROY PANEL LATER. Internally or externally by invoking manager
Type:
Source:

globalInflationID :string

Type:
  • string
Source:

localRoutingInfos :Array.<LocalViewPanelRoutingInfo>

Type:
  • Array.<LocalViewPanelRoutingInfo>
Source:

panelQuery :string

The query to read value from. Also, one to read savedState from?
Type:
  • string
Source:

panelRootViewNode :HTMLElement

Type:
  • HTMLElement
Source:

updateQueryList :GenericRouteQueryData.<{}>

Type:
  • GenericRouteQueryData.<{}>
Source:

viewPanelsManager :ViewPanelsManagerInstance

Use it to invoke another panel build? Yea. Call it openViewPanelByRoute if route-based Otherwise, use normal invocation (no route changes, but full build process)
Type:
  • ViewPanelsManagerInstance
Source:

Methods

bindLocalRoutingInfoToNavigation(launchParams, buildStageArgs)

Parameters:
Name Type Description
launchParams LaunchViewPanelParams.<{}, {}>
buildStageArgs ViewPanelBuildStagesArgs
Source:

bindNewViewPanelUIToDOM(launchParams, buildStageArgs, cb)

Internal. Don't override This should not be an asynchronous call
Parameters:
Name Type Description
launchParams LaunchViewPanelParams.<LAUNCH_DATA, HOST_PIPELINE_DATA>
buildStageArgs ViewPanelBuildStagesArgs
cb genericFunction
Source:

bindPanelViewUIToListeners()

DO NOT OVERRIDE. Use onViewPanelUIBind
Source:

checkQueryUpdates(routeParams)

Leave implementation as super
Parameters:
Name Type Description
routeParams RouteParams
Source:

destroyViewPanel(cb)

Parameters:
Name Type Description
cb genericFunction
Source:

detachPanelViewFromDOM(pipelineCb)

Parameters:
Name Type Description
pipelineCb genericFunction
Source:

getCloseTransitionsData_Workers_Queue() → {TransitionsManagerRunArgs.<{}>}

Source:
Returns:
Type
TransitionsManagerRunArgs.<{}>

getLaunchTransitionsData_Workers_Queue(launchParams, buildStageArgs) → {TransitionsManagerRunArgs.<{}>}

Parameters:
Name Type Description
launchParams LaunchViewPanelParams.<LAUNCH_DATA, HOST_PIPELINE_DATA>
buildStageArgs ViewPanelBuildStagesArgs
Source:
Returns:
Type
TransitionsManagerRunArgs.<{}>

getLifeCycleObject() → {FragmentLifeCycleInstance}

Source:
Returns:
Type
FragmentLifeCycleInstance

getSpecSavedState(savedState, target) → {ExtSpecSavedFragmentState}

Parameters:
Name Type Description
savedState SavedFragmentState
target string
Source:
Returns:
Type
ExtSpecSavedFragmentState

getViewPanelState() → {SavedFragmentState}

Override and call super to add your own properties
Source:
Returns:
Type
SavedFragmentState

(async) initializePanelView(launchParams, buildStageArgs, localPipelineCb)

Initializes the view for the view panel. You can source it remotely using a promise (you must wait for this promise) or use a template already shipped in the code Override and use appropriately Finally, call onViewInitSuccess with the view as a buildStageArgs in plain text html
Parameters:
Name Type Description
launchParams LaunchViewPanelParams.<LAUNCH_DATA, HOST_PIPELINE_DATA>
buildStageArgs ViewPanelBuildStagesArgs
localPipelineCb genericParamFunction.<ViewPanelBuildStagesArgs>
Source:

isViewPanelContentViewInitialized() → {boolean}

Tells if the content view has been initialized
Source:
Returns:
Type
boolean

isViewPanelRootViewInitialized() → {boolean}

Tells if root view of the panel has been initialized Automatically tells if part of DOM. So, as long as you add it with the right ID, done! Have a utils class that ensures IDs are not repeated? Developer be careful for now
Source:
Returns:
Type
boolean

loadRemoteViewPanelUI(reqOptions) → {Promise.<string>}

Loads a remote UI resource in plain text
Parameters:
Name Type Description
reqOptions RequestOptions
Source:
Returns:
A promise that resolves with the ui template in plain text html
Type
Promise.<string>

maintainViewPanel(pipelineCb)

Parameters:
Name Type Description
pipelineCb getViewPanelConsentCb
Source:

normalizeUpdateQueryList(updateQueryList)

Parameters:
Name Type Description
updateQueryList GenericRouteQueryData.<{}>
Source:

onBindPanelView(launchParams, buildStageArgs, localPipelineCb)

Parameters:
Name Type Description
launchParams LaunchViewPanelParams.<LAUNCH_DATA, HOST_PIPELINE_DATA>
buildStageArgs ViewPanelBuildStagesArgs
localPipelineCb genericParamFunction.<ViewPanelBuildStagesArgs>
Source:

onBindPanelViewUtils()

Source:

onInitPanelView(launchParams, buildStageArgs, localPipelineCb)

Initializes the panel view - loads the content view of the panel. Not bound yet
Parameters:
Name Type Description
launchParams LaunchViewPanelParams.<LAUNCH_DATA, HOST_PIPELINE_DATA>
buildStageArgs ViewPanelBuildStagesArgs
localPipelineCb genericParamFunction.<ViewPanelBuildStagesArgs>
Source:

(async) onQueryDataUpdate()

OVERRIDE to check updates on queries, data sent through route call, and the saved fragment state
Source:

onViewInitSuccess(launchParams, buildStageArgs, localPipelineCb)

Call after the UI has been loaded successfully to start binding to DOM Do not override.
Parameters:
Name Type Description
launchParams LaunchViewPanelParams.<LAUNCH_DATA, HOST_PIPELINE_DATA>
buildStageArgs ViewPanelBuildStagesArgs
localPipelineCb genericParamFunction.<ViewPanelBuildStagesArgs>
Source:

onViewPanelBuildStart(launchParams, buildStageArgs, localPipelineCb)

CALL SUPER ALWAYS called when build about to start. Use to set any necessary values you need.
Parameters:
Name Type Description
launchParams LaunchViewPanelParams.<LAUNCH_DATA, HOST_PIPELINE_DATA>
buildStageArgs ViewPanelBuildStagesArgs
localPipelineCb genericParamFunction.<ViewPanelBuildStagesArgs>
Source:

onViewPanelConsent(pipelineCb)

Override to consent to view panel changes Call super to confirm consent. Else, call maintainViewPanel
Parameters:
Name Type Description
pipelineCb getViewPanelConsentCb
Source:

onViewPanelUIBind()

Override. Bind your listeners here. View already bound to DOM
Source:

onViewPanelUpdateParams()

Source:

setCurrentlyActiveViewPanelNavigation(updatedQueries)

WRITE LOGIC LATER, WHEN NEEDED - LOL Set the active navigation for the view panel based on the updated queries, if any provided, or default (MUST BE GIVEN)
Parameters:
Name Type Default Description
updatedQueries GenericRouteQueryData.<{}> null
Source:

setWrapperAttributes(launchParams, buildStageArgs, wrapper)

Override Called ONLY if root now hardcoded in DOM Don't set ID. It will be overwritten Set unique attributes for the wrapper if need be. COPY FOR FRAGMENT??
Parameters:
Name Type Description
launchParams LaunchViewPanelParams.<LAUNCH_DATA, HOST_PIPELINE_DATA>
buildStageArgs ViewPanelBuildStagesArgs
wrapper HTMLDivElement
Source:

triggerViewPanelNavigationalRouting(info, dataAndArgs, failCb)

Override if you want to specify whether scroll state restore should be skipped when going back for fragment Handle localized?
Parameters:
Name Type Description
info LocalViewPanelRoutingInfo
dataAndArgs routeBuildPipelineDataArgs.<{}>
failCb genericFunction
Source: