PageNumber support margin top/left

docs/assets/examples/pagenumber/v2/main.go

@@ -35,11 +35,13 @@ func main() {
 
 func GetMaroto() core.Maroto {
 	pageNumber := props.PageNumber{
-		Pattern: "Page {current} of {total}",
-		Place:   props.Bottom,
-		Family:  fontfamily.Courier,
-		Style:   fontstyle.Bold,
-		Size:    9,
+		Pattern:    "Page {current} of {total}",
+		Place:      props.Bottom,
+		Family:     fontfamily.Courier,
+		Style:      fontstyle.Bold,
+		MarginTop:  26,
+		MarginLeft: 188,
+		Size:       9,
 		Color: &props.Color{
 			Red: 255,
 		},

docs/assets/text/pagenumberv2.txt

@@ -1,3 +1,3 @@
-generate -> avg: 4.08ms, executions: [4.08ms]
-add_rows -> avg: 167.53ns, executions: [920.00ns, 141.00ns, 91.00ns, 56.00ns, 132.00ns, 44.00ns, 36.00ns, 35.00ns, 121.00ns, 36.00ns, 35.00ns, 35.00ns, 34.00ns, 724.00ns, 73.00ns]
-file_size -> 5.72Kb
+generate -> avg: 12.32ms, executions: [12.32ms]
+add_rows -> avg: 649.87ns, executions: [2.58μs, 0.41μs, 0.39μs, 0.19μs, 0.45μs, 0.15μs, 0.15μs, 0.15μs, 0.44μs, 0.16μs, 0.15μs, 0.16μs, 0.15μs, 3.75μs, 0.46μs]
+file_size -> 5.71Kb

internal/providers/gofpdf/provider.go

@@ -46,8 +46,8 @@ func New(dep *Dependencies) core.Provider {
 	}
 }
 
-func (g *provider) AddText(text string, cell *entity.Cell, prop *props.Text) {
-	g.text.Add(text, cell, prop)
+func (g *provider) AddText(text string, cell *entity.Cell, prop *props.Text, usePageMargin ...bool) {
+	g.text.Add(text, cell, prop, usePageMargin...)
 }
 
 func (g *provider) GetLinesQuantity(text string, textProp *props.Text, colWidth float64) int {

internal/providers/gofpdf/text.go

@@ -29,11 +29,8 @@
 	}
 }
 
-// Add a text inside a cell.
-func (s *text) Add(text string, cell *entity.Cell, textProp *props.Text) {
-	s.font.SetFont(textProp.Family, textProp.Style, textProp.Size)
-	fontHeight := s.font.GetHeight(textProp.Family, textProp.Style, textProp.Size)
-
+// validates whether the text position respects the cell limits
+func validTextPosition(textProp *props.Text, cell *entity.Cell) {
 	if textProp.Top > cell.Height {
 		textProp.Top = cell.Height
 	}
@@ -45,6 +42,20 @@
 	if textProp.Right > cell.Width {
 		textProp.Right = cell.Width
 	}
+}
+
+// Add a text inside a cell.
+// When usePageMargin is false, text can be positioned at any position in the cell
+func (t *text) Add(text string, cell *entity.Cell, textProp *props.Text, usePageMargin ...bool) {
+	if len(usePageMargin) > 0 && !usePageMargin[0] {
+		left, top, right, _ := t.pdf.GetMargins()
+		defer t.pdf.SetMargins(left, top, right)
+		t.pdf.SetMargins(0.0, 0.0, 0.0)
+	}
+	t.font.SetFont(textProp.Family, textProp.Style, textProp.Size)
+	fontHeight := t.font.GetHeight(textProp.Family, textProp.Style, textProp.Size)
+
+	validTextPosition(textProp, cell)
 
 	width := cell.Width - textProp.Left - textProp.Right
 	if width < 0 {
@@ -54,27 +65,27 @@
 	x := cell.X + textProp.Left
 	y := cell.Y + textProp.Top
 
-	originalColor := s.font.GetColor()
+	originalColor := t.font.GetColor()
 	if textProp.Color != nil {
-		s.font.SetColor(textProp.Color)
+		t.font.SetColor(textProp.Color)
 	}
 
 	// override style if hyperlink is set
 	if textProp.Hyperlink != nil {
-		s.font.SetColor(&props.BlueColor)
+		t.font.SetColor(&props.BlueColor)
 	}
 
 	y += fontHeight
 
 	// Apply Unicode before calc spaces
-	unicodeText := s.textToUnicode(text, textProp)
-	stringWidth := s.pdf.GetStringWidth(unicodeText)
+	unicodeText := t.textToUnicode(text, textProp)
+	stringWidth := t.pdf.GetStringWidth(unicodeText)
 
 	// If should add one line
 	if stringWidth < width {
-		s.addLine(textProp, x, width, y, stringWidth, unicodeText)
+		t.addLine(textProp, x, width, y, stringWidth, unicodeText)
 		if textProp.Color != nil {
-			s.font.SetColor(originalColor)
+			t.font.SetColor(originalColor)
 		}
 		return
 	}
@@ -83,66 +94,66 @@
 
 	if textProp.BreakLineStrategy == breakline.EmptySpaceStrategy {
 		words := strings.Split(unicodeText, " ")
-		lines = s.getLinesBreakingLineFromSpace(words, width)
+		lines = t.getLinesBreakingLineFromSpace(words, width)
 	} else {
-		lines = s.getLinesBreakingLineWithDash(unicodeText, width)
+		lines = t.getLinesBreakingLineWithDash(unicodeText, width)
 	}
 
 	accumulateOffsetY := 0.0
 
 	for index, line := range lines {
-		lineWidth := s.pdf.GetStringWidth(line)
+		lineWidth := t.pdf.GetStringWidth(line)
 
-		s.addLine(textProp, x, width, y+float64(index)*fontHeight+accumulateOffsetY, lineWidth, line)
+		t.addLine(textProp, x, width, y+float64(index)*fontHeight+accumulateOffsetY, lineWidth, line)
 		accumulateOffsetY += textProp.VerticalPadding
 	}
 
 	if textProp.Color != nil {
-		s.font.SetColor(originalColor)
+		t.font.SetColor(originalColor)
 	}
 }
 
 // GetLinesQuantity retrieve the quantity of lines which a text will occupy to avoid that text to extrapolate a cell.
-func (s *text) GetLinesQuantity(text string, textProp *props.Text, colWidth float64) int {
-	s.font.SetFont(textProp.Family, textProp.Style, textProp.Size)
+func (t *text) GetLinesQuantity(text string, textProp *props.Text, colWidth float64) int {
+	t.font.SetFont(textProp.Family, textProp.Style, textProp.Size)
 
-	textTranslated := s.textToUnicode(text, textProp)
+	textTranslated := t.textToUnicode(text, textProp)
 
 	if textProp.BreakLineStrategy == breakline.DashStrategy {
-		return len(s.getLinesBreakingLineWithDash(text, colWidth))
+		return len(t.getLinesBreakingLineWithDash(text, colWidth))
 	} else {
-		return len(s.getLinesBreakingLineFromSpace(strings.Split(textTranslated, " "), colWidth))
+		return len(t.getLinesBreakingLineFromSpace(strings.Split(textTranslated, " "), colWidth))
 	}
 }
 
-func (s *text) getLinesBreakingLineFromSpace(words []string, colWidth float64) []string {
+func (t *text) getLinesBreakingLineFromSpace(words []string, colWidth float64) []string {
 	currentlySize := 0.0
 	actualLine := 0
 
 	lines := []string{}
 	lines = append(lines, "")
 
 	for _, word := range words {
-		if s.pdf.GetStringWidth(word+" ")+currentlySize < colWidth {
+		if t.pdf.GetStringWidth(word+" ")+currentlySize < colWidth {
 			lines[actualLine] = lines[actualLine] + word + " "
-			currentlySize += s.pdf.GetStringWidth(word + " ")
+			currentlySize += t.pdf.GetStringWidth(word + " ")
 		} else {
 			lines = append(lines, "")
 			actualLine++
 			lines[actualLine] = lines[actualLine] + word + " "
-			currentlySize = s.pdf.GetStringWidth(word + " ")
+			currentlySize = t.pdf.GetStringWidth(word + " ")
 		}
 	}
 
 	return lines
 }
 
-func (s *text) getLinesBreakingLineWithDash(words string, colWidth float64) []string {
+func (t *text) getLinesBreakingLineWithDash(words string, colWidth float64) []string {
 	currentlySize := 0.0
 
 	lines := []string{}
 
-	dashSize := s.pdf.GetStringWidth(" - ")
+	dashSize := t.pdf.GetStringWidth(" - ")
 
 	var content string
 	for _, letter := range words {
@@ -154,7 +165,7 @@
 		}
 
 		letterString := fmt.Sprintf("%c", letter)
-		width := s.pdf.GetStringWidth(letterString)
+		width := t.pdf.GetStringWidth(letterString)
 		content += letterString
 		currentlySize += width
 	}
@@ -166,16 +177,16 @@
 	return lines
 }
 
-func (s *text) addLine(textProp *props.Text, xColOffset, colWidth, yColOffset, textWidth float64, text string) {
-	left, top, _, _ := s.pdf.GetMargins()
+func (t *text) addLine(textProp *props.Text, xColOffset, colWidth, yColOffset, textWidth float64, text string) {
+	left, top, _, _ := t.pdf.GetMargins()
 
-	fontHeight := s.font.GetHeight(textProp.Family, textProp.Style, textProp.Size)
+	fontHeight := t.font.GetHeight(textProp.Family, textProp.Style, textProp.Size)
 
 	if textProp.Align == align.Left {
-		s.pdf.Text(xColOffset+left, yColOffset+top, text)
+		t.pdf.Text(xColOffset+left, yColOffset+top, text)
 
 		if textProp.Hyperlink != nil {
-			s.pdf.LinkString(xColOffset+left, yColOffset+top-fontHeight, textWidth, fontHeight, *textProp.Hyperlink)
+			t.pdf.LinkString(xColOffset+left, yColOffset+top-fontHeight, textWidth, fontHeight, *textProp.Hyperlink)
 		}
 
 		return
@@ -187,8 +198,8 @@
 
 		text = strings.TrimRight(text, spaceString)
 		textNotSpaces := strings.ReplaceAll(text, spaceString, emptyString)
-		textWidth = s.pdf.GetStringWidth(textNotSpaces)
-		defaultSpaceWidth := s.pdf.GetStringWidth(spaceString)
+		textWidth = t.pdf.GetStringWidth(textNotSpaces)
+		defaultSpaceWidth := t.pdf.GetStringWidth(spaceString)
 		words := strings.Fields(text)
 
 		numSpaces := max(len(words)-1, 1)
@@ -201,13 +212,13 @@
 		initX := x
 		var finishX float64
 		for _, word := range words {
-			s.pdf.Text(x, yColOffset+top, word)
-			finishX = x + s.pdf.GetStringWidth(word)
+			t.pdf.Text(x, yColOffset+top, word)
+			finishX = x + t.pdf.GetStringWidth(word)
 			x = finishX + spaceWidth
 		}
 
 		if textProp.Hyperlink != nil {
-			s.pdf.LinkString(initX, yColOffset+top-fontHeight, finishX-initX, fontHeight, *textProp.Hyperlink)
+			t.pdf.LinkString(initX, yColOffset+top-fontHeight, finishX-initX, fontHeight, *textProp.Hyperlink)
 		}
 
 		return
@@ -222,19 +233,19 @@
 	dx := (colWidth - textWidth) / modifier
 
 	if textProp.Hyperlink != nil {
-		s.pdf.LinkString(dx+xColOffset+left, yColOffset+top-fontHeight, textWidth, fontHeight, *textProp.Hyperlink)
+		t.pdf.LinkString(dx+xColOffset+left, yColOffset+top-fontHeight, textWidth, fontHeight, *textProp.Hyperlink)
 	}
 
-	s.pdf.Text(dx+xColOffset+left, yColOffset+top, text)
+	t.pdf.Text(dx+xColOffset+left, yColOffset+top, text)
 }
 
-func (s *text) textToUnicode(txt string, props *props.Text) string {
+func (t *text) textToUnicode(txt string, props *props.Text) string {
 	if props.Family == fontfamily.Arial ||
 		props.Family == fontfamily.Helvetica ||
 		props.Family == fontfamily.Symbol ||
 		props.Family == fontfamily.ZapBats ||
 		props.Family == fontfamily.Courier {
-		translator := s.pdf.UnicodeTranslatorFromDescriptor("")
+		translator := t.pdf.UnicodeTranslatorFromDescriptor("")
 		return translator(txt)
 	}
 

internal/providers/gofpdf/text_test.go

@@ -4,14 +4,18 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/johnfercher/maroto/v2/internal/fixture"
 	"github.com/johnfercher/maroto/v2/internal/providers/gofpdf"
+	"github.com/johnfercher/maroto/v2/pkg/consts/align"
 	"github.com/johnfercher/maroto/v2/pkg/consts/breakline"
 	"github.com/johnfercher/maroto/v2/pkg/consts/fontfamily"
 	"github.com/johnfercher/maroto/v2/pkg/consts/fontstyle"
+	"github.com/johnfercher/maroto/v2/pkg/core/entity"
 	"github.com/johnfercher/maroto/v2/pkg/props"
 
 	"github.com/johnfercher/maroto/v2/mocks"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/mock"
 )
 
 func TestNewText(t *testing.T) {
@@ -21,6 +25,30 @@ func TestNewText(t *testing.T) {
 	assert.Equal(t, fmt.Sprintf("%T", text), "*gofpdf.text")
 }
 
+func TestAdd(t *testing.T) {
+	t.Run("when usePageMargin is false, should set the page margin to 0", func(t *testing.T) {
+		color := fixture.ColorProp()
+
+		pdf := mocks.NewFpdf(t)
+		pdf.EXPECT().SetMargins(0.0, 0.0, 0.0)
+		pdf.EXPECT().SetMargins(10.0, 10.0, 10.0)
+		pdf.EXPECT().GetMargins().Return(10.0, 10.0, 10.0, 10.0)
+		pdf.EXPECT().GetStringWidth(mock.Anything).Return(4)
+		pdf.EXPECT().Text(mock.Anything, mock.Anything, mock.Anything)
+
+		font := mocks.NewFont(t)
+		font.EXPECT().SetFont(mock.Anything, mock.Anything, mock.Anything)
+		font.EXPECT().GetHeight(mock.Anything, mock.Anything, mock.Anything).Return(10.0)
+		font.EXPECT().GetColor().Return(&color)
+
+		text := gofpdf.NewText(pdf, mocks.NewMath(t), font)
+		text.Add("test", &entity.Cell{X: 0, Y: 0, Width: 100, Height: 290}, &props.Text{Align: align.Center}, false)
+
+		pdf.AssertNumberOfCalls(t, "SetMargins", 2)
+		pdf.AssertNumberOfCalls(t, "GetMargins", 2)
+	})
+}
+
 func TestGetLinesheight(t *testing.T) {
 	t.Run("when a text that occupies two lines is sent with EmptySpaceStrategy, should two is returned", func(t *testing.T) {
 		textProp := &props.Text{}

maroto_test.go

@@ -6,6 +6,8 @@ import (
 	"testing"
 	"time"
 
+	"github.com/johnfercher/maroto/v2/pkg/props"
+
 	"github.com/johnfercher/maroto/v2/pkg/components/code"
 	"github.com/johnfercher/maroto/v2/pkg/components/text"
 
@@ -397,9 +399,13 @@ func TestMaroto_Generate(t *testing.T) {
 		assert.Equal(t, initialGoroutines, finalGoroutines)
 	})
 	t.Run("page number", func(t *testing.T) {
+		pageNumber := props.PageNumber{
+			MarginTop:  1,
+			MarginLeft: 2,
+		}
 		// Arrange
 		cfg := config.NewBuilder().
-			WithPageNumber().
+			WithPageNumber(pageNumber).
 			Build()
 
 		sut := maroto.New(cfg)