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

Class: Widget_Preference

Source Location: /Widget/Preference.php

Class Overview


Widget Preference.

Variables

Methods



Class Details

[line 25] Widget Preference.
[ Top ]

Class Variables

$_defaultValue =

[line 53]

Preference default value.

Tags:

access:  protected
Type:   string
[ Top ]

$_label =

[line 46]

Preference label.

Tags:

access:  protected
Type:   string
[ Top ]

$_listOptions =

[line 67]

Preference options for 'list' type.

Tags:

access:  protected
Type:   array
[ Top ]

$_name =

[line 39]

Preference name.

Tags:

access:  protected
Type:   string
[ Top ]

$_onchangeCallback =

[line 60]

Preference onchange callback.

Tags:

access:  protected
Type:   string
[ Top ]

$_rangeOptions =

[line 74]

Preference options for 'range' type.

Tags:

access:  protected
Type:   array
[ Top ]

$_type =

[line 32]

Preference type.

Tags:

access:  protected
Type:   string
[ Top ]

Class Methods


constructor __construct [line 81]

Widget_Preference __construct( string $type)
Preference constructor.

Tags:

access:  public

Parameters:

string   $type  
[ Top ]

method addListOption [line 196]

void addListOption( string $value, [string $label = ''])
Add a new option to the list.

Tags:

access:  public

Parameters:

string   $value  
string   $label  
[ Top ]

method getDefaultValue [line 155]

string getDefaultValue( )
Returns the preference default value.

Tags:

access:  public
[ Top ]

method getLabel [line 135]

string getLabel( )
Returns the preference label.

Tags:

access:  public
[ Top ]

method getListOptions [line 212]

array getListOptions( )
Returns the preference list options.

Tags:

access:  public
[ Top ]

method getName [line 115]

string getName( )
Returns the preference name.

Tags:

access:  public
[ Top ]

method getOnchangeCallback [line 175]

string getOnchangeCallback( )
Returns the preference 'onchange' callback function name.

Tags:

access:  public
[ Top ]

method getRangeOptions [line 236]

array getRangeOptions( )
Returns the preference range options.

Tags:

access:  public
[ Top ]

method getType [line 95]

string getType( )
Returns the preference type.

Tags:

access:  public
[ Top ]

method setDefaultValue [line 145]

void setDefaultValue( string $defaultValue)
Sets the preference default value.

Tags:

access:  public

Parameters:

string   $defaultValue  
[ Top ]

method setLabel [line 125]

void setLabel( string $label)
Sets the preference label.

Tags:

access:  public

Parameters:

string   $label  
[ Top ]

method setListOptions [line 185]

void setListOptions( $options)
Sets the preference list options.

Tags:

access:  public

Parameters:

array   $options  
[ Top ]

method setName [line 105]

void setName( string $name)
Sets the preference name.

Tags:

access:  public

Parameters:

string   $name  
[ Top ]

method setOnchangeCallback [line 165]

void setOnchangeCallback( string $onchange)
Sets the preference 'onchange' callback function name.

Tags:

access:  public

Parameters:

string   $onchange  
[ Top ]

method setRangeOptions [line 224]

void setRangeOptions( int $step, int $min, int $max)
Sets the preference range options.

Tags:

access:  public

Parameters:

int   $step  
int   $min  
int   $max  
[ Top ]

method toArray [line 246]

array toArray( )
Retrieves the preferences attributes in an array.

Tags:

access:  public
[ Top ]

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