top

SF.UI.WIDGET

** This class will not be supported in 2015.

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


This is the base class for all widgets.

Add the following line for sf.ui.widget 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 sf.ui.widget class like this :

  ex) var widget = sf.ui.widget;


Properties

NameTypeValueDescription
baseCSSClassStringBase CSS class added to the widget instance
eventNamespaceStringEvent namespace added by default to all the events triggered by the widget
widgetNameStringThe Widget name

Methods

addCallback

Description
This function adds the callback function for the specified event.
Parameters
■eventName 
  - String|Object
  - Name of the event or literal object with pairs eventName: Function|Array<Function>. It should be event name without eventNamespace 
■Fn 
  - Function|Array<Function>
  - Callback function or Array of callback functions
Return■Object
  - this
Emulator SupportN
SDK ConstraintNone
Example
Add more callbacks for various events.
 


$("#instance").myWidget("addCallback", {
    "show": function () {
        alert("Can You see me?");
    },
    "beforeshow": foo,
    "hide": [foo, Obj.bar]
});

destroy

Description
This function destroys the widget instance.
Parameters
none
Return■Object
  - this
Emulator SupportN
SDK ConstraintNone
Example
//Destroy widget instance.
 
$("#instance").myWidget("destroy");

extend

Description
This function extends the widget instance.
Parameters
■name 
  - String|Object
  - Property name or literal object of name:value pairs 
■Value 
  - Function|Array<Function>
  - Callback function or Array of callback functions
Return■Object
  - this
Emulator SupportN
SDK ConstraintNone
Example
//Extend widget instance
 
$("#instance").myWidget().myWidget("extend", "newFunction", function (value) {
        alert(value);
        return this; // let's make new function chainable
    })
    .myWidget("newFunction", "Is there anybody out there?");

hide

Description
This function hides the element returned by the widget function.
Parameters
none
Return■Object
  - this
Emulator SupportN
SDK ConstraintNone
Example
//Hide element
 
$("#instance").myWidget("hide");

option

Description
This function is the setter/getter for properties of “options” object.
Parameters
■name 
  - String|Object
  - Name 
■value 
  - Any type
  - Value
Return[get option]
■Any Types
  - if ‘value’; is not defined, returns the value. 

[set option]
■Object
  - if ‘value’ is defined, returns this.
Emulator SupportN
SDK ConstraintNone
Example
//Set value for bigValue property
 
$("#instance").myWidget("option", "bigValue", 12345678);

removeAllCallbacks

Description
This function removes all the callbacks. Only the callbacks added with the addCallbacks function, or passed on initialization of instance, are removed.
Parameters
none
Return■Object
  - this
Emulator SupportN
SDK ConstraintNone
Example
//Remove all callbacks for widget instance
 
$("#instance").myWidget("removeAllCallbacks");

removeCallback

Description
This function removes the specified callback or all the callbacks for the specified event. Only the callbacks added with the addCallbacks function, or passed on initialization of the instance are removed with this function. If fn is undefined, all the callbacks for the specified event are removed.
Parameters
■eventName 
  - String
  - Name of event without ‘eventNamespace’ 
■Fn 
  - Function
  - Callback function to remove
Return■Object
  - this
Emulator SupportN
SDK ConstraintNone
Example
[Example 1]

//Remove specific callback for event ‘show’
 
function onShow() {
    alert("Can you see me?");
}
$("#instance").myWidget("addCallback", "show", onShow);
...
$("#instance").myWidget("removeCallback", "show", onShow);
 
[Example 2]
 
//Callbacks passed “on the fly” to addCallback function can not be removed
 
$("#instance").myWidget("addCallback", "show", function () {
    alert("Can you see me?");
});
// This will not work
$("#instance").myWidget("removeCallback", "show", function () {
    alert("Can you see me?");
});

show

Description
This function shows the element returned by the widget function.
Parameters
none
Return■Object
  - this
Emulator SupportN
SDK ConstraintNone
Example
$("#instance").myWidget("show");

widget

Description
This function returns the DOM element (wrapped as jQuery object) representing the widget instance. It is, by default, the element passed to the constructor.
Parameters
none
Return■Object
  - jQuery object
Emulator SupportN
SDK ConstraintNone
Example
var widgetHandler = $("#instance").myWidget("widget");