Netvibes
[ class tree: Netvibes ] [ index: Netvibes ] [ all elements ]

Class: Widget

Source Location: /Widget.php

Class Overview


This class represents a widget instance.

Variables

Methods



Class Details

[line 25] This class represents a widget instance.
[ Top ]

Class Variables

$_body =

[line 88]

Widget XHTML body.

Tags:

access:  protected
Type:   string
[ Top ]

$_coreLibrary =  'uwa'

[line 110]

Widget core library.

Tags:

access:  protected
Type:   unknown_type
[ Top ]

$_externalCss =

[line 67]

Widget external stylesheets URL.

Tags:

access:  protected
Type:   array
[ Top ]

$_externalJs =

[line 81]

Widget external Javascript libraries URL.

Tags:

access:  protected
Type:   array
[ Top ]

$_icon =

[line 95]

Widget icon URL.

Tags:

access:  protected
Type:   string
[ Top ]

$_metadata =

[line 46]

Widget metadata.

Tags:

access:  protected
Type:   array
[ Top ]

$_preferences =

[line 53]

Widget preferences.

Tags:

access:  protected
Type:   array
[ Top ]

$_richIcon =

[line 102]

Widget rich icon URL.

Tags:

access:  protected
Type:   string
[ Top ]

$_script =

[line 74]

Widget JavaScript controller.

Tags:

access:  protected
Type:   string
[ Top ]

$_style =

[line 60]

Widget inline styles.

Tags:

access:  protected
Type:   string
[ Top ]

$_title =

[line 39]

Widget title.

Tags:

access:  protected
Type:   string
[ Top ]

$_url =

[line 32]

Widget URL.

Tags:

access:  protected
Type:   string
[ Top ]

Class Methods


constructor __construct [line 115]

Widget __construct( [ $url = ''])
Widget constructor.

Tags:

access:  public

Parameters:

   $url  
[ Top ]

method addPreference [line 209]

void addPreference( string $name, Preference $preference)
Adds a widget preference.

Tags:

access:  public

Parameters:

string   $name  
Preference   $preference  
[ Top ]

method getBody [line 377]

string getBody( )
Returns the widget body markup

Tags:

access:  public
[ Top ]

method getCompressedScript [line 316]

The getCompressedScript( )
Compresses and returns the widget JavaScript code.

Tags:

return:  compressed code
access:  public
[ Top ]

method getCoreLibrary [line 347]

string getCoreLibrary( )
Returns the name of the core library in use.

Tags:

access:  public
[ Top ]

method getExternalScripts [line 357]

array getExternalScripts( )
Returns the widget external JavaScript libraries.

Tags:

access:  public
[ Top ]

method getExternalStylesheets [line 286]

array getExternalStylesheets( )
Returns the widget external stylesheets.

Tags:

access:  public
[ Top ]

method getIcon [line 397]

string getIcon( )
Returns the widget icon URL.

Tags:

access:  public
[ Top ]

method getMetadata [line 169]

array getMetadata( )
Returns the widget metadata.

Tags:

return:  metadata
access:  public
[ Top ]

method getMetadataJson [line 184]

string getMetadataJson( )
Returns the widget metadata in JSON format.

Tags:

return:  JSON metadata
access:  public
[ Top ]

method getMetas [line 174]

void getMetas( )

Tags:

access:  public
[ Top ]

method getPreference [line 224]

void getPreference( $name)

Tags:

access:  public

Parameters:

   $name  
[ Top ]

method getPreferences [line 219]

array getPreferences( )
Returns the widget preferences.

Tags:

access:  public
[ Top ]

method getPreferencesJson [line 238]

string getPreferencesJson( )
Returns the widget preferences in JSON format.

Tags:

return:  JSON preferences
access:  public
[ Top ]

method getRichIcon [line 417]

string getRichIcon( )
Returns the widget rich icon URL.

Tags:

access:  public
[ Top ]

method getScript [line 306]

The getScript( )
Returns the widget JavaScript code.

Tags:

return:  JavaScript code
access:  public
[ Top ]

method getStyle [line 266]

string getStyle( )
Returns the widget inline CSS styles.

Tags:

access:  public
[ Top ]

method getTitle [line 149]

string getTitle( )
Returns the widget title.

Tags:

access:  public
[ Top ]

method getUrl [line 129]

string getUrl( )
Returns the widget skeleton URL.

Tags:

access:  public
[ Top ]

method setBody [line 367]

void setBody( string $body)
Sets the widget body markup

Tags:

access:  public

Parameters:

string   $body  
[ Top ]

method setCoreLibrary [line 337]

void setCoreLibrary( string $js)
Sets the name of the core library in use.

Tags:

access:  public

Parameters:

string   $js  
[ Top ]

method setExternalScripts [line 327]

void setExternalScripts( $js)
Sets the widget external JavaScript libraries.

Tags:

access:  public

Parameters:

array   $js  
[ Top ]

method setExternalStylesheets [line 276]

void setExternalStylesheets( $css)
Sets the widget external stylesheets.

Tags:

access:  public

Parameters:

array   $css  
[ Top ]

method setIcon [line 387]

void setIcon( string $icon)
Sets the widget icon URL.

Tags:

access:  public

Parameters:

string   $icon  
[ Top ]

method setMetadata [line 159]

void setMetadata( $metadata)
Sets the widget metadata.

Tags:

access:  public

Parameters:

array   $metadata  
[ Top ]

method setPreferences [line 198]

void setPreferences( $preferences)
Sets the widget preferences.

Tags:

access:  public

Parameters:

array   $preferences  
[ Top ]

method setRichIcon [line 407]

void setRichIcon( string $richIcon)
Sets the widget rich icon URL.

Tags:

access:  public

Parameters:

string   $richIcon  
[ Top ]

method setScript [line 296]

void setScript( string $script)
Sets the widget JavaScript code.

Tags:

access:  public

Parameters:

string   $script  
[ Top ]

method setStyle [line 256]

void setStyle( string $style)
Sets the widget inline CSS styles.

Tags:

access:  public

Parameters:

string   $style  
[ Top ]

method setTitle [line 139]

void setTitle( string $title)
Set the widget title.

Tags:

access:  public

Parameters:

string   $title  
[ Top ]

Documentation generated on Fri, 30 May 2008 16:46:44 +0200 by phpDocumentor 1.4.1