Class: Cyberweb::Objectified::HtmlTags::Form

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

Overview

Cyberweb::Objectified::HtmlTags::Form

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 = Form.css_class?, optional_id = nil, optional_css_style = nil) ⇒ Form

#

initialize

Usage example:

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


58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 58

def initialize(
    use_this_text      = '',
    optional_css_class = Form.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

.clearObject

#

Cyberweb::Objectified::HtmlTags::Form.clear

#


32
33
34
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 32

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

.css_class?Boolean

#

Cyberweb::Objectified::HtmlTags::Form.css_class?

#

Returns:

  • (Boolean)


46
47
48
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 46

def self.css_class?
  @css_class
end

.modeObject

#

Cyberweb::Form.mode

#


151
152
153
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 151

def Form.mode
  @mode
end

.reset_css_classObject

#

Cyberweb::Objectified::HtmlTags::Form.reset_css_class

#


25
26
27
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 25

def self.reset_css_class
  @css_class = nil
end

.set_css_class(i = DEFAULT_CSS_CLASS) ⇒ Object

#

Cyberweb::Objectified::HtmlTags::Form.set_css_class

#


39
40
41
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 39

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

.toggleObject

#

Cyberweb::Form.toggle

#


158
159
160
161
162
163
164
165
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 158

def Form.toggle
  case @mode # case tag
  when 'get'
    @mode = 'post'
  when 'post'
    @mode = 'get'
  end
end

Instance Method Details

#checkbox(mark_as_checked = false) ⇒ Object Also known as: check_box

#

checkbox

#


109
110
111
112
113
114
115
116
117
118
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 109

def checkbox(
    mark_as_checked = false
  )
  _ = "\n<input type=\"checkbox\"".dup
  if mark_as_checked
    _ << ' checked'
  end
  _ << ">"
  append_onto_content _
end

#checked_check_boxObject

#

checked_check_box

#


102
103
104
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 102

def checked_check_box
  checkbox(true)
end

#label(content = '', attached_to = '') ⇒ Object

#

label

label(‘html’,‘HTML’)

#


85
86
87
88
89
90
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 85

def label(
    content     = '',
    attached_to = ''
  )
  append_onto_content '<label for="'+attached_to.to_s+'">'+content.to_s+'</label>'
end

#rebuild_the_resultObject

#

rebuild_the_result

#


123
124
125
126
127
128
129
130
131
132
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 123

def rebuild_the_result
  reset_the_result
  consider_adding_the_pre_content
  append_onto_the_result '<form'
  batch_append_css_class_then_the_ID_and_then_the_css_style
  append_onto_the_result ">\n"
  append_onto_the_result "#{content?}"
  append_onto_the_result "\n</form>\n"
  return raw_result?
end

#resetObject

#

reset

#


76
77
78
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 76

def reset
  super()
end

#text_fieldObject Also known as: textfield

#

text_field

#


95
96
97
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 95

def text_field
  append_onto_content oop_textarea.to_s
end

#toggle_formObject Also known as: toggle_web_form

#

toggle_form

#


137
138
139
# File 'lib/cyberweb/objectified/html_tags/form.rb', line 137

def toggle_form
  Form.toggle
end