Class: Gloo::Objs::Text

Inherits:
Core::Obj show all
Includes:
StringMsgs
Defined in:
lib/gloo/objs/basic/text.rb

Constant Summary collapse

KEYWORD = 
'text'.freeze
KEYWORD_SHORT = 
'txt'.freeze

Constants inherited from Core::Baseo

Core::Baseo::NOT_IMPLEMENTED_ERR

Instance Attribute Summary

Attributes inherited from Core::Obj

#children, #parent, #value

Attributes inherited from Core::Baseo

#name

Class Method Summary collapse

Instance Method Summary collapse

Methods included from StringMsgs

message_docs, #msg_count_chars, #msg_count_lines, #msg_count_words, #msg_decode64, #msg_down, #msg_encode64, #msg_ends_with?, #msg_escape, #msg_format_for_html, #msg_gen_alphanumeric, #msg_gen_base64, #msg_gen_hex, #msg_gen_uuid, #msg_gsub, #msg_page, #msg_size, #msg_split, #msg_split_list, #msg_splitl, #msg_splitr, #msg_starts_with?, #msg_sub, #msg_substring?, #msg_trim, #msg_unescape, #msg_up

Methods inherited from Core::Obj

#add_child, #add_children_on_create?, #add_default_children, can_create?, #can_receive_message?, #child_count, #child_index, #contains_child?, #delete_children, #dispatch, #display_value, #find_add_child, #find_child, #find_child_resolve_alias, #find_child_value, help, inherited, #initialize, #is_alias?, #is_container?, #is_function?, #msg_blank?, #msg_contains?, #msg_reload, #msg_responds_to?, #msg_unload, #pn, #remove_child, #render, #root?, #send_message, #set_parent, #sql_value, #type_display, #value_display, #value_is_array?, #value_is_blank?, #value_string?

Methods inherited from Core::Baseo

#initialize, #type_display

Constructor Details

This class inherits a constructor from Gloo::Core::Obj

Class Method Details

.doc_data ⇒ Object

Get the object's documentation data.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/gloo/objs/basic/text.rb', line 71

def self.doc_data
  {
    :name => KEYWORD,
    :shortcut => KEYWORD_SHORT,
    :description => 'A longer, multi-line text string. Use BEGIN ' \
      'and END to mark the text range. Shares the same messages ' \
      'as the string object type; the two differ mainly by ' \
      'convention — text for longer, multi-line blocks, string ' \
      'for a single word or line.',
    :messages => StringMsgs.message_docs,
    :examples => <<~EXAMPLES.strip
      t [container] :
        msg [txt] : BEGIN
          I will now write a poem
          of two lines or less
          END
        on_load [script] :
          show t.msg
    EXAMPLES
  }
end

.messages ⇒ Object

Get a list of message names that this object receives.



60
61
62
 
# File 'lib/gloo/objs/basic/text.rb', line 60

def self.messages
  return super + StringMsgs.messages
end

.short_typename ⇒ Object

The short name of the object type.



27
28
29
 
# File 'lib/gloo/objs/basic/text.rb', line 27

def self.short_typename
  return KEYWORD_SHORT
end

.typename ⇒ Object

The name of the object type.



20
21
22
 
# File 'lib/gloo/objs/basic/text.rb', line 20

def self.typename
  return KEYWORD
end

Instance Method Details

#line_count ⇒ Object

Get the number of lines of text.



49
50
51
 
# File 'lib/gloo/objs/basic/text.rb', line 49

def line_count
  return value.split( "\n" ).count
end

#multiline_value? ⇒ Boolean

Does this object support multi-line values? Initially only true for scripts.

Returns:



42
43
44
 
# File 'lib/gloo/objs/basic/text.rb', line 42

def multiline_value?
  return false
end

#set_value(new_value) ⇒ Object

Set the value with any necessary type conversions.



34
35
36
 
# File 'lib/gloo/objs/basic/text.rb', line 34

def set_value( new_value )
  self.value = new_value.to_s
end