Class: Gloo::Objs::MenuItem

Inherits:
Core::Obj show all
Defined in:
lib/gloo/objs/cli/menu_item.rb

Constant Summary collapse

KEYWORD = 
'menu_item'.freeze
KEYWORD_SHORT = 
'mitem'.freeze
SHORTCUT = 
'shortcut'.freeze
DESCRIPTION = 
'description'.freeze
DO = 
'do'.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 inherited from Core::Obj

#add_child, 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_unload, #multiline_value?, #pn, #remove_child, #render, #root?, #send_message, #set_parent, #set_value, #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

.messages ⇒ Object

Get a list of message names that this object receives.



89
90
91
 
# File 'lib/gloo/objs/cli/menu_item.rb', line 89

def self.messages
  return super
end

.short_typename ⇒ Object

The short name of the object type.



27
28
29
 
# File 'lib/gloo/objs/cli/menu_item.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/cli/menu_item.rb', line 20

def self.typename
  return KEYWORD
end

Instance Method Details

#add_children_on_create? ⇒ Boolean

Does this object have children to add when an object is created in interactive mode? This does not apply during obj load, etc.

Returns:



68
69
70
 
# File 'lib/gloo/objs/cli/menu_item.rb', line 68

def add_children_on_create?
  return true
end

#add_default_children ⇒ Object

Add children to this object. This is used by containers to add children needed for default configurations.



75
76
77
78
79
80
 
# File 'lib/gloo/objs/cli/menu_item.rb', line 75

def add_default_children
  fac = @engine.factory
  fac.create_string SHORTCUT, '', self
  fac.create_string DESCRIPTION, '', self
  fac.create_script DO, '', self
end

#description_value ⇒ Object

Get the action’s description. Returns nil if there is none.



46
47
48
49
50
51
 
# File 'lib/gloo/objs/cli/menu_item.rb', line 46

def description_value
  o = find_child DESCRIPTION
  return self.value unless o

  return o.value
end

#do_script ⇒ Object

Get the action’s script. Returns nil if there is none.



57
58
59
 
# File 'lib/gloo/objs/cli/menu_item.rb', line 57

def do_script
  return find_child DO
end

#shortcut_value ⇒ Object

Get the value of the menu item shortcut. Returns nil if there is none.



35
36
37
38
39
40
 
# File 'lib/gloo/objs/cli/menu_item.rb', line 35

def shortcut_value
  o = find_child SHORTCUT
  return self.name unless o

  return o.value
end