123456789_123456789_123456789_123456789_123456789_

Class: RDoc::Markup::ListItem

Relationships & Source Files
Inherits: Object
Defined in: lib/rdoc/markup/list_item.rb

Overview

An item within a List that contains paragraphs, headings, etc.

For BULLET, NUMBER, LALPHA and UALPHA lists, the label will always be nil. For NOTE and LABEL lists, the list label may contain:

  • a single String for a single label

  • an Array of Strings for a list item with multiple terms

  • nil for an extra description attached to a previously labeled list item

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(label = nil, *parts) ⇒ ListItem

Creates a new ListItem with an optional #label containing #parts

[ GitHub ] 

  


# File 'lib/rdoc/markup/list_item.rb', line 27



def initialize label = nil, *parts
  @label = label
  @parts = []
  @parts.concat parts
end


  







Instance Attribute Details



  

    #empty?  ⇒ Boolean  (readonly)
  



  

    

Is the ListItem empty?


  





  


  [ GitHub ]


  

  


# File 'lib/rdoc/markup/list_item.rb', line 62



def empty?
  @parts.empty?
end


  








  

    #label   (rw)
  



  

    

The label for the ListItem


  



  [ GitHub ]


  

  


# File 'lib/rdoc/markup/list_item.rb', line 17



attr_accessor :label


  








  

    #parts   (readonly)
  



  

    

Parts of the ListItem


  



  [ GitHub ]


  

  


# File 'lib/rdoc/markup/list_item.rb', line 22



attr_reader :parts


  







Instance Method Details



  

    #<<(part)  
  



  

    

Appends part to the ListItem


  



  [ GitHub ]


  

  


# File 'lib/rdoc/markup/list_item.rb', line 36



def <<(part)
  @parts << part
end


  








  

    #==(other)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rdoc/markup/list_item.rb', line 40



def ==(other) # :nodoc:
  self.class == other.class and
    @label == other.label and
    @parts == other.parts
end


  








  

    #accept(visitor)  
  



  

    

Runs this list item and all its #parts through visitor


  



  [ GitHub ]


  

  


# File 'lib/rdoc/markup/list_item.rb', line 49



def accept(visitor)
  visitor.accept_list_item_start self

  @parts.each do |part|
    part.accept visitor
  end

  visitor.accept_list_item_end self
end


  








  

    #length  
  



  

    

Length of parts in the ListItem


  



  [ GitHub ]


  

  


# File 'lib/rdoc/markup/list_item.rb', line 69



def length
  @parts.length
end


  








  

    #pretty_print(q)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rdoc/markup/list_item.rb', line 73



def pretty_print(q) # :nodoc:
  q.group 2, '[item: ', ']' do
    case @label
    when Array then
      q.pp @label
      q.text ';'
      q.breakable
    when String then
      q.pp @label
      q.text ';'
      q.breakable
    end

    q.seplist @parts do |part|
      q.pp part
    end
  end
end


  








  

    #push(*parts)  
  



  

    

Adds #parts to the ListItem


  



  [ GitHub ]


  

  


# File 'lib/rdoc/markup/list_item.rb', line 95



def push *parts
  @parts.concat parts
end