axlsx 1.2.0 → 2.0.0

data/lib/axlsx/workbook/worksheet/conditional_formatting.rb

@@ -6,6 +6,16 @@ module Axlsx
   # @see ConditionalFormattingRule
   class ConditionalFormatting
 
+   include Axlsx::OptionsParser
+   
+    # Creates a new {ConditionalFormatting} object
+    # @option options [Array] rules The rules to apply
+    # @option options [String] sqref The range to apply the rules to
+    def initialize(options={})
+      @rules = []
+      parse_options options
+    end
+
     # Range over which the formatting is applied, in "A1:B2" format
     # @return [String]
     attr_reader :sqref
@@ -18,17 +28,7 @@ module Axlsx
     # @return [Array]
     attr_reader :rules
 
-    # Creates a new {ConditionalFormatting} object
-    # @option options [Array] rules The rules to apply
-    # @option options [String] sqref The range to apply the rules to
-    def initialize(options={})
-      @rules = []
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
-    # Add Conditional Formatting Rules to this object. Rules can either
+     # Add Conditional Formatting Rules to this object. Rules can either
     # be already created {ConditionalFormattingRule} elements or
     # hashes of options for automatic creation.  If rules is a hash
     # instead of an array, assume only one rule being added.

data/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb

@@ -8,10 +8,36 @@ module Axlsx
   # @see ConditionalFormattingRule#initialize
   class ConditionalFormattingRule
 
-    # instance values that must be serialized as their own elements - e.g. not attributes.
-    CHILD_ELEMENTS = [:formula, :color_scale, :data_bar, :icon_set]
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new Conditional Formatting Rule object
+    # @option options [Symbol] type The type of this formatting rule
+    # @option options [Boolean] aboveAverage This is an aboveAverage rule
+    # @option options [Boolean] bottom This is a bottom N rule.
+    # @option options [Integer] dxfId The formatting id to apply to matches
+    # @option options [Boolean] equalAverage Is the aboveAverage or belowAverage rule inclusive
+    # @option options [Integer] priority The priority of the rule, 1 is highest
+    # @option options [Symbol] operator Which operator to apply
+    # @option options [String] text The value to apply a text operator against
+    # @option options [Boolean] percent If a top/bottom N rule, evaluate as N% rather than N
+    # @option options [Integer] rank If a top/bottom N rule, the value of N
+    # @option options [Integer] stdDev The number of standard deviations above or below the average to match
+    # @option options [Boolean] stopIfTrue Stop evaluating rules after this rule matches
+    # @option options [Symbol]  timePeriod The time period in a date occuring... rule
+    # @option options [String] formula The formula to match against in i.e. an equal rule. Use a [minimum, maximum] array for cellIs between/notBetween conditionals.
+    def initialize(options={})
+      @color_scale = @data_bar = @icon_set = @formula = nil
+      parse_options options
+    end
+
+    serializable_attributes :type, :aboveAverage, :bottom, :dxfId, :equalAverage,
+                            :priority, :operator, :text, :percent, :rank, :stdDev,
+                            :stopIfTrue, :timePeriod
 
     # Formula
+    # The formula or value to match against (e.g. 5 with an operator of :greaterThan to specify cell_value > 5).
+    # If the operator is :between or :notBetween, use an array to specify [minimum, maximum]
     # @return [String]
     attr_reader :formula
 
@@ -129,28 +155,6 @@ module Axlsx
       @icon_set ||= IconSet.new
     end
 
-    # Creates a new Conditional Formatting Rule object
-    # @option options [Symbol] type The type of this formatting rule
-    # @option options [Boolean] aboveAverage This is an aboveAverage rule
-    # @option options [Boolean] bottom This is a bottom N rule.
-    # @option options [Integer] dxfId The formatting id to apply to matches
-    # @option options [Boolean] equalAverage Is the aboveAverage or belowAverage rule inclusive
-    # @option options [Integer] priority The priority of the rule, 1 is highest
-    # @option options [Symbol] operator Which operator to apply
-    # @option options [String] text The value to apply a text operator against
-    # @option options [Boolean] percent If a top/bottom N rule, evaluate as N% rather than N
-    # @option options [Integer] rank If a top/bottom N rule, the value of N
-    # @option options [Integer] stdDev The number of standard deviations above or below the average to match
-    # @option options [Boolean] stopIfTrue Stop evaluating rules after this rule matches
-    # @option options [Symbol]  timePeriod The time period in a date occuring... rule
-    # @option options [String] formula The formula to match against in i.e. an equal rule
-    def initialize(options={})
-      @color_scale = @data_bar = @icon_set = @formula = nil
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
     # @see type
     def type=(v); Axlsx::validate_conditional_formatting_type(v); @type = v end
     # @see aboveAverage
@@ -178,7 +182,7 @@ module Axlsx
     # @see timePeriod
     def timePeriod=(v); Axlsx::validate_time_period_type(v); @timePeriod = v end
     # @see formula
-    def formula=(v); Axlsx::validate_string(v); @formula = v end
+    def formula=(v); [*v].each {|x| Axlsx::validate_string(x) }; @formula = [*v].map { |form| ::CGI.escapeHTML(form) } end
 
     # @see color_scale
     def color_scale=(v)
@@ -204,9 +208,9 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<cfRule '
-      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' unless CHILD_ELEMENTS.include?(key.to_sym) }.join(' ')
+      serialized_attributes str
       str << '>'
-      str << '<formula>' << self.formula << '</formula>' if @formula
+      str << '<formula>' << [*self.formula].join('</formula><formula>') << '</formula>' if @formula
       @color_scale.to_xml_string(str) if @color_scale && @type == :colorScale
       @data_bar.to_xml_string(str) if @data_bar && @type == :dataBar
       @icon_set.to_xml_string(str) if @icon_set && @type == :iconSet

data/lib/axlsx/workbook/worksheet/data_bar.rb

@@ -7,6 +7,35 @@ module Axlsx
   # @see ConditionalFormattingRule#initialize
   class DataBar
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    class << self
+      # This differs from ColorScale. There must be exactly two cfvos one color
+      def default_cfvos
+        [{:type => :min, :val => "0"},
+         {:type => :max, :val => "0"}]
+      end
+    end
+
+    # Creates a new data bar conditional formatting object
+    # @param [Hash] options
+    # @option options [Integer] minLength
+    # @option options [Integer] maxLength
+    # @option options [Boolean] showValue
+    # @option options [String] color - the rbg value used to color the bars
+    # @param [Array] cfvos hashes defining the gradient interpolation points for this formatting.
+    def initialize(options = {}, *cfvos)
+      @min_length = 10
+      @max_length = 90
+      @show_value = true
+      parse_options options
+      initialize_cfvos(cfvos)
+      yield self if block_given?
+    end
+
+    serializable_attributes :min_length, :max_length, :show_value
+
     # instance values that must be serialized as their own elements - e.g. not attributes.
     CHILD_ELEMENTS = [:value_objects, :color]
 
@@ -14,24 +43,29 @@ module Axlsx
     # The minimum length of the data bar, as a percentage of the cell width.
     # The default value is 10
     # @return [Integer]
-    attr_reader :minLength
+    attr_reader :min_length
+    alias :minLength :min_length
 
     # maxLength attribute
     # The maximum length of the data bar, as a percentage of the cell width.
     # The default value is 90
     # @return [Integer]
-    attr_reader :maxLength
+    attr_reader :max_length
+    alias :maxLength :max_length
 
     # maxLength attribute
     # Indicates whether to show the values of the cells on which this data bar is applied.
     # The default value is true
     # @return [Boolean]
-    attr_reader :showValue
+    attr_reader :show_value
+    alias :showValue :show_value
 
     # A simple typed list of cfvos
     # @return [SimpleTypedList]
     # @see Cfvo
-    attr_reader :value_objects
+    def value_objects
+      @value_objects ||= Cfvos.new
+    end
 
     # color
     # the color object used in the data bar formatting
@@ -40,58 +74,58 @@ module Axlsx
       @color ||= Color.new :rgb => "FF0000FF"
     end
 
-    # Creates a new data bar conditional formatting object
-    # @option options [Integer] minLength
-    # @option options [Integer] maxLength
-    # @option options [Boolean] showValue
-    # @option options [String] color - the rbg value used to color the bars
-    def initialize(options = {})
-      @minLength = 10
-      @maxLength = 90
-      @showValue = true
-      initialize_value_objects
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      yield self if block_given?
-    end
-
     # @see minLength
-    def minLength=(v); Axlsx.validate_unsigned_int(v); @minLength = v end
-    # @see maxLength
-    def maxLength=(v); Axlsx.validate_unsigned_int(v); @maxLength = v end
-
-    # @see showValue
-    def showValue=(v); Axlsx.validate_boolean(v); @showValue = v end
-
-    # Sets the color for the data bars.
-    # @param [Color|String] v The color object, or rgb string value to apply
-    def color=(v)
-      @color = v if v.is_a? Color
-      self.color.rgb = v if v.is_a? String
-      @color
+    def min_length=(v)
+      Axlsx.validate_unsigned_int(v)
+      @min_length = v
     end
+    alias :minLength= :min_length=
+
+      # @see maxLength
+      def max_length=(v)
+        Axlsx.validate_unsigned_int(v)
+        @max_length = v
+      end
+    alias :maxLength= :max_length=
+
+      # @see showValue
+      def show_value=(v)
+        Axlsx.validate_boolean(v)
+        @show_value = v
+      end
+    alias :showValue= :show_value=
+
+      # Sets the color for the data bars.
+      # @param [Color|String] v The color object, or rgb string value to apply
+      def color=(v)
+        @color = v if v.is_a? Color
+        self.color.rgb = v if v.is_a? String
+        @color
+      end
 
     # Serialize this object to an xml string
     # @param [String] str
     # @return [String]
     def to_xml_string(str="")
       str << '<dataBar '
-      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' unless CHILD_ELEMENTS.include?(key.to_sym) }.join(' ')
+      serialized_attributes str
       str << '>'
-      @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
+      value_objects.to_xml_string(str)
       self.color.to_xml_string(str)
       str << '</dataBar>'
     end
 
     private
 
-    # Initalize the simple typed list of value objects
-    # I am keeping this private for now as I am not sure what impact changes to the required two cfvo objects will do.
-    def initialize_value_objects
-      @value_objects = SimpleTypedList.new Cfvo
-      @value_objects.concat [Cfvo.new(:type => :min, :val => 0), Cfvo.new(:type => :max, :val => 0)]
-      @value_objects.lock
+    def initialize_cfvos(cfvos)
+      self.class.default_cfvos.each_with_index.map do |default, index|
+        if index < cfvos.size
+          value_objects << Cfvo.new(default.merge(cfvos[index]))
+        else
+          value_objects << Cfvo.new(default)
+        end
+      end
     end
+
   end
 end

data/lib/axlsx/workbook/worksheet/data_validation.rb

@@ -5,24 +5,50 @@ module Axlsx
   # @note The recommended way to manage data validations is via Worksheet#add_data_validation
   # @see Worksheet#add_data_validation
   class DataValidation
-    
+    include Axlsx::OptionsParser
+
+    # Creates a new {DataValidation} object
+    # @option options [String] formula1
+    # @option options [String] formula2
+    # @option options [Boolean] allowBlank - A boolean value indicating whether the data validation allows the use of empty or blank entries.
+    # @option options [String] error - Message text of error alert.
+    # @option options [Symbol] errorStyle - The style of error alert used for this data validation.
+    # @option options [String] errorTitle - itle bar text of error alert.
+    # @option options [Symbol] operator - The relational operator used with this data validation.
+    # @option options [String] prompt - Message text of input prompt.
+    # @option options [String] promptTitle - Title bar text of input prompt.
+    # @option options [Boolean] showDropDown - A boolean value indicating whether to display a dropdown combo box for a list type data validation
+    # @option options [Boolean] showErrorMessage - A boolean value indicating whether to display the error alert message when an invalid value has been entered, according to the criteria specified.
+    # @option options [Boolean] showInputMessage - A boolean value indicating whether to display the input prompt message.
+    # @option options [String] sqref - Range over which data validation is applied, in "A1:B2" format.
+    # @option options [Symbol] type - The type of data validation.
+    def initialize(options={})
+      # defaults
+      @formula1 = @formula2 = @error = @errorTitle = @operator = @prompt = @promptTitle = @sqref = nil
+      @allowBlank = @showErrorMessage = true
+      @showDropDown = @showInputMessage = false
+      @type = :none
+      @errorStyle = :stop
+      parse_options options
+    end
+
     # instance values that must be serialized as their own elements - e.g. not attributes.
     CHILD_ELEMENTS = [:formula1, :formula2]
-    
+
     # Formula1
     # Available for type whole, decimal, date, time, textLength, list, custom
     # @see type
     # @return [String]
     # default nil
     attr_reader :formula1
-    
+
     # Formula2
     # Available for type whole, decimal, date, time, textLength
     # @see type
     # @return [String]
     # default nil
     attr_reader :formula2
-    
+
     # Allow Blank
     # A boolean value indicating whether the data validation allows the use of empty or blank
     # entries. 1 means empty entries are OK and do not violate the validation constraints.
@@ -31,7 +57,7 @@ module Axlsx
     # @return [Boolean]
     # default true
     attr_reader :allowBlank
-    
+
     # Error Message
     # Message text of error alert.
     # Available for type whole, decimal, date, time, textLength, list, custom
@@ -39,7 +65,7 @@ module Axlsx
     # @return [String]
     # default nil
     attr_reader :error
-    
+
     # Error Style (ST_DataValidationErrorStyle)
     # The style of error alert used for this data validation.
     # Options are:
@@ -51,7 +77,7 @@ module Axlsx
     # @return [Symbol]
     # default :stop
     attr_reader :errorStyle
-    
+
     # Error Title
     # Title bar text of error alert.
     # Available for type whole, decimal, date, time, textLength, list, custom
@@ -59,7 +85,7 @@ module Axlsx
     # @return [String]
     # default nil
     attr_reader :errorTitle
-    
+
     # Operator (ST_DataValidationOperator)
     # The relational operator used with this data validation.
     # Options are:
@@ -76,7 +102,7 @@ module Axlsx
     # @return [Symbol]
     # default nil
     attr_reader :operator
-    
+
     # Input prompt
     # Message text of input prompt.
     # Available for type whole, decimal, date, time, textLength, list, custom
@@ -84,7 +110,7 @@ module Axlsx
     # @return [String]
     # default nil
     attr_reader :prompt
-    
+
     # Prompt title
     # Title bar text of input prompt.
     # Available for type whole, decimal, date, time, textLength, list, custom
@@ -92,7 +118,7 @@ module Axlsx
     # @return [String]
     # default nil
     attr_reader :promptTitle
-    
+
     # Show drop down
     # A boolean value indicating whether to display a dropdown combo box for a list type data
     # validation. Be careful: false shows the dropdown list!
@@ -101,7 +127,7 @@ module Axlsx
     # @return [Boolean]
     # default false
     attr_reader :showDropDown
-    
+
     # Show error message
     # A boolean value indicating whether to display the error alert message when an invalid
     # value has been entered, according to the criteria specified.
@@ -110,7 +136,7 @@ module Axlsx
     # @return [Boolean]
     # default false
     attr_reader :showErrorMessage
-    
+
     # Show input message
     # A boolean value indicating whether to display the input prompt message.
     # Available for type whole, decimal, date, time, textLength, list, custom
@@ -118,14 +144,14 @@ module Axlsx
     # @return [Boolean]
     # default false
     attr_reader :showInputMessage
-    
+
     # Range over which data validation is applied, in "A1:B2" format
     # Available for type whole, decimal, date, time, textLength, list, custom
     # @see type
     # @return [String]
     # default nil
     attr_reader :sqref
-    
+
     # The type (ST_DataValidationType) of data validation.
     # Options are:
     #  * custom: Data validation which uses a custom formula to check the cell value.
@@ -139,83 +165,56 @@ module Axlsx
     # @return [Symbol]
     # default none
     attr_reader :type
-    
-    # Creates a new {DataValidation} object
-    # @option options [String] formula1
-    # @option options [String] formula2
-    # @option options [Boolean] allowBlank - A boolean value indicating whether the data validation allows the use of empty or blank entries.
-    # @option options [String] error - Message text of error alert.
-    # @option options [Symbol] errorStyle - The style of error alert used for this data validation.
-    # @option options [String] errorTitle - itle bar text of error alert.
-    # @option options [Symbol] operator - The relational operator used with this data validation.
-    # @option options [String] prompt - Message text of input prompt.
-    # @option options [String] promptTitle - Title bar text of input prompt.
-    # @option options [Boolean] showDropDown - A boolean value indicating whether to display a dropdown combo box for a list type data validation
-    # @option options [Boolean] showErrorMessage - A boolean value indicating whether to display the error alert message when an invalid value has been entered, according to the criteria specified.
-    # @option options [Boolean] showInputMessage - A boolean value indicating whether to display the input prompt message.
-    # @option options [String] sqref - Range over which data validation is applied, in "A1:B2" format.
-    # @option options [Symbol] type - The type of data validation.
-    def initialize(options={})
-      # defaults
-      @formula1 = @formula2 = @error = @errorTitle = @operator = @prompt = @promptTitle = @sqref = nil
-      @allowBlank = @showErrorMessage = true
-      @showDropDown = @showInputMessage = false
-      @type = :none
-      @errorStyle = :stop
-      
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-    
+
+
     # @see formula1
     def formula1=(v); Axlsx::validate_string(v); @formula1 = v end
-    
+
     # @see formula2
     def formula2=(v); Axlsx::validate_string(v); @formula2 = v end 
-    
+
     # @see allowBlank
     def allowBlank=(v); Axlsx::validate_boolean(v); @allowBlank = v end
-    
+
     # @see error
     def error=(v); Axlsx::validate_string(v); @error = v end
-    
+
     # @see errorStyle
     def errorStyle=(v); Axlsx::validate_data_validation_error_style(v); @errorStyle = v end
-    
+
     # @see errorTitle
     def errorTitle=(v); Axlsx::validate_string(v); @errorTitle = v end
-    
+
     # @see operator
     def operator=(v); Axlsx::validate_data_validation_operator(v); @operator = v end
-    
+
     # @see prompt
     def prompt=(v); Axlsx::validate_string(v); @prompt = v end
-    
+
     # @see promptTitle
     def promptTitle=(v); Axlsx::validate_string(v); @promptTitle = v end
-    
+
     # @see showDropDown
     def showDropDown=(v); Axlsx::validate_boolean(v); @showDropDown = v end
-    
+
     # @see showErrorMessage
     def showErrorMessage=(v); Axlsx::validate_boolean(v); @showErrorMessage = v end
-    
+
     # @see showInputMessage
     def showInputMessage=(v); Axlsx::validate_boolean(v); @showInputMessage = v end
-        
+
     # @see sqref
     def sqref=(v); Axlsx::validate_string(v); @sqref = v end
-    
+
     # @see type
     def type=(v); Axlsx::validate_data_validation_type(v); @type = v end
-    
+
     # Serializes the data validation
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       valid_attributes = get_valid_attributes
-      
+
       str << '<dataValidation '
       str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' if (valid_attributes.include?(key.to_sym) and not CHILD_ELEMENTS.include?(key.to_sym)) }.join(' ')
       str << '>'
@@ -223,11 +222,11 @@ module Axlsx
       str << '<formula2>' << self.formula2 << '</formula2>' if @formula2 and valid_attributes.include?(:formula2)
       str << '</dataValidation>'
     end
-    
+
   private
     def get_valid_attributes
       attributes = [:allowBlank, :error, :errorStyle, :errorTitle, :prompt, :promptTitle, :showErrorMessage, :showInputMessage, :sqref, :type ]
-      
+
       if [:whole, :decimal, :data, :time, :textLength].include?(@type)
         attributes << [:operator, :formula1]
         attributes << [:formula2] if [:between, :notBetween].include?(@operator)
@@ -238,7 +237,7 @@ module Axlsx
       else
         attributes = []
       end
-      
+
       attributes.flatten!
     end
   end

data/lib/axlsx/workbook/worksheet/date_time_converter.rb

@@ -10,7 +10,8 @@ module Axlsx
     # @return [Numeric]
     def self.date_to_serial(date)
       epoch = Axlsx::Workbook::date1904 ? Date.new(1904) : Date.new(1899, 12, 30)
-      (date-epoch).to_f
+      offset_date = date.respond_to?(:utc_offset) ? date + date.utc_offset.seconds : date
+      (offset_date - epoch).to_f
     end
 
     # The time_to_serial methond converts a Time object its excel serialized form.
@@ -19,11 +20,11 @@ module Axlsx
     def self.time_to_serial(time)
       # Using hardcoded offsets here as some operating systems will not except
       # a 'negative' offset from the ruby epoch.
-      epoch1900 = -2209161600 # Time.utc(1899, 12, 30).to_i
-      epoch1904 = -2082844800 # Time.utc(1904, 1, 1).to_i
-      seconds_per_day = 86400 # 60*60*24
+      epoch1900 = -2209161600.0 # Time.utc(1899, 12, 30).to_i
+      epoch1904 = -2082844800.0 # Time.utc(1904, 1, 1).to_i
+      seconds_per_day = 86400.0 # 60*60*24
       epoch = Axlsx::Workbook::date1904 ? epoch1904 : epoch1900
-      (time.to_f - epoch)/seconds_per_day
+      (time.utc_offset + time.to_f - epoch)/seconds_per_day
     end
   end
 end

data/lib/axlsx/workbook/worksheet/dimension.rb

@@ -17,7 +17,6 @@ module Axlsx
       @@default_last ||= 'AA200'
     end
 
-
     # Creates a new dimension object
     # @param[Worksheet] worksheet - the worksheet this dimension applies
     # to.

data/lib/axlsx/workbook/worksheet/header_footer.rb

@@ -0,0 +1,54 @@
+module Axlsx
+  # Header/Footer options for printing a worksheet. All settings are optional.
+  #
+  # Headers and footers are generated using a string which is a combination
+  # of plain text and control characters. A fairly comprehensive list of control
+  # characters can be found here:
+  # https://github.com/randym/axlsx/blob/master/notes_on_header_footer.md
+  #     
+  # @note The recommended way of managing header/footers is via Worksheet#header_footer
+  # @see Worksheet#initialize
+  class HeaderFooter
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    include Axlsx::Accessors
+
+    # Creates a new HeaderFooter object
+    # @option options [String] odd_header The content for headers on odd numbered pages.
+    # @option options [String] odd_footer The content for footers on odd numbered pages.
+    # @option options [String] even_header The content for headers on even numbered pages.
+    # @option options [String] even_footer The content for footers on even numbered pages.
+    # @option options [String] first_header The content for headers on even numbered pages.
+    # @option options [String] first_footer The content for footers on even numbered pages.
+    # @option options [Boolean] different_odd_even Setting this to true will show different headers/footers on odd and even pages. When false, the odd headers/footers are used on each page. (Default: false)
+    # @option options [Boolean] different_first If true, will use the first header/footer on page 1. Otherwise, the odd header/footer is used.
+    def initialize(options = {})
+      parse_options options
+    end
+
+    serializable_attributes :different_odd_even, :different_first
+    serializable_element_attributes :odd_header, :odd_footer, :even_header, :even_footer, :first_header, :first_footer
+    string_attr_accessor :odd_header, :odd_footer, :even_header, :even_footer, :first_header, :first_footer
+    boolean_attr_accessor :different_odd_even, :different_first
+
+    # Set some or all header/footers at once.
+    # @param [Hash] options The header/footer options to set (possible keys are :odd_header, :odd_footer, :even_header, :even_footer, :first_header, :first_footer, :different_odd_even, and :different_first).
+    def set(options)
+      parse_options options
+    end
+
+    # Serializes the header/footer object.
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << "<headerFooter "
+      serialized_attributes str
+      str << ">"
+      serialized_element_attributes(str) do |value|
+        value = ::CGI.escapeHTML(value)
+      end
+      str << "</headerFooter>"
+    end
+  end
+end