Module: REXML::Node

Included in:
Attribute, Child
Defined in:
lib/rexml/node.rb

Overview

Represents a node in the tree. Nodes are never encountered except as superclasses of other objects. Nodes have siblings.

Instance Method Summary collapse

Instance Method Details

#each_recursive(&block) ⇒ Object

Visit all subnodes of self recursively



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/rexml/node.rb', line 54

def each_recursive(&block) # :yields: node
  stack = []
  each { |child| stack.unshift child if child.node_type == :element }
  until stack.empty?
    child = stack.pop
    yield child
    n = stack.size
    child.each { |grandchild| stack.insert n, grandchild if grandchild.node_type == :element }
  end
end

#find_first_recursive(&block) ⇒ Object

Find (and return) first subnode (recursively) for which the block evaluates to true. Returns nil if none was found.



67
68
69
70
71
72
 
# File 'lib/rexml/node.rb', line 67

def find_first_recursive(&block) # :yields: node
  each_recursive {|node|
    return node if block.call(node)
  }
  return nil
end

#indent(to, ind) ⇒ Object 



39
40
41
42
43
44
45
46
 
# File 'lib/rexml/node.rb', line 39

def indent to, ind
                    if @parent and @parent.context and not @parent.context[:indentstyle].nil? then
                            indentstyle = @parent.context[:indentstyle]
                    else
                            indentstyle = '  '
                    end
                    to << indentstyle*ind unless ind<1
end

#index_in_parent ⇒ Object

Returns the position that self holds in its parent’s array, indexed from 1.



76
77
78
 
# File 'lib/rexml/node.rb', line 76

def index_in_parent
  parent.index(self)+1
end

#next_sibling_node ⇒ Object

Returns the next sibling (nil if unset).

Returns:

  • the next sibling (nil if unset)



11
12
13
14
 
# File 'lib/rexml/node.rb', line 11

def next_sibling_node
  return nil if @parent.nil?
  @parent[ @parent.index(self) + 1 ]
end

#parent? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/rexml/node.rb', line 48

def parent?
  false;
end

#previous_sibling_node ⇒ Object

Returns the previous sibling (nil if unset).

Returns:

  • the previous sibling (nil if unset)



17
18
19
20
21
22
 
# File 'lib/rexml/node.rb', line 17

def previous_sibling_node
  return nil if @parent.nil?
  ind = @parent.index(self)
  return nil if ind == 0
  @parent[ ind - 1 ]
end

#to_s(indent = nil) ⇒ Object

indent

DEPRECATED This parameter is now ignored. See the formatters in the REXML::Formatters package for changing the output style.



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/rexml/node.rb', line 27

def to_s indent=nil
  unless indent.nil?
    Kernel.warn( "#{self.class.name}.to_s(indent) parameter is deprecated", uplevel: 1)
    f = REXML::Formatters::Pretty.new( indent )
    f.write( self, rv = "" )
  else
    f = REXML::Formatters::Default.new
    f.write( self, rv = "" )
  end
  return rv
end