Class Widget

Simplifies the creation of widget interfaces

Html

Extended by

Blesta\Core\Util\Widgets\AbstractWidget

Extended by

Widget

Package: blesta\helpers\widget
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at helpers/widget/widget.php

Methods summary
`public`	# `__construct( )` Initializes the widget helper Initializes the widget helper
`public`	# `clear( )` Clear this widget, making it ready to produce the next widget Clear this widget, making it ready to produce the next widget
`public`	# `setTabs( array $tabs )` Sets navigation tabs within the widget Sets navigation tabs within the widget Parameters `$tabs` A multi-dimensional array of tab info including: name The name of the tab to be displayed current True if this element is currently active attributes An array of attributes to set for this tab (e.g. array('href'=>"#"))
`public`	# `setBadgeUri( string $uri )` Sets the URI to request when fetching a badge value for this widget Sets the URI to request when fetching a badge value for this widget Parameters `$uri` The URI to request for the badge value for this widget
`public`	# `setBadgeValue( string $value = null )` Sets the badge value to appear on this widget, any thing other than null will be displayed Sets the badge value to appear on this widget, any thing other than null will be displayed Parameters `$value` The value of the badge to be displayed
`public mixed`	# `create( string $title = null, array $attributes = null, string $render = null )` Creates the widget with the given title and attributes Creates the widget with the given title and attributes Parameters `$title` The title to display for this widget `$attributes` An list of attributes to set for this widget's primary container `$render` How to render the widget. Options include: full The entire widget content_section The full content including nav (everything excluding box frame and title section) common_box_content The content only (full_content excluding the nav) Returns mixed An HTML string containing the widget, void if the string is output automatically
`public mixed`	# `setRow( string $left = null, string $right = null )` Sets a row for this widget to be displayed. Sets a row for this widget to be displayed. Parameters `$left` An HTML string to set on the left of the row `$right` An HTML string to set on the right of the row Returns mixed An HTML string containing the row, void if the string is output automatically
`public mixed`	# `end( )` End the widget, closing an loose ends End the widget, closing an loose ends Returns mixed An HTML string ending the widget, void if the string is output automatically
`protected`	# `setFilterLink( )` Add the filter form toggle button to the list of widget links Add the filter form toggle button to the list of widget links Overrides `Blesta\Core\Util\Widgets\AbstractWidget::setFilterLink()`

Methods inherited from Blesta\Core\Util\Widgets\AbstractWidget
`output(), setAjaxFiltering(), setFilterHtml(), setFilters(), setHeaderLink(), setLinkButtons(), setLinks(), setOutput(), setStyleSheet(), setWidgetButton()`

Properties inherited from Blesta\Core\Util\Widgets\AbstractWidget
`$ajax_filtering, $eol, $filter_html, $filter_uri, $filters, $header_link, $link_buttons, $nav, $nav_type, $render, $return_output, $show_filters, $style_sheets, $widget_buttons`