Class: Axlsx::Comments

Inherits:
SimpleTypedList
  • Object
show all
Defined in:
lib/axlsx/workbook/worksheet/comments.rb

Overview

Comments is a collection of Comment objects for a worksheet

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(worksheet) ⇒ Comments

Creates a new Comments object

Parameters:

  • worksheet (Worksheet) —

    The sheet that these comments belong to.

Raises:

  • (ArgumentError) 


26
27
28
29
30
31
32
 
# File 'lib/axlsx/workbook/worksheet/comments.rb', line 26

def initialize(worksheet)
  raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)

  super(Comment)
  @worksheet = worksheet
  @vml_drawing = VmlDrawing.new(self)
end

Instance Attribute Details

#vml_drawing ⇒ VmlDrawing (readonly)

the vml_drawing that holds the shapes for comments

Returns:



6
7
8
 
# File 'lib/axlsx/workbook/worksheet/comments.rb', line 6

def vml_drawing
  @vml_drawing
end

#worksheet ⇒ Worksheet (readonly)

The worksheet that these comments belong to

Returns:



10
11
12
 
# File 'lib/axlsx/workbook/worksheet/comments.rb', line 10

def worksheet
  @worksheet
end

Instance Method Details

#add_comment(options = {}) {|last| ... } ⇒ Object

Note:

the author, text and ref options are required

Adds a new comment to the worksheet that owns these comments.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • author (String) —

    The name of the author for this comment

  • text (String) —

    The text for this comment

  • ref (Stirng|Cell) —

    The cell that this comment is attached to.

Yields:

  • (last)

Raises:

  • (ArgumentError) 


39
40
41
42
43
44
45
46
47
 
# File 'lib/axlsx/workbook/worksheet/comments.rb', line 39

def add_comment(options = {})
  raise ArgumentError, "Comment require an author" unless options[:author]
  raise ArgumentError, "Comment requires text" unless options[:text]
  raise ArgumentError, "Comment requires ref" unless options[:ref]

  self << Comment.new(self, options)
  yield last if block_given?
  last
end

#authors ⇒ Array

A sorted list of the unique authors in the contained comments

Returns:

  • (Array) 


51
52
53
 
# File 'lib/axlsx/workbook/worksheet/comments.rb', line 51

def authors
  map { |comment| comment.author.to_s }.uniq.sort
end

#index ⇒ Integer

The index of this collection in the workbook. Effectively the index of the worksheet.

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/axlsx/workbook/worksheet/comments.rb', line 14

def index
  @worksheet.index
end

#pn ⇒ String

The part name for this object

Returns:

  • (String) 


20
21
22
 
# File 'lib/axlsx/workbook/worksheet/comments.rb', line 20

def pn
  "#{COMMENT_PN % (index + 1)}"
end

#relationships ⇒ Array

The relationships required by this object

Returns:

  • (Array) 


57
58
59
60
 
# File 'lib/axlsx/workbook/worksheet/comments.rb', line 57

def relationships
  [Relationship.new(self, VML_DRAWING_R, "../#{vml_drawing.pn}"),
   Relationship.new(self, COMMENT_R, "../#{pn}")]
end

#to_xml_string(str = "") ⇒ String

serialize the object

Parameters:

  • str (String) (defaults to: "")

Returns:

  • (String) 


65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/axlsx/workbook/worksheet/comments.rb', line 65

def to_xml_string(str = "")
  str << '<?xml version="1.0" encoding="UTF-8"?>'
  str << ('<comments xmlns="' << XML_NS << '"><authors>')
  authors.each do |author|
    str << ('<author>' << author.to_s << '</author>')
  end
  str << '</authors><commentList>'
  each do |comment|
    comment.to_xml_string str
  end
  str << '</commentList></comments>'
end