Class: RTF::ContainerNode

Inherits:

Node

• Object
• Node
• RTF::ContainerNode

show all

Includes:

Enumerable

Defined in:

lib/rtf/node.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) children

  Children elements of the node.

Attributes inherited from Node

#parent

Instance Method Summary (collapse)

• - (Object) [](index)

  This method overloads the array dereference operator to allow for access to the child elements of a ContainerNode object.

• - (Object) each

  This method provides for iteration over the contents of a ContainerNode object.

• - (Object) first

  This method fetches the first node child for a ContainerNode object.

• - (ContainerNode) initialize(parent) constructor

  This is the constructor for the ContainerNode class.

• - (Object) last

  This method fetches the last node child for a ContainerNode object.

• - (Object) size

  This method returns a count of the number of children a ContainerNode object contains.

• - (Object) store(node)

  This method adds a new node element to the end of the list of nodes maintained by a ContainerNode object.

• - (Object) to_rtf

  This method generates the RTF text for a ContainerNode object.

Methods inherited from Node

#is_root?, #next_node, #previous_node, #root

154
155
156
157
158

# File 'lib/rtf/node.rb', line 154

def initialize(parent)
   super(parent)
   @children = []
   @children.concat(yield) if block_given?
end

147
148
149

# File 'lib/rtf/node.rb', line 147

def children
  @children
end

205
206
207

# File 'lib/rtf/node.rb', line 205

def [](index)
   @children[index]
end

187
188
189

# File 'lib/rtf/node.rb', line 187

def each
   @children.each {|child| yield child}
end

175
176
177

# File 'lib/rtf/node.rb', line 175

def first
   @children[0]
end

181
182
183

# File 'lib/rtf/node.rb', line 181

def last
   @children.last
end

193
194
195

# File 'lib/rtf/node.rb', line 193

def size
   @children.size
end

165
166
167
168
169
170
171

# File 'lib/rtf/node.rb', line 165

def store(node)
   if node != nil
      @children.push(node) if @children.include?(Node) == false
      node.parent = self if node.parent != self
   end
   node
end

210
211
212

# File 'lib/rtf/node.rb', line 210

def to_rtf
   RTFError.fire("#{self.class.name}.to_rtf method not yet implemented.")
end