cyberweb 0.4.174 → 0.5.225

data/lib/cyberweb/objectified/html_tags/base.rb

@@ -0,0 +1,960 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::Objectified::HtmlTags::Base
+# =========================================================================== #
+# require 'cyberweb/objectified/html_tags/base.rb'
+# < Cyberweb::Objectified::HtmlTags::Base
+# =========================================================================== #
+module Cyberweb
+
+module Objectified
+
+module HtmlTags
+
+# # =========================================================================== #
+# # === Cyberweb::Objectified::HtmlTags.print_or_return
+# #
+# # This is currently not implemented - the idea was to either return a
+# # String or display it at once. It will most likely be removed at
+# # a later point in time. For now (February 2022) it will remain here.
+# # =========================================================================== #
+# def self.print_or_return(i = :return)
+#   @print_or_return = i
+# end
+# 
+# print_or_return(:return)
+# 
+# # =========================================================================== #
+# # === Cyberweb::Objectified::HtmlTags.print_or_return?
+# # =========================================================================== #
+# def self.print_or_return?
+#   @print_or_return
+# end
+
+class Base # === Cyberweb::Objectified::HtmlTags::Base
+
+  require 'cyberweb/project/project.rb'
+  require 'cyberweb/constants/constants.rb'
+  require 'cyberweb/css_manager/css_manager.rb'
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @result
+    #
+    # This is the String that will be output / stored.
+    # ======================================================================= #
+    @result = ''.dup
+    # ======================================================================= #
+    # === @content
+    # ======================================================================= #
+    @content = ''.dup
+    # ======================================================================= #
+    # === @internal_hash
+    #
+    # This Hash keeps useful entries.
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :is_draggable
+    # ======================================================================= #
+    @internal_hash[:is_draggable] = false
+    # ======================================================================= #
+    # === :id
+    # ======================================================================= #
+    @internal_hash[:id] = nil
+    # ======================================================================= #
+    # === :title
+    #
+    # Must be nil initially.
+    # ======================================================================= #
+    @internal_hash[:title] = nil
+    # ======================================================================= #
+    # === :script
+    # ======================================================================= #
+    @internal_hash[:script] = ''.dup
+    # ======================================================================= #
+    # === :in_tag_script
+    # ======================================================================= #
+    @internal_hash[:in_tag_script] = ''.dup
+    # ======================================================================= #
+    # === :pre_content
+    # ======================================================================= #
+    @internal_hash[:pre_content] = ''.dup
+    # ======================================================================= #
+    # === :css_class
+    # ======================================================================= #
+    @internal_hash[:css_class] = ''.dup
+    # ======================================================================= #
+    # === :css_style
+    # ======================================================================= #
+    @internal_hash[:css_style] = ''.dup
+  end
+
+  # ========================================================================= #
+  # === on_hover_colour
+  #
+  # Note that this depends on corresponding CSS classes - if you do not
+  # define them then this is basically useless.
+  #
+  # The cyberweb project comes with these CSS classes bundled; or, if they
+  # are missing then they can be added still.
+  #
+  # Usage example:
+  #
+  #   button.on_hover_colour(:steelblue)
+  #
+  # ========================================================================= #
+  def on_hover_colour(
+      use_this_colour = :steelblue
+    )
+    append_css_class('on_hover_colour_'+use_this_colour.to_s)
+  end
+
+  # ========================================================================= #
+  # === on_mouse_hover
+  #
+  # This method will be triggered on a mouse-hover event.
+  # ========================================================================= #
+  def on_mouse_hover(&block)
+    # ======================================================================= #
+    # === Handle blocks first
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      # ===================================================================== #
+      # === Handle Hashes next
+      # ===================================================================== #
+      if yielded.is_a? Hash
+        # =================================================================== #
+        # === :bg
+        #
+        # This used to be hardcoded to white background. This should
+        # eventually become the background colour that was assigned,
+        # though.
+        #
+        # In January 2022 this method will check for a :fg entry. If this
+        # exits then it is used instead. White will still remain the
+        # default, though.
+        # =================================================================== #
+        if yielded.has_key? :bg
+          use_this_as_the_background_colour = 'white'
+          # ================================================================= #
+          # === :fg
+          #
+          # To enter this clause use a string such as the following:
+          #
+          #   div.on_mouse_hover {{ bg: :orange, fg: :lightblue }}
+          #
+          # ================================================================= #
+          if yielded.has_key? :fg
+            use_this_as_the_background_colour = yielded[:fg].to_s
+          end
+          if css_class? and css_class?.include?('BG_')
+            regex_to_use = /BG_(\w+)/ # See: https://rubular.com/r/3U0Xj10NUUAtOM
+            css_class? =~ regex_to_use # Apply the regex here.
+            use_this_as_the_background_colour = $1.to_s.dup
+          end
+          @internal_hash[:in_tag_script] <<
+            'onmouseover="this.style.background=\''+yielded[:bg].to_s+'\';" '\
+            'onmouseout="this.style.background=\''+use_this_as_the_background_colour+'\';"'
+        end
+      end
+    end
+  end; alias on_mouse_over on_mouse_hover # === on_mouse_over
+
+  # ========================================================================= #
+  # === project_base_dir?
+  # ========================================================================= #
+  def project_base_dir?
+    ::Cyberweb.project_base_dir?
+  end
+
+  # ========================================================================= #
+  # === name?
+  # ========================================================================= #
+  def name?
+    @internal_hash[:name].to_s
+  end
+
+  # ========================================================================= #
+  # === name=
+  #
+  # Note that this setter-method will not work for every tag.
+  #
+  # Usage example:
+  #
+  #   object.name = 'ask_a_question'
+  #
+  # ========================================================================= #
+  def name=(i)
+    @internal_hash[:name] = i
+  end; alias set_name name= # === set_Name
+
+  # ========================================================================= #
+  # === set_id
+  #
+  # This method allows the user to set a specific id for the HTML object
+  # at hand, such as a <div> tag.
+  #
+  # Note that there is an alias to this setter-method, called id(). This
+  # alias exists mostly as a convenience shortcut and it is not absolutely
+  # 100% certain that this method name will be retained as-is - after all
+  # it could be synonymous to .id?, and some users may expect it to be
+  # like this (e. g. .id()). Thus, if you want to be absolutely certain,
+  # it is recommended to use either set_id() or id=(), since the behaviour
+  # may change one day. This notice here was written in January of 2022.
+  # ========================================================================= #
+  def set_id(i = nil)
+    @internal_hash[:id] = i
+  end; alias id  set_id # === id
+       alias id= set_id # === id=
+
+  # ========================================================================= #
+  # === id?
+  #
+  # This method will return the value for the ID of the given HTML tag at
+  # hand.
+  # ========================================================================= #
+  def id?
+    @internal_hash[:id]
+  end
+
+  # ========================================================================= #
+  # === is_draggable
+  # ========================================================================= #
+  def is_draggable
+    @internal_hash[:is_draggable] = true
+  end
+
+  # ========================================================================= #
+  # === is_draggable?
+  # ========================================================================= #
+  def is_draggable?
+    @internal_hash[:is_draggable]
+  end
+
+  # ========================================================================= #
+  # === bblack1
+  # ========================================================================= #
+  def bblack1
+    unless @internal_hash[:css_class].include? 'bblack1'
+      @internal_hash[:css_class] << ' bblack1'
+    end
+  end
+
+  # ========================================================================= #
+  # === bblack2
+  # ========================================================================= #
+  def bblack2
+    @internal_hash[:css_class] << ' bblack2' unless @internal_hash[:css_class].include? 'bblack2'
+  end
+
+  # ========================================================================= #
+  # === very_light_yellowish_background
+  # ========================================================================= #
+  def very_light_yellowish_background
+    @internal_hash[:css_class] << ' BG_very_light_yellowish'
+  end
+
+  # ========================================================================= #
+  # === bblack3
+  # ========================================================================= #
+  def bblack3
+    @internal_hash[:css_class] << ' bblack3' unless @internal_hash[:css_class].include? 'bblack3'
+  end
+
+  # ========================================================================= #
+  # === bblack4
+  # ========================================================================= #
+  def bblack4
+    @internal_hash[:css_class] << ' bblack4' unless @internal_hash[:css_class].include? 'bblack4'
+  end
+
+  # ========================================================================= #
+  # === bblack5
+  # ========================================================================= #
+  def bblack5
+    @internal_hash[:css_class] << ' bblack5' unless @internal_hash[:css_class].include? 'bblack5'
+  end
+
+  # ========================================================================= #
+  # === bblack6
+  # ========================================================================= #
+  def bblack6
+    @internal_hash[:css_class] << ' bblack6' unless @internal_hash[:css_class].include? 'bblack6'
+  end
+
+  # ========================================================================= #
+  # === pad
+  # ========================================================================= #
+  def pad
+    @internal_hash[:css_style].rstrip!
+    @internal_hash[:css_style] << ' pad0_5em'
+  end
+
+  # ========================================================================= #
+  # === return_css_style
+  # ========================================================================= #
+  def return_css_style(
+      i = css_style?
+    )
+    return 'style="'+i.to_s.strip+'"'
+  end
+
+  # ========================================================================= #
+  # === return_css_class
+  # ========================================================================= #
+  def return_css_class(
+      i = css_class?
+    )
+    return 'class="'+i.to_s.strip+'"'
+  end
+
+  # ========================================================================= #
+  # === css_class?
+  # ========================================================================= #
+  def css_class?
+    @internal_hash[:css_class]
+  end
+
+  # ========================================================================= #
+  # === pad1px
+  # ========================================================================= #
+  def pad1px
+    @internal_hash[:css_class].rstrip!
+    @internal_hash[:css_class] << ' pad1px'
+  end
+
+  # ========================================================================= #
+  # === pad2px
+  # ========================================================================= #
+  def pad2px
+    @internal_hash[:css_class].rstrip!
+    @internal_hash[:css_class] << ' pad2px'
+  end
+
+  # ========================================================================= #
+  # === pad3px
+  # ========================================================================= #
+  def pad3px
+    @internal_hash[:css_class].rstrip!
+    @internal_hash[:css_class] << ' pad3px'
+  end
+
+  # ========================================================================= #
+  # === pad4px
+  # ========================================================================= #
+  def pad4px
+    @internal_hash[:css_class].rstrip!
+    @internal_hash[:css_class] << ' pad4px'
+  end
+
+  # ========================================================================= #
+  # === pad5px
+  # ========================================================================= #
+  def pad5px
+    @internal_hash[:css_class].rstrip!
+    @internal_hash[:css_class] << ' pad5px'
+  end
+
+  # ========================================================================= #
+  # === pad6px
+  # ========================================================================= #
+  def pad6px
+    @internal_hash[:css_class].rstrip!
+    @internal_hash[:css_class] << ' pad6px'
+  end
+
+  # ========================================================================= #
+  # === pad7px
+  # ========================================================================= #
+  def pad7px
+    @internal_hash[:css_class].rstrip!
+    @internal_hash[:css_class] << ' pad7px'
+  end
+
+  # ========================================================================= #
+  # === pad8px
+  # ========================================================================= #
+  def pad8px
+    @internal_hash[:css_class].rstrip!
+    @internal_hash[:css_class] << ' pad8px'
+  end
+
+  # ========================================================================= #
+  # === pad9px
+  # ========================================================================= #
+  def pad9px
+    @internal_hash[:css_class].rstrip!
+    @internal_hash[:css_class] << ' pad9px'
+  end
+
+  # ========================================================================= #
+  # === pad10px
+  # ========================================================================= #
+  def pad10px
+    @internal_hash[:css_class].rstrip!
+    @internal_hash[:css_class] << ' pad10px'
+  end
+
+  # ========================================================================= #
+  # === set_title
+  # ========================================================================= #
+  def set_title(i)
+    @internal_hash[:title] = i
+  end
+
+  # ========================================================================= #
+  # === title?
+  #
+  # This method must be guaranteed to return a String. Keep in mind
+  # that the title may be empty, though, so it is best to check in
+  # the downstream code base whether a title-tag was set or not.
+  # ========================================================================= #
+  def title?
+    @internal_hash[:title].to_s
+  end
+
+  # ========================================================================= #
+  # === css_style?
+  # ========================================================================= #
+  def css_style?
+    @internal_hash[:css_style]
+  end
+
+  # ========================================================================= #
+  # === set_css_style
+  # ========================================================================= #
+  def set_css_style(i)
+    @internal_hash[:css_style] = i
+  end; alias style=        set_css_style # === style=
+       alias css_style=    set_css_style # === css_style=
+       alias style         set_css_style # === style
+       alias css_style     set_css_style # === css_style
+       alias set_CSS_style set_css_style # === set_CSS_style
+
+  # ========================================================================= #
+  # === path_to_internal_javascript_file
+  #
+  # This method can be used like this:
+  #
+  #   path_to_internal_javascript_file 'disable_right_click.js'
+  #
+  # ========================================================================= #
+  def path_to_internal_javascript_file(i)
+    return "#{project_base_dir?}javascript_code/#{i}"
+  end
+
+  # ========================================================================= #
+  # === on_click_select
+  #
+  # This is a "shortcut" for selecting everything on an on-click event
+  # action.
+  # ========================================================================= #
+  def on_click_select
+    on_clicked { :select_everything }
+  end; alias on_clicked_select on_click_select # === on_clicked_select
+
+  # ========================================================================= #
+  # === return_javascript
+  # ========================================================================= #
+  def return_javascript(i)
+    return "\n<script>\n#{i}\n</script>\n"
+  end
+
+  # ========================================================================= #
+  # === add_this_to_javascript
+  #
+  # Use this method to add to the javascript <script> tag.
+  # ========================================================================= #
+  def add_this_to_javascript(i)
+    if @internal_hash[:script].nil?
+      @internal_hash[:script] = ''.dup
+    end
+    @internal_hash[:script] << i
+  end
+
+  # ========================================================================= #
+  # === is_an_objectified_html_tag?
+  # ========================================================================= #
+  def is_an_objectified_html_tag?
+    true
+  end
+
+  # ========================================================================= #
+  # === append_onto_the_css_class
+  #
+  # This method will append onto the CSS classes in use.
+  # ========================================================================= #
+  def append_onto_the_css_class(i)
+    @internal_hash[:css_class] << " #{i}"
+    @internal_hash[:css_class].strip!
+  end; alias acss                append_onto_the_css_class # === acss
+       alias append_to_css_class append_onto_the_css_class # === append_to_css_class
+       alias append_css_class    append_onto_the_css_class # === append_css_class
+       alias add_to_CSS_classes  append_onto_the_css_class # === add_to_CSS_classes
+       alias add_this_CSS_class  append_onto_the_css_class # === add_this_CSS_class
+
+  # ========================================================================= #
+  # === on_clicked
+  # ========================================================================= #
+  def on_clicked(&block)
+    # ======================================================================= #
+    # === Handle blocks first
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      # ===================================================================== #
+      # === Handle Symbols next
+      #
+      # Some Symbols have a special meaning. For instance, the Symbol
+      # :select_everything will select everything in the given HTML
+      # tag at hand.
+      # ===================================================================== #
+      if yielded.is_a? Symbol
+        case yielded
+        # =================================================================== #
+        # === :select_everything
+        # =================================================================== #
+        when :select_everything
+          @internal_hash[:onclick] = 'selectText(this.id)'
+          # ================================================================= #
+          # We also have to pull in the javascript file.
+          # ================================================================= #
+          _ = path_to_internal_javascript_file('select_everything_on_mouse_click_event.js')
+          if File.exist? _
+            @internal_hash[:script] << return_javascript(File.read(_))
+          else
+            puts "No file exists at #{_}"
+          end
+        end
+      # ===================================================================== #
+      # === Handle Hashes past this point
+      # ===================================================================== #
+      elsif yielded.is_a? Hash
+        # =================================================================== #
+        # === :javascript_pop_up
+        # =================================================================== #
+        if yielded.has_key? :javascript_pop_up
+          text_to_use = yielded.delete(:javascript_pop_up).to_s
+          @internal_hash[:onclick] = 'pop_up_this_text()'
+          @internal_hash[:script] << return_javascript(
+            'function pop_up_this_text() {
+              window.alert("'+text_to_use+'!");
+            }'
+          )
+        # =================================================================== #
+        # === :javascript_call
+        # =================================================================== #
+        elsif yielded.has_key? :javascript_call
+          @internal_hash[:onclick] = 'some_foobar()'
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === script?
+  # ========================================================================= #
+  def script?
+    @internal_hash[:script]
+  end
+
+  # ========================================================================= #
+  # === set_content
+  #
+  # Store the content of the HTML tag at hand via the following method.
+  #
+  # Note that Arrays that are passed into this method will NOT become
+  # Strings. The reason why that is the case is that some HTML elements,
+  # such as the html-dropbox, need an Array as input, not a String.
+  # Thus we would lose information if we were to ignore Arrays as
+  # input.
+  #
+  # This method currently has three aliases, but it is not certain
+  # whether these will be retained (comment here made in October 2021) -
+  # the future will show how useful these are.
+  #
+  # Note that the alias .text= was added in November 2021. I am not
+  # entirely certain whether it will be retained, but for now it is
+  # available.
+  # ========================================================================= #
+  def set_content(i)
+    if i.is_a? Hash
+      # ===================================================================== #
+      # === :id
+      #
+      # Invocation example:
+      #
+      #   create_entry2 id: 'entry_main_file'
+      #
+      # ===================================================================== #
+      if i.has_key? :id
+        set_id(i.delete(:id))
+      end
+      # ===================================================================== #
+      # === :class
+      # ===================================================================== #
+      if i.has_key? :class
+        set_CSS_class(i.delete(:class))
+      end
+    end
+    if i.is_a?(Hash) and i.empty?
+      i = ''
+    end
+    i = i.to_s.dup unless i.is_a? Array
+    @content = i
+  end; alias inject   set_content # === inject
+       alias value=   set_content # === value?
+       alias <<       set_content # === <<
+       alias text=    set_content # === text=
+       alias content= set_content # === content=
+
+  # ========================================================================= #
+  # === method_missing?
+  #
+  # Arguments explained:
+  #
+  #   The first is the name of the method you were trying to call.
+  #   The second is the args (*args) that were passed to the method.
+  #   The third is a block (&block) that was passed to the method.
+  #
+  # ========================================================================= #
+  def method_missing(
+      name_of_the_method, *args, &block
+    )
+    if ::Cyberweb.is_a_registered_html_tag?(name_of_the_method.to_s)
+      oop_name = "oop_#{name_of_the_method}"
+      result = send(oop_name.to_sym, args, &block).to_s
+      result = result.first if result.is_a? Array
+      append_onto_content(result)
+    else
+      super(name_of_the_method, args, &block)
+    end
+  end
+
+  # ========================================================================= #
+  # === attach                                          (attach tag, add tag)
+  #
+  # This method will simply append to @content.
+  # ========================================================================= #
+  def attach(i)
+    i = i.join(' ').strip if i.is_a? Array
+    if i.is_a? Symbol
+      # ===================================================================== #
+      # Symbols are treated as method calls.
+      # ===================================================================== #
+      i = send(i)
+    end
+    i = i.to_s
+    @content = @content.dup if @content.frozen?
+    @content << i
+  end; alias add                 attach # === attach
+       alias append_to_content   attach # === append_to_content
+       alias append_onto_content attach # === append_onto_content
+
+  # ========================================================================= #
+  # === append_the_content
+  # ========================================================================= #
+  def append_the_content(
+      content   = @content,
+      append_to = @result
+    )
+    if content.is_a? Array
+      content.each {|entry|
+        append_to << "#{entry}\n"
+      }
+    else
+      append_to << content
+    end
+  end
+
+  # ========================================================================= #
+  # === return_appendable_content
+  #
+  # This will return the @content as a String.
+  # ========================================================================= #
+  def return_appendable_content
+    result = ''.dup
+    if @content.is_a? Array
+      @content.each {|entry|
+        result << "#{entry}\n"
+      }
+    else
+      result << content
+    end
+    return result
+  end; alias appendable_content return_appendable_content # === appendable_content
+
+  # ========================================================================= #
+  # === consider_adding_the_script_entry_from_the_internal_hash
+  # ========================================================================= #
+  def consider_adding_the_script_entry_from_the_internal_hash
+    script = script?
+    if script and !script.empty?
+      @result << script
+    end
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Objectified::HtmlTags::Base.report               (report tag)
+  #
+  # This method can be used to quickly display the content of the OOP
+  # HTML tag at hand.
+  #
+  # Usage example:
+  #
+  #   Cyberweb::Objectified::HtmlTags::Title.report('This is a HTML website.')
+  #   Cyberweb::Objectified::HtmlTags::Abbr.report('tRNA','transfer RNA')
+  #
+  # ========================================================================= #
+  def self.report(
+      i, optional_arguments = nil
+    )
+    use_this_class = Cyberweb::Objectified::HtmlTags.const_get(inspect)
+    n_arguments = use_this_class.instance_method(:initialize).parameters.size
+    case n_arguments
+    when 1
+      print use_this_class.new(i).to_str
+    when 2
+      print use_this_class.new(i, optional_arguments).to_str
+    else
+      raise  StandardError.new('Unhandled number of parameters.')
+    end
+  end
+
+  # ========================================================================= #
+  # === pre_content?
+  # ========================================================================= #
+  def pre_content?
+    @internal_hash[:pre_content]
+  end
+
+  # ========================================================================= #
+  # === consider_adding_the_pre_content
+  # ========================================================================= #
+  def consider_adding_the_pre_content
+    @result << pre_content?
+  end
+
+  # ========================================================================= #
+  # === content?
+  # ========================================================================= #
+  def content?
+    if @content.is_a? Array # Arrays are allowed - everything else will be a String.
+      @content
+    else
+      @content.to_s # Ensure the result to be a String here.
+    end
+  end
+  
+  # ========================================================================= #
+  # === content_as_string
+  #
+  # This method makes sure that we return a String.
+  # ========================================================================= #
+  def content_as_string
+    _ = @content
+    _ = _.first if _.is_a? Array
+    return _.to_s # Ensure that it is a String here.
+  end
+
+  # ========================================================================= #
+  # === to_str
+  # ========================================================================= #
+  def to_str
+    rebuild_the_result
+    @result
+  end; alias to_s    to_str # === to_s
+       alias string? to_str # === string?
+       alias result? to_str # === result?
+
+  # ========================================================================= #
+  # === add_to_pre_content
+  #
+  # This method will, by default, always append a newline.
+  # ========================================================================= #
+  def add_to_pre_content(
+      i, append_a_newline = true
+    )
+    if append_a_newline
+      i << "\n"
+    end
+    @internal_hash[:pre_content] << i
+  end; alias add_to_the_pre_content add_to_pre_content # === add_to_the_pre_content
+
+  # ========================================================================= #
+  # === set_css_class
+  #
+  # Usage example:
+  #
+  #   textarea.class = 'rounded_border_6px bblack1 FS2em pad8px'
+  #
+  # ========================================================================= #
+  def set_css_class(i)
+    @internal_hash[:css_class] = i.to_s.dup
+  end; alias class=        set_css_class # === class=
+       alias css_class=    set_css_class # === css_class=
+       alias css_class     set_css_class # === css_class
+       alias set_CSS_class set_css_class # === set_CSS_class
+
+  # ========================================================================= #
+  # === css_manager
+  #
+  # Invocation example:
+  #
+  #  _.css_manager.css_rule_for_hover_pulse_grow(5)
+  #  _.css_manager('css_rule_for_hover_pulse_grow(8)')
+  #
+  # ========================================================================= #
+  def css_manager(
+      i                  = '',
+      optional_argument1 = nil
+    )
+    css_manager = Cyberweb::CssManager.new
+    arguments = nil
+    if i.include?('(')
+      splitted = i.delete(')').
+                   split('(')
+      i = splitted.first
+      arguments = splitted[1 .. -1]
+    end
+    if optional_argument1
+      arguments << optional_argument1
+    end
+    css_manager.send(i, *arguments)
+    return css_manager
+  end
+
+  # ========================================================================= #
+  # === append_css_manager
+  #
+  # This is a bit of a misnomer, as it will not be "append" - instead
+  # we will simply add onto the pre-content.
+  # ========================================================================= #
+  def append_css_manager(
+      i, use_this_name = nil
+    )
+    add_to_the_pre_content(
+      css_manager(i, use_this_name).result_as_CSS_style?
+    )
+  end
+
+  # ========================================================================= #
+  # === on_hover_pulse_increase
+  # ========================================================================= #
+  def on_hover_pulse_increase(
+      n_times = 8
+    )
+    append_css_manager(
+      'css_rule_for_hover_pulse_grow('+n_times.to_s+')'
+    )
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(&block)
+    _ = to_str
+    if _.is_a? Array
+      _ = _.join(' ').strip
+    end
+    print _
+  end; alias display report # === display
+       alias ee      report # === ee
+       alias report? report # === report?
+
+  # ========================================================================= #
+  # === append_this_to_the_css_style
+  # ========================================================================= #
+  def append_this_to_the_css_style(i)
+    i = " #{i.strip}"
+    @internal_hash[:css_style] << i
+    @internal_hash[:css_style].rstrip!
+  end; alias add_to_CSS_style append_this_to_the_css_style # === add_to_CSS_style
+
+  # ========================================================================= #
+  # === add_this_CSS_class
+  # ========================================================================= #
+  def center
+    add_this_CSS_class 'TAC'
+  end
+
+  # ========================================================================= #
+  # === modify_the_css_style_based_on_the_alignment
+  # ========================================================================= #
+  def modify_the_css_style_based_on_the_alignment(i = @options[:alignment])
+    case i
+    # ======================================================================= #
+    # === :center
+    # ======================================================================= #
+    when :center
+      append_this_to_the_css_style(' text-align: center;')
+    # ======================================================================= #
+    # === :right
+    # ======================================================================= #
+    when :right
+      append_this_to_the_css_style(' text-align: right;')
+    # ======================================================================= #
+    # === :left
+    # ======================================================================= #
+    when :left
+      append_this_to_the_css_style(' text-align: left;')
+    end
+  end
+
+  # ========================================================================= #
+  # === yellow_background
+  # ========================================================================= #
+  def yellow_background
+    add_to_CSS_classes('BG_Yellow')
+  end
+
+  # ========================================================================= #
+  # === width=
+  # ========================================================================= #
+  def width=(i = '500px')
+    add_to_CSS_style('width: '+i.to_s)
+  end
+
+  # ========================================================================= #
+  # === do_markify
+  #
+  # This currently isn't doing anything - perhaps at a later time it may
+  # become more relevant.
+  # ========================================================================= #
+  def do_markify
+  end
+
+  # ========================================================================= #
+  # === font=
+  # ========================================================================= #
+  def font=(i)
+    if i.is_a? Symbol
+      # ===================================================================== #
+      # For instance, :dejavu_condensed_22
+      # ===================================================================== #
+      i = i.to_s
+      if i.include? '_'
+        i = i.tr('_',' ') # dejavu condensed 22
+        if i =~ / \d{1,2}$/ # Ends with one or two numbers
+          font_size_to_use = i.scan(/ \d{1,2}$/).flatten.last.strip
+          if i.include? ' '
+            i = i.split(' ')[0 .. -2].join(' ').strip
+            i = i.dup if i.frozen?
+            i << '; font-size: '+font_size_to_use.to_s+' px;'
+          end
+        end
+      end
+    end
+    i = i.dup if i.frozen?
+    i << ';' unless i.end_with?(';')
+    @internal_hash[:css_style] << " font-family: #{i}"
+  end
+
+end; end; end; end