summaryrefslogtreecommitdiffhomepage
path: root/lib/axlsx/stylesheet/border.rb
blob: 60b89b6fc2b48c552fc101046dba88ec63ceee9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# encoding: UTF-8
module Axlsx
  # This class details a border used in Office Open XML spreadsheet styles.
  class Border

    # @return [Boolean] The diagonal up property for the border that indicates if the border should include a diagonal line from the bottom left to the top right of the cell.
    attr_reader :diagonalUp

    # @return [Boolean] The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the cell.
    attr_reader :diagonalDown

    # @return [Boolean] The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of cells.
    attr_reader :outline

    # @return [SimpleTypedList] A list of BorderPr objects for this border.
    attr_reader :prs

    # Creates a new Border object
    # @option options [Boolean] diagonalUp
    # @option options [Boolean] diagonalDown
    # @option options [Boolean] outline
    # @example - Making a border
    #   p = Axlsx::Package.new
    #   red_border = p.workbook.styles.add_style :border => { :style => :thin, :color => "FFFF0000" }
    #   ws = p.workbook.add_worksheet
    #   ws.add_row [1,2,3], :style => red_border
    #   p.serialize('red_border.xlsx')
    #
    # @note The recommended way to manage borders is with Style#add_style
    # @see Style#add_style
    def initialize(options={})
      @prs = SimpleTypedList.new BorderPr
      options.each do |o|
        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
      end
    end

    # Return list of edge names applied to this border
    def edges
      edges = []
      @prs.each {|pr| edges << pr.name}
      edges
    end

    # @see diagonalUp
    def diagonalUp=(v) Axlsx::validate_boolean v; @diagonalUp = v end
    # @see diagonalDown
    def diagonalDown=(v) Axlsx::validate_boolean v; @diagonalDown = v end
    # @see outline
    def outline=(v) Axlsx::validate_boolean v; @outline = v end

    # Serializes the object
    # @param [String] str
    # @return [String]
    def to_xml_string(str = '')
      str << '<border '
      h = self.instance_values.select{ |k,v| [:diagonalUp, :diagonalDown, :outline].include? k }
      str << h.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
      str << '>'
      [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal].each do |k|
        @prs.select { |pr| pr.name == k }.each do |part|
          part.to_xml_string(str)
        end
      end
      str << '</border>'
    end

  end
end