Sha256: 0aee9acf5a4a0ba9ea17c4754639d52aeb93d1aea19d28cb54819a3cfe0e225f

Contents?: true

Size: 1.08 KB

Versions: 10

Compression:

Stored size: 1.08 KB

Contents

module Axlsx

  #A collection of hyperlink objects for a worksheet
  class WorksheetHyperlinks < SimpleTypedList

    # Creates a new Hyperlinks collection
    # @param [Worksheet] worksheet the worksheet that owns these hyperlinks
    def initialize(worksheet)
      DataTypeValidator.validate "Hyperlinks.worksheet", [Worksheet], worksheet
      @worksheet = worksheet
      super WorksheetHyperlink
    end

    # Creates and adds a new hyperlink based on the options provided
    # @see WorksheetHyperlink#initialize
    # @return [WorksheetHyperlink]
    def add(options)
      @list << WorksheetHyperlink.new(@worksheet, options)
      @list.last
    end

    # The relationships required by this collection's hyperlinks
    # @return Array
    def relationships
      return [] if empty?
      map { |hyperlink| hyperlink.relationship }
    end

    # seralize the collection of hyperlinks
    # @return [String]
    def to_xml_string(str='')
      return if empty?
      str << '<hyperlinks>'
      @list.each { |hyperlink| hyperlink.to_xml_string(str) }
      str << '</hyperlinks>'
    end
  end
end

Version data entries

10 entries across 10 versions & 2 rubygems

Version Path
caxlsx-2.0.2 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
axlsx-2.0.1 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
axlsx-2.0.0 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
axlsx-1.3.6 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
axlsx-1.3.5 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
axlsx-1.3.4 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
axlsx-1.3.3 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
axlsx-1.3.2 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
axlsx-1.3.1 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
axlsx-1.2.3 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb