Class ecm.widget.HoverHelp

Extends idx.widget.HoverHelp.
Provides a widget that is used to display the question mark icon that links to help in the user interface.
Defined in: <ecm\widget\HoverHelp.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.HoverHelp()

Field Summary

Field Attributes	Field Name and Description
	isFocusable Boolean indicating if the hover help icon is focusable.

Fields borrowed from class idx.widget.HoverHelp:: allowLimitedSize, baseHref, clickToOpen, disabled, hideDelay, href, hrefKeyPrefix, hrefKeySuffix, hrefLabel, idxHCDefaults, message, messageKeyPrefix, messageKeySuffix, profile, resources, showCloseIcon, showDelay, topicID

Method Summary

Method Attributes	Method Name and Description
	closeDropDownDialog() Closes the drop-down dialog.
	destroy() Destroys.
	focus() Focus on the button if `isFocusable`.
	isOpenDropDownDialog() Boolean indicating if the drop-down dialog is open.
	openDropDownDialog(focusFieldOnClose) Opens the drop-down dialog.
	postCreate()
	setFocusable(isFocusable) Determines if tabbing will or will not focus on this hover help.

Methods borrowed from class idx.widget.HoverHelp:: buildRendering, constructor, postMixInProperties, startup

Constructor Detail

ecm.widget.HoverHelp()

Field Detail

isFocusable

Boolean indicating if the hover help icon is focusable.

Method Detail

closeDropDownDialog()

Closes the drop-down dialog.

destroy()

Destroys.

focus()

Focus on the button if isFocusable.

isOpenDropDownDialog()

Boolean indicating if the drop-down dialog is open.

Returns:: Boolean indicating if the drop-down dialog is open.

openDropDownDialog(focusFieldOnClose)

Opens the drop-down dialog.

Parameters:
focusFieldOnClose: The field to focus on when the drop-down dialog is closed.

postCreate()

setFocusable(isFocusable)

Determines if tabbing will or will not focus on this hover help.

Parameters:
isFocusable: Boolean indicating if the hover help icon is focusable during tab.