Listview_Widget Class Reference

Listview widget. More...

Inheritance diagram for Listview_Widget:
widget_Base

Public Member Functions

 get_metadata ()
 Return the default friendly name for the widget type.
 set_fixed ($branding=array())
 Disable everything configurable.
 options ()
 Return the list of options to use in this widget.
 get_suggested_title ()
 The backwards compatible way to get widget default title.
 index ()
 Print the widget contents here.

Protected Attributes

 $duplicatable = true
 Whether the widget can be copied.
 $branding
 Not really branding, but how to make this listview widget custom in the case of using it as a static embedded list view.

Detailed Description

Listview widget.

Author:
op5 AB

Member Function Documentation

Listview_Widget::get_metadata (  ) 

Return the default friendly name for the widget type.

default to the model name, but should be overridden by widgets.

Reimplemented from widget_Base.

Listview_Widget::get_suggested_title (  ) 

The backwards compatible way to get widget default title.

Returns:
string

Reimplemented from widget_Base.

Listview_Widget::index (  ) 

Print the widget contents here.

Concrete widgets typically want to override this.

Reimplemented from widget_Base.

Listview_Widget::options (  ) 

Return the list of options to use in this widget.

This should be an array of option instances, or - if you want to do more manual work - strings.

Actual widgets typically want to extend this method.

Returns:
array of option

Reimplemented from widget_Base.

Listview_Widget::set_fixed ( branding = array()  ) 

Disable everything configurable.

This is useful when including the widget with generetated parameters from a controller.


Field Documentation

Listview_Widget::$branding [protected]
Initial value:
 array(
                'listview_link' => true
        )

Not really branding, but how to make this listview widget custom in the case of using it as a static embedded list view.

Listview_Widget::$duplicatable = true [protected]

Whether the widget can be copied.

Setting this to true requires testing, so default to the more backwards compatible mode

Reimplemented from widget_Base.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables

Generated on 19 Dec 2018 for ninja by  doxygen 1.6.1