top

SFKEYHELP

** This class will not be supported in 2015.

   All functionalities of sfKeyHelp class are more improved, integrating with CAPH. Therefore sfKeyHelp class is not supported since 2015 Smart TV. To use functions of sfKeyHelp class, refer to here.


This is the class for KeyHelp UI.

Add the following line for sfKeyHelp class into a html file your own :

  script type="text/javascript" src="$MANAGER_WIDGET/Common/af/2.0.0/loader.js">/script>

You can declare sfKeyHelp class like this :

  ex) $('#div ID').sfKeyHelp('method Name', parm1, parm2);

       $('#div ID').sfKeyHelp({ Json type });


Methods

hide

Description
This function hides the KeyHelp.
Parameters
none
Return■Void
Emulator SupportN
SDK ConstraintNone
Example
$('#Datepicker_keyhelp').sfKeyHelp('hide');

hideNotice

Description
This function hides notification message of KeyHelp. This function ignore the hiding timeout passed to showNotice method.
Parameters
none
Return■Object
  - jQuery object
Emulator SupportN
SDK ConstraintNone
Example
$("#keyhelp1").sfKeyHelp('hideNotice');

show

Description
This function shows the KeyHelp.
Parameters
none
Return■Void
Emulator SupportN
SDK ConstraintNone
Example
$('#dp1').sfKeyHelp('show');

showNotice

Description
This function shows notification message on left side of KeyHelp.
Parameters
■options 
  - Object
  - Options for notification. 
   * icons: ['voice', 'gesture', 'mouse'] : (Array) Icons of notification. This icon will be shown on the right of text. ('voice', 'gesture', 'mouse', 'printer')
   * text: 'Available' : (String) Text of notification.
   * timeout: 5000 : Timeout of hiding notification in milliseconds. Sets no timeout if you pass 0 for this.
Return■Object
  - jQuery object
Emulator SupportN
SDK ConstraintNone
Example
$("#keyhelp1").sfKeyHelp('showNotice', {icons:['voice', 'gesture', 'mouse'], text: 'Available', timeout: 5000});