Namespace: balloon

bcdui.widgetNg.commons. balloon

A namespace for the BCD-UI balloon widget.

Members

staticbcdui.widgetNg.commons.balloon.BALLOON_RENDERER

singleton balloon renderer

staticbcdui.widgetNg.commons.balloon.CONST

constants

staticbcdui.widgetNg.commons.balloon.DATA_PROVIDER

the singleton data provider which is data provider to the tooltip renderer, it fetches the ID of element from 'bcdRowIdent' data provider, locates that element, fetches the tooltip message and validation messages from the 'bcdHint' attribute (or 'hint' option) and '_validationMessages_' map value respectively, parses them into a DOM document which is returned to the renderer to be rendered.

staticbcdui.widgetNg.commons.balloon.MAPKEY_CONFIG

PrototypeJS element maps key for internal configuration object

staticbcdui.widgetNg.commons.balloon.TOOLTIP_RENDERER

singleton tooltip renderer

Methods

staticbcdui.widgetNg.commons.balloon.attach(htmlElementId, args)

widgetNg/commons.js, line 156
attaches the balloon to given, focusable element, this function does nothing in case a balloon is already attached on this element.
Name Type Description
htmlElementId element | string The target to attach ballon to.
args object optional Object literal containing following properties
Name Type Description
noTooltip boolean optional If balloon is attach a tooltip (mouseover) is attached as well,you can disable it here.
noBalloon boolean optional If set to TRUE the static balloon is not displayed
Returns:
true if attached, false if not; if both noTooltip and noBalloon parameters are set, this function returns FALSE and has no effect.

staticbcdui.widgetNg.commons.balloon.displayHintBalloon()

widgetNg/commons.js, line 223
permanently displays the hint-balloon for given htmlElementId using the default tooltip technique but reposition it (next to the element) as tray-message, you have to hide the the balloon executing general hideHintBalloon() configuration params: - balloonRendererId configuration object is expected to be in the element map: bcdui.widgetNg.commons.balloon.MAPKEY_CONFIG

staticbcdui.widgetNg.commons.balloon.hideHintBalloon()

widgetNg/commons.js, line 298
hides previously visible balloon

staticbcdui.widgetNg.commons.balloon.messagesToXML()

widgetNg/commons.js, line 318
construct XML string out of messages and tooltip data DTD: BalloonData<Tooltip?,Messages?> Tooltip<CDATA> ValidationMessages<Item+> Item<CDATA>
Returns:
NULL (if no messages found / tooltip) or DOM string