Class: Cyberweb::Objectified::HtmlTags::Progress

Inherits:
Base
  • Object
show all
Defined in:
lib/cyberweb/objectified/html_tags/progress.rb

Overview

Cyberweb::Objectified::HtmlTags::Progress

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#+, #add_css_rules, #add_this_to_javascript, #add_to_pre_content, #append_css_manager, #append_onto_the_css_class, #append_onto_the_result, #append_the_content, #append_this_to_the_css_style, #attach, #batch_append_css_class_then_the_ID_and_then_the_css_style, #bblack1, #bblack2, #bblack3, #bblack4, #bblack5, #bblack6, #center, #consider_adding_the_pre_content, #consider_adding_the_script_entry_from_the_internal_hash, #content?, #content_as_string, #css_class?, #css_manager, #css_style?, #display, #do_not_load_lazily, #ee, #enable_lazy_loading, #evaluate_this_block, #font=, #id?, #is_an_objectified_html_tag?, #is_draggable?, #lazy_loading?, #make_bold, #modify_the_css_style_based_on_the_alignment, #name=, #name?, #on_click_select, #on_clicked, #on_hover_colour, #on_hover_pulse_increase, #on_mouse_hover, #pad, #pad10px, #pad1px, #pad2px, #pad3px, #pad4px, #pad5px, #pad6px, #pad7px, #pad8px, #pad9px, #path_to_internal_javascript_file, #pre_content?, #raw_result?, #report, report, #report?, #reset_the_content, #reset_the_result, #return_appendable_content, #return_css_class, #return_css_style, #return_javascript, #script?, #set_content, #set_css_class, #set_css_style, #set_id, #set_is_draggable, #set_title, #set_width, #title?, #to_str, #try_to_register_this_tag, #use_this_on_click_function=, #very_light_yellowish_background, #width_height, #yellow_background

Methods included from BaseModule

#attach_these_constants, #base_dir?, #beautiful_url, #cd, #create_the_internal_hash, #doctype?, #ee, #ensure_main_encoding, #esystem, #html_templates, #initialize_the_config_if_the_config_hash_is_empty, #internal_hash?, #log_dir?, #no_http, #random_alphabet_characters, #rarrow?, #rds, #remove_comments_from_this_string, #remove_numbers, #require_the_html_templates, #require_these, #return_file_size_in_kb_of, #return_html_comment, #ruby_sitelib_dir?, #sanitize_this_id, #server_base_directory?, #string_remote_image, #today?, #try_to_require_rack, #try_to_require_the_open_gem, #write_what_into

Methods included from BaseModule::ContentType

#content_type_is_html, #content_type_is_jpeg, #content_type_is_json, #content_type_is_plain_text

Methods included from BaseModule::CommandlineArguments

#append_to_the_commandline_arguments, #commandline_arguments?, #first_argument?, #parse_these_commandline_arguments, #second_argument?, #set_commandline_arguments

Methods included from BaseModule::Colours

#all_html_colours, #lightgreen, #rev, #sdir, #sfancy, #sfile, #simp, #steelblue, #tomato

Constructor Details

#initialize(use_this_text = '', optional_css_class = Progress.css_class?, optional_id = nil, optional_css_style = nil) ⇒ Progress

#

initialize

Usage example:

Cyberweb::Objectified::HtmlTags::Progress.new(i)
#


71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cyberweb/objectified/html_tags/progress.rb', line 71

def initialize(
    use_this_text      = '',
    optional_css_class = Progress.css_class?,
    optional_id        = nil,
    optional_css_style = nil
  )
  try_to_register_this_tag(self)
  reset
  use_this_text = use_this_text.join(' ').strip if use_this_text.is_a? Array
  set_content(use_this_text)
  set_CSS_class(optional_css_class) if optional_css_class
  set_id(optional_id)               if optional_id
  set_CSS_style(optional_css_style) if optional_css_style
end

Class Method Details

.clear ⇒ Object

#

Cyberweb::Objectified::HtmlTags::Progress.clear

#


45
46
47
 
# File 'lib/cyberweb/objectified/html_tags/progress.rb', line 45

def self.clear
  Progress.set_css_class('')
end

.css_class? ⇒ Boolean

#

Cyberweb::Objectified::HtmlTags::Progress.css_class?

#

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/cyberweb/objectified/html_tags/progress.rb', line 59

def self.css_class?
  @css_class
end

.reset_css_class ⇒ Object

#

Cyberweb::Objectified::HtmlTags::Progress.reset_css_class

#


38
39
40
 
# File 'lib/cyberweb/objectified/html_tags/progress.rb', line 38

def self.reset_css_class
  @css_class = nil
end

.set_css_class(i = DEFAULT_CSS_CLASS) ⇒ Object

#

Cyberweb::Objectified::HtmlTags::Progress.set_css_class

#


52
53
54
 
# File 'lib/cyberweb/objectified/html_tags/progress.rb', line 52

def self.set_css_class(i = DEFAULT_CSS_CLASS)
  @css_class = i
end

Instance Method Details

#max=(i) ⇒ Object Also known as: set_max

#

max=

#


104
105
106
 
# File 'lib/cyberweb/objectified/html_tags/progress.rb', line 104

def max=(i)
  @internal_hash[:max] = i.to_i
end

#parse_content ⇒ Object

#

parse_content

This method will only split on ‘/’ for now. Perhaps more functionality will be attached to it one day. The idea is to respond to input such as “22/100” aka 22%.

#


115
116
117
118
119
120
121
122
123
124
 
# File 'lib/cyberweb/objectified/html_tags/progress.rb', line 115

def parse_content
  _ = content?
  if _.is_a? String
    if _.include? '/'
      splitted = _.split('/').map(&:strip)
      set_value(splitted[0])
      set_max(splitted[1])
    end
  end
end

#rebuild_the_result ⇒ Object

#

rebuild_the_result

#


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/cyberweb/objectified/html_tags/progress.rb', line 137

def rebuild_the_result
  reset_the_result
  consider_adding_the_pre_content
  append_onto_the_result '<progress'
  if @internal_hash[:value]
    append_onto_the_result " value=\"#{@internal_hash[:value]}\""
  end
  if @internal_hash[:max]
    append_onto_the_result " max=\"#{@internal_hash[:max]}\""
  end
  batch_append_css_class_then_the_ID_and_then_the_css_style
  # ========================================================================= #
  # === :name
  # ========================================================================= #
  if name? and !name?.empty?
    append_onto_the_result ' name="'+name?.to_s+'"'
  end
  append_onto_the_result '>'
  append_onto_the_result "\n"
  append_onto_the_result content?.to_s
  append_onto_the_result "\n"
  append_onto_the_result '</progress>'+"\n"
  return raw_result?
end

#reset ⇒ Object

#

reset

#


89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/cyberweb/objectified/html_tags/progress.rb', line 89

def reset
  super()
  # ======================================================================= #
  # === :value
  # ======================================================================= #
  @internal_hash[:value] = nil
  # ======================================================================= #
  # === :max
  # ======================================================================= #
  @internal_hash[:max] = nil
end

#value=(i) ⇒ Object Also known as: set_value

#

value=

#


129
130
131
132
 
# File 'lib/cyberweb/objectified/html_tags/progress.rb', line 129

def value=(i)
  @internal_hash[:value] = i.to_i
  set_content(@internal_hash[:value].to_s+'%')
end