Module REXML::Node
In: rexml/node.rb

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

Methods

Public Instance methods

Visit all subnodes of self recursively

[Source]

# File rexml/node.rb, line 53
                def each_recursive(&block) # :yields: node
                        self.elements.each {|node|
                                block.call(node)
                                node.each_recursive(&block)
                        }
                end

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

[Source]

# File rexml/node.rb, line 62
                def find_first_recursive(&block) # :yields: node
      each_recursive {|node|
        return node if block.call(node)
      }
      return nil
    end

[Source]

# File rexml/node.rb, line 38
                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

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

[Source]

# File rexml/node.rb, line 71
    def index_in_parent
      parent.index(self)+1
    end

@return the next sibling (nil if unset)

[Source]

# File rexml/node.rb, line 10
                def next_sibling_node
                        return nil if @parent.nil?
                        @parent[ @parent.index(self) + 1 ]
                end

[Source]

# File rexml/node.rb, line 47
                def parent?
                        false;
                end

@return the previous sibling (nil if unset)

[Source]

# File rexml/node.rb, line 16
                def previous_sibling_node
                        return nil if @parent.nil?
                        ind = @parent.index(self)
                        return nil if ind == 0
                        @parent[ ind - 1 ]
                end
indent:DEPRECATED This parameter is now ignored. See the formatters in the REXML::Formatters package for changing the output style.

[Source]

# File rexml/node.rb, line 26
                def to_s indent=nil
      unless indent.nil?
        Kernel.warn( "#{self.class.name}.to_s(indent) parameter is deprecated" )
        f = REXML::Formatters::Pretty.new( indent )
        f.write( self, rv, indent )
      else
        f = REXML::Formatters::Default.new
        f.write( self, rv = "" )
      end
      return rv
                end

[Validate]

ruby-doc.org is hosted and maintained by James Britt and Happy Camper Studios, a Ruby application development company in Phoenix, Arizona. The site was created in 2002 as part of the Ruby Documentation Project to promote the Ruby language and to help other Ruby hackers.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.