A namespace for the BCD-UI detailView widget.
Methods
-
staticbcdui.widget.detailView.attachDetailView(args)
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
the event eventContext.targetElement
the target element where event has occurred renderViewContainerFunction
function a function which renders the view container, the default implementation is Name Type Description renderDialogContainer(),
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
Element the target element which event occurred, may be null referenceElement
Element is eventContext.targetElement targetHtmlElement
Element 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:
args, additionally contains .unbind() function which stops this handler working; when called that function, you have to attachDetailView() again -
staticbcdui.widget.detailView.renderDialogContainer(args)
widget/detailView/detailViewPackage.js, line 208 -
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
Name Type Description targetHtmlElement
the target element this container is attached to referenceElement
Element the the element this detail container is constructed for containerViewRenderedCb.
the function which is called once target container is constructed and argument with following properties is provided: containerViewRenderedCb.targetHtmlElement
Element the element to render content into, this may be reused so ensure executing .empty() before adding content containerViewRenderedCb.referenceElement
Element 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:
jQuery object ( container element )