Namespace: detailView

bcdui.widget. detailView

A namespace for the BCD-UI detailView widget.

Methods

staticbcdui.widget.detailView.attachDetailView(args){Object|void}

widget/detailView/detailViewPackage.js, line 84
Name Type Description
args
Name Type Description
targetHtmlElement string | Element to attach listener to
targetRenderer string | bcdui.core.Renderer optional the target renderer, targetHtmlElement has precedence
consumeEvent boolean optional, default is: FALSE, consumes the event or allow propagation
childElementSelector string filter (jQuery) compatible for filtering on nested children, default is "tbody tr"
event string event to attach on , default is 'dblclick'
filterFunction function a filter function to check on target element if to pass, default is a filter function expecting targetElement to have 'bcdrowident' attribute this function shall return TRUE of FALSE, an argument is provided to the function containing following properties:
Name Type Description
eventContext.event string the event
eventContext.targetElement DomElement the target element where event has occurred
renderViewContainerFunction function a function which renders the view container, the default implementation is
Name Type Description
renderDialogContainer, function please refer to docs for more infos, arguments passed to this function:
factoryArgs Object the initial factory args which were provided attachDetailView() function, may be null
eventContext.event Object the event object which triggered this function, may be null
eventContext.targetElement DomElement the target element which event occurred, may be null
referenceElement DomElement is eventContext.targetElement
targetHtmlElement DomElement element to attach view container on
renderViewContainerFunctionParamsFactory function factory for additional params which are mixed-in to the argument of renderViewContainerFunction() available through extra.* property; this function gets same arguments as 'renderViewContainerFunction'
containerViewRenderedCb function a function which is called by renderViewContainerFunction() once container is contructed
Returns:
Type Description
Object | void args, additionally contains .unbind() function which stops this handler working; when called that function, you have to attachDetailView() again

staticbcdui.widget.detailView.renderDialogContainer(args){Object}

widget/detailView/detailViewPackage.js, line 207
renders a details view container for given element, this implementation renders jQuery.dialog, you can override any attributes via extra.dialog object parameter
Name Type Description
args object
Name Type Description
targetHtmlElement DomElement the target element this container is attached to
referenceElement DomElement the element this detail container is constructed for
containerViewRenderedCb function the function which is called once target container is constructed and argument with following properties is provided:
Name Type Description
targetHtmlElement DomElement the element to render content into, this may be reused so ensure executing .empty() before adding content
referenceElement DomElement see above --- specific parameters, which are available in this function, but is not API contract, i.e. in case you provide your custom renderViewContainer function --- extra.dialog{Object} - extra parameters to jQuery Dialog UI plugin, which are mixed-in at construction time; you overwrite the defaults! extra.dialog.disableCloseControl - special param to remove the [close] control from standard ui-dialog bar, so close() can be issued via API/Event only
Returns:
Type Description
Object jQuery object ( container element )