NAME

Krang::ElementClass::PoorText - Base class for PoorText element classes

SYNOPSIS

None.

DESCRIPTION

This module inherits from Krang::ElementClass and provides the base class for PoorText elementclasses like Krang::ElementClass::PoorText.

INTERFACE

OBJECT ATTRIBUTES

All the normal Krang::ElementClass attributes are available, plus:

• type
  
May be 'text' or 'textarea' to mimic the two flavors of HTML text input and textarea fields.
• width
  
The width of the edit area. Defaults to 400px.
• height
  
The height of the edit area. For type 'textarea' defaults to 120px. For type 'text' this option takes no effect.
• commands
  
This can be either a string denoting a pre-cooked set of WYSIWYG commands or an array or command names. The pre-cooked sets must be defined by concrete element classes inheriting from this base class. See also command_spec(). Available commands are:

   bold          italic       underline
   strikethrough subscript    superscript
   cut           copy         paste
   align_left    align_center align_right justify
   indent        outdent
   add_html      delete_html  add_story_link
   redo          undo
   specialchars  help         toggle_selectall) ],

Most of these commands should be self-evident. Some, however, are not:

• add_html
  
This command opens a popup allowing to wrap the selected text with a A, ABBR or ACRONYM tag.
• delete_html
  
Deletes an A, ABBR or ACRONYM around the current selection.
• add_story_link
  
This command hooks Krang's StoryLink selection into PoorText fields.
• specialchars
  
This command displays a second toolbar allowing to insert double and single curly quotes as well as the ndash.
• toggle_selectall
  
This command is only accessible via the keyboard using the default shortcut Ctrl-a. PoorText implements this command as a toggle. When deselecting, the original position of the cursor or the original selection is restituted.

• command_button_bar
  
This boolean determines whether a button bar with the configured commands will be displayed when the edit area receives focus. (You might want to just use the shortcuts. Which ones? Press Ctrl-h). The default is true.
• special_char_bar
  
If true, the specialchar button bar will be displayed when the edit area receives focus. In this case, even if the command button bar is configured to contain the specialchars command (the omega sign), this command will not be present. Defaults to false.
• shortcut_for
  
This hashref maps commands and specialchars to shortcuts. The default is:

    bold              => 'ctrl_b',
    italic            => 'ctrl_i',
    underline         => 'ctrl_u',
    subscript         => 'ctrl_d',
    superscript       => 'ctrl_s',
    strikethrough     => 'ctrl_t',
    toggle_selectall  => 'ctrl_a',
    add_html          => 'ctrl_l',
    delete_html       => 'ctrl_shift_l',
    add_story_link    => 'ctrt_shift_s',
    redo              => 'ctrl_y',
    undo              => 'ctrl_z',
    help              => 'ctrl_h',
    cut               => 'ctrl_x',
    copy              => 'ctrl_c',
    paste             => 'ctrl_v',
    specialchars      => 'ctrl_6',
    align_left        => 'ctrl_q',
    align_center      => 'ctrl_e',
    align_right       => 'ctrl_r',
    justify           => 'ctrl_w',
    indent            => 'tab',
    outdent           => 'shift_tab',
    lsquo             => 'ctrl_4',
    rsquo             => 'ctrl_5',
    ldquo             => 'ctrl_2',
    rdquo             => 'ctrl_3',
    ndash             => 'ctrl_0',

(See htdocs/poortext/src/poortext_core.js for more information)

METHODS

• $pkg->poortext_init()
  
This method returns as a string the one time JavaScript initializing PoorText fields. The Javascript pulls in the browser-specific PoorText JavaScript file, installs a mouse down handler to enable story previewing on StoryLinks inserted in PoorText fields and initializes those fields.
• $pkg->get_css_class()
  
This method returns a string consisting of CSS class names used to style PoorText fields depending on their flavor.
• $pkg->get_pt_config(has_content => $text)
  
This method takes a concret PoorText elementclass configuration and transforms it into a string representing a JavaScript object litteral used to configure PoorText elements.
• $pkg->get_command_spec(%arg)
  
This method is responsible for turning the ``commands'' configuration of PoorText fields into a string suitable to be integrated in inline JavaScript.
• $pkg->command_spec()
  
This method return a hashref mapping names of pre-cooked command sets to arrayrefs holding command names for PoorText elements. It must be implemented by child classes.

Example

    return {
        basic => [
            qw(bold     italic      underline
              cut      copy        paste
              add_html delete_html add_story_link
              redo     undo
              help     toggle_selectall)
        ],
        basic_with_special_chars => [
            qw(bold         italic      underline
              cut          copy        paste
              add_html     delete_html add_story_link
              redo         undo
              specialchars help        toggle_selectall)
        ],
        all => [
            qw(bold         italic       underline
              strikethrough subscript    superscript
              cut           copy         paste
              align_left    align_center align_right justify
              indent        outdent
              add_html      delete_html  add_story_link
              redo          undo
              specialchars  help         toggle_selectall)
        ],
    };

• $pkg->get_shortcut_spec(%arg)
  
This method is responsible for turning the ``shortcut_for'' configuration into a string suitable to be integrated in inline JavaScript.
• $pkg->html_scrubber(html => $html)
  
This method returns the scrubbed $html. It uses HTML::Scrubber internally.
• $pkg->filter_element_data(%arg)
  
This method is called by Krang::CGI::ElementEditor's ajaxy runmode 'filter_element_data' to scrub the HTML pasted into PoorText fields. It also takes care to convert pasted markup into tags understood by the WYSIWYG commands of the current browser. This runmode is called whenever the user triggers a paste action.
• $pkg->_do_linked_stories(%arg)
  
This method is the workhorse of 'linked_stories()', a method that must be implemented by child classes to make the linked-stories-mechanism work with StoryLinks inserted in PoorText fields. Moreover, this method stores a StoryID -> StoryURL map in the publish context under the key 'poortext_story_links'. Publish code may use this map to replace the IDs with URLs.
• $pkg->replace_story_id_with_url(%arg)
  
This method must be called by publish code to transform StoryLinks into real HTML links.
• $pkg->field_separator()
  
This method returns a field separator for multi-field elements. It's the first character of Unicode's first PUA (privat use area).