Class midcom_helper_datamanager_widget_communityhtml

Description

This is a widget to handle the simple "communityhtml" type, which is a very simplified form of bbcode.

This widget can only be used with the communityhtml type, for which it is enforced as widget.

Configuration parameters:

Configuration is done by the datatype.

Sample configuration

 "communityhtml" => Array (
     "description" => "Content",
     "datatype" => "communityhtml"
 ),

CSS Styles in use by the Widget

The toolbar is a br-separated span.communityhtml_toolbar within the label of the field. Its contents have no further style.

The input field is of textarea.communityhtml.

Located in /midcom/helper/datamanager/widget_communityhtml.php (line 40)

midcom_helper_datamanager_widget
   |
   --midcom_helper_datamanager_widget_communityhtml
Variable Summary
 Array $_colors
 Array $_sizes
 Array $_smileys
Method Summary
 void draw_view ()
 void draw_widget ()
 void _constructor (mixed &$datamanager, mixed $field, mixed $defaultvalue)
Variables
Array $_colors (line 56)

List of colors, as passed from the communityhtml type.

  • access: private
Array $_sizes (line 64)

List of font sizes, as passed from the communityhtml type.

  • access: private
Array $_smileys (line 48)

List of smileys, as passed from the communityhtml type.

  • access: private

Inherited Variables

Inherited from midcom_helper_datamanager_widget

midcom_helper_datamanager_widget::$missingrequired
midcom_helper_datamanager_widget::$required
midcom_helper_datamanager_widget::$_datamanager
midcom_helper_datamanager_widget::$_field
midcom_helper_datamanager_widget::$_fieldname
midcom_helper_datamanager_widget::$_l10n
midcom_helper_datamanager_widget::$_l10n_midcom
midcom_helper_datamanager_widget::$_value
Methods
draw_view (line 74)
void draw_view ()

Redefinition of:
midcom_helper_datamanager_widget::draw_view()
Wenn called, this method should display the current data without any editing widget.
draw_widget (line 120)

This renders the complete toolbar based on the main type configuration.

void draw_widget ()

Redefinition of:
midcom_helper_datamanager_widget::draw_widget()
This method draws the HTML-Form widgets required to edit the data. This can be anything from a single form tag to a full list of them. Note, that you will be automatically enclosed within the calls to draw_widget_start and draw_widget_end.
draw_widget_start (line 101)

Add the required JScript stuff before the actual widget so that it doesn't interfere with the label stuff.

void draw_widget_start ()

Redefinition of:
midcom_helper_datamanager_widget::draw_widget_start()
This is the default widget "introduction" code rendered before the actual field code. It will open a <label> tag and display the heading.
get_css_classes_required (line 83)

Set the css class to always include the communityhtml class.

  • return: The CSS classes indicating the required state.
string get_css_classes_required ()

Redefinition of:
midcom_helper_datamanager_widget::get_css_classes_required()
Evaluates the required and missingrequired field states and
_constructor (line 66)
void _constructor (mixed &$datamanager, mixed $field, mixed $defaultvalue)

Redefinition of:
midcom_helper_datamanager_widget::_constructor()
The constructor populates the internal members with a reference to the datamanger we belong to, the definition of the field we use and the default value we should use to initialize the widget's data.

Inherited Methods

Inherited From midcom_helper_datamanager_widget

 midcom_helper_datamanager_widget::midcom_helper_datamanager_widget()
 midcom_helper_datamanager_widget::draw_helptext()
 midcom_helper_datamanager_widget::draw_view()
 midcom_helper_datamanager_widget::draw_widget()
 midcom_helper_datamanager_widget::draw_widget_end()
 midcom_helper_datamanager_widget::draw_widget_start()
 midcom_helper_datamanager_widget::get_css_classes_required()
 midcom_helper_datamanager_widget::get_value()
 midcom_helper_datamanager_widget::set_value()
 midcom_helper_datamanager_widget::_constructor()
 midcom_helper_datamanager_widget::_read_formdata()

Documentation generated on Mon, 21 Nov 2005 18:24:39 +0100 by phpDocumentor 1.3.0RC3