Struct HeaderFooter 

pub struct HeaderFooter { /* private fields */ }

A header or footer that can be added to PDF pages.

Implementations

impl HeaderFooter

pub fn new_header(content: impl Into<String>) -> Self

Creates a new header with the given content.

Example

use oxidize_pdf::text::{HeaderFooter, HeaderFooterOptions};

let header = HeaderFooter::new_header("Annual Report {{year}}");

pub fn new_footer(content: impl Into<String>) -> Self

Creates a new footer with the given content.

Example

use oxidize_pdf::text::{HeaderFooter, HeaderFooterOptions};

let footer = HeaderFooter::new_footer("Page {{page_number}} of {{total_pages}}");

pub fn with_options(self, options: HeaderFooterOptions) -> Self

Sets the options for this header/footer.

pub fn with_font(self, font: Font, size: f64) -> Self

Sets the font for this header/footer.

pub fn with_alignment(self, alignment: TextAlign) -> Self

Sets the text alignment.

pub fn with_margin(self, margin: f64) -> Self

Sets the margin from the page edge.

pub fn position(&self) -> HeaderFooterPosition

Gets the position of this header/footer.

pub fn content(&self) -> &str

Gets the content template.

pub fn options(&self) -> &HeaderFooterOptions

Gets the options.

pub fn render( &self, page_number: usize, total_pages: usize, custom_values: Option<&HashMap<String, String>>, ) -> String

Renders the header/footer content with placeholder substitution.

Available placeholders:

• {{page_number}} - Current page number
• {{total_pages}} - Total number of pages
• {{date}} - Current date
• {{time}} - Current time
• {{datetime}} - Current date and time
• {{year}} - Current year
• {{month}} - Current month
• {{day}} - Current day

pub fn calculate_y_position(&self, page_height: f64) -> f64

Calculates the Y position for rendering based on page height and position.

pub fn calculate_x_position(&self, page_width: f64, text_width: f64) -> f64

Calculates the X position for rendering based on page width and alignment.

Trait Implementations

impl Clone for HeaderFooter

fn clone(&self) -> HeaderFooter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HeaderFooter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.