Class: Uniword::Builder::NumberingBuilder

Inherits:
BaseBuilder
  • Object
show all
Defined in:
lib/uniword/builder/numbering_builder.rb

Overview

Builds numbering definitions for lists.

Examples:

Define a numbered list

doc.define_numbering do |n|
  n.level(0, format: 'decimal', text: '%1.')
  n.level(1, format: 'lowerLetter', text: '%2)')
end

Instance Attribute Summary

Attributes inherited from BaseBuilder

#model

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseBuilder

#build, from_model, #initialize

Constructor Details

This class inherits a constructor from Uniword::Builder::BaseBuilder

Class Method Details

.default_model_class ⇒ Object 



13
14
15
 
# File 'lib/uniword/builder/numbering_builder.rb', line 13

def self.default_model_class
  Wordprocessingml::NumberingConfiguration
end

Instance Method Details

#level(level, format: "decimal", text: "%1.", start: 1) ⇒ self

Define a numbering level

Parameters:

  • level (Integer) —

    Level number (0-based)

  • format (String) (defaults to: "decimal") —

    Number format (‘decimal’, ‘lowerLetter’, ‘upperLetter’, etc.)

  • text (String) (defaults to: "%1.") —

    Level text template (e.g., ‘%1.’, ‘%2)’)

  • start (Integer) (defaults to: 1) —

    Starting number (default 1)

Returns:

  • (self) 


24
25
26
27
 
# File 'lib/uniword/builder/numbering_builder.rb', line 24

def level(level, format: "decimal", text: "%1.", start: 1)
  @model.create_numbering(level, format, text, start)
  self
end