bbbfly-cjs-controls

Index Files Packages Globals

bbbfly.hint. Hintified

Implements easy hint implementation for any control.

Properties

Name Type Default Description
HintDef object null optional ngTextHint definition shared by all hints
HintDefs Array.<object> null optional ngTextHint definitions with control hint IDs as keys
HintMessages Array.<resource> null optional Hint text resouce names with control hint IDs as keys
HintXL px optional Hint hotspot distance from left (will be used to calculate HintX)
HintXR px optional Hint hotspot distance from right (will be used to calculate HintX)
HintYT px optional Hint hotspot distance from top (will be used to calculate HintY)
HintYB px optional Hint hotspot distance from bottom (will be used to calculate HintY)

Methods

HideHint (hintId){boolean}

base/hint.js, line 231
Parameters:
Name Type Description
hintId string Control hint ID
See:
Returns:
Type Description
boolean If there was any hint to hide

HideHints (){boolean}

base/hint.js, line 243
See:
Returns:
Type Description
boolean If there was any hint to hide

ShowHint (hintId, message){boolean}

base/hint.js, line 216
Parameters:
Name Type Description
hintId string Control hint ID
message string Hint text message
See:
Returns:
Type Description
boolean If hint was shown

Events

OnCreateHint (control, hintId, hintDef){boolean}

base/hint.js, line 188
Parameters:
Name Type Description
control ngControl Control reference
hintId string Control hint ID
hintDef object Hint control definition
See:
Returns:
Type Description
boolean If hint can be created

OnShowHint (control, hintId, hint){boolean}

base/hint.js, line 201
Parameters:
Name Type Description
control ngControl Control reference
hintId string Control hint ID
hint ngTextHint Hint to be shown
See:
Returns:
Type Description
boolean If hint can be shown