Docs For Class FEBBCodeTextArea

Description

BBCodeTeatArea class widget. A text area widget to input and parse BBCode formatted text.

author: Mike Walsh <mike_walsh@mindspring.com>
copyright: LGPL - See LICENCE
see: FETextArea::FETextArea()
access: public

Located in /widgets/BBCode.inc (line 37)

FormElement
   |
   --FEBoxElement
      |
      --FETextArea
         |
         --FEBBCodeTextArea

Variable Summary

mixed $_header_size

mixed $_nl2br

mixed $_strip_tags

mixed $_wrapper_class

Method Summary

int get_header_size ()

boolean get_nl2br ()

string get_parsed_value ()

boolean get_strip_tags ()

mixed get_value ()

string get_value_text (mixed 0)

string get_wrapper_class ()

none set_header_size (int $size)

void set_nl2br ([ $nl2br = true])

void set_strip_tags ([ $strip_tags = true])

void set_wrapper_class ([ $wrapper_class = null])

Variables

mixed $_header_size = 3 (line 58)

Default header size

mixed $_nl2br = false (line 42)

Newline breaking property

mixed $_strip_tags = true (line 47)

HTML tag stripping property

mixed $_wrapper_class = null (line 52)

CSS class to wrap parsed text in

Inherited Variables

Inherited from FETextArea

FETextArea::$_limit_char_count

Inherited from FEBoxElement

FEBoxElement::$_height
FEBoxElement::$_width

Inherited from FormElement

FormElement::$onBlurJS
FormElement::$onChangeJS
FormElement::$onClickJS
FormElement::$onFocusJS
FormElement::$onSubmitJS
FormElement::$_attributes
FormElement::$_element_name
FormElement::$_errors
FormElement::$_error_message
FormElement::$_form_name
FormElement::$_has_error
FormElement::$_has_form_on_submit
FormElement::$_is_disabled
FormElement::$_is_readonly
FormElement::$_is_required
FormElement::$_label_colon_flag
FormElement::$_label_text
FormElement::$_required_field_marker
FormElement::$_slave_elements
FormElement::$_stripslashes
FormElement::$_style_attributes
FormElement::$_validation_enabled
FormElement::$_value

Methods

get_header_size (line 141)

Get the header size

return: - header size 1-6 (h1-h6)

int get_header_size ()

get_nl2br (line 74)

Get the flag for handling newlines

return: - true to map newlines to BR tags

boolean get_nl2br ()

get_parsed_value (line 185)

Parse the BBCode text value

return: - the parsed text

string get_parsed_value ()

get_strip_tags (line 93)

Get the flag for stripping HTML tags in the input

return: - true to strip tags

boolean get_strip_tags ()

get_value (line 168)

This function will return the elements value

mixed get_value ()

Redefinition of:

FormElement::get_value(): This function will return the elements value

get_value_text (line 157)

This provides an overridden method for the FormContent to get access to the text associated with a field. This is only available on FEBBCodeTextArea elements.

It is used during Confirmation and parses the BBCode so the confirmation page displays the text as it will appear when rendered as HTML.

return: - the text associated

string get_value_text (mixed 0)

mixed 0: the value to look up

Redefinition of:

FormElement::get_value_text(): This provides a method

get_wrapper_class (line 112)

Get the class for wrapping parsed text in

return: - name of the class

string get_wrapper_class ()

set_header_size (line 125)

Sets the size of header text used by the [h] tag

author: Mike Walsh <mike_walsh@mindspring.com>
access: public

none set_header_size (int $size)

int $size: - size of header (1-6)

set_nl2br (line 64)

Set the flag for handling newlines

void set_nl2br ([ $nl2br = true])

$nl2br

set_strip_tags (line 83)

Set the flag for stripping HTML tags in the input

void set_strip_tags ([ $strip_tags = true])

$strip_tags

set_wrapper_class (line 102)

Set the class for wrapping parsed text in

void set_wrapper_class ([ $wrapper_class = null])

$wrapper_class

Inherited Methods

Inherited From FETextArea

FETextArea::FETextArea()
FETextArea::get_element()
FETextArea::set_cols()
FETextArea::set_rows()
FETextArea::validate()

Inherited From FEBoxElement

FEBoxElement::FEBoxElement()

Inherited From FormElement

FormElement::FormElement()
FormElement::build_id_name()
FormElement::create_element_name()
FormElement::enable_validation()
FormElement::form_tag_onsubmit()
FormElement::get_attribute()
FormElement::get_confirm_element()
FormElement::get_element()
FormElement::get_element_name()
FormElement::get_errors()
FormElement::get_error_message()
FormElement::get_form_element()
FormElement::get_init_value()
FormElement::get_label()
FormElement::get_label_text()
FormElement::get_required_symbol()
FormElement::get_slave_elements()
FormElement::get_tabindex()
FormElement::get_value()
FormElement::get_value_text()
FormElement::has_error()
FormElement::is_disabled()
FormElement::is_readonly()
FormElement::is_required()
FormElement::javascript()
FormElement::onBlur()
FormElement::onChange()
FormElement::onClick()
FormElement::onFocus()
FormElement::onSubmit()
FormElement::set_attribute()
FormElement::set_colon_flag()
FormElement::set_data_all_slaves()
FormElement::set_disabled()
FormElement::set_element_name()
FormElement::set_error_message()
FormElement::set_form_name()
FormElement::set_label_text()
FormElement::set_onBlur()
FormElement::set_onChange()
FormElement::set_onClick()
FormElement::set_onFocus()
FormElement::set_onSubmit()
FormElement::set_readonly()
FormElement::set_required()
FormElement::set_required_symbol()
FormElement::set_slave_data()
FormElement::set_slave_elements()
FormElement::set_stripslashes()
FormElement::set_style_attribute()
FormElement::set_tabindex()
FormElement::set_title()
FormElement::set_value()
FormElement::validate()
FormElement::_build_element_attributes()
FormElement::_build_javascript()
FormElement::_do_validation()
FormElement::_sanitize_string()