Struct PageForm 

pub struct PageForm {
    pub page: PageIndex,
    pub tab_order: TabOrder,
    pub widgets: Vec<WidgetInfo>,
    pub dicts: BTreeMap<u32, Dict>,
    pub page_height: f32,
    /* private fields */
}

Everything one page contributes to routing.

Built once per page per event replay. The three lists are parallel views of the same walk rather than three walks: candidates is what the hit test reads, focusables is what the tab ring reads, and widgets is what a field’s state is built from.

Fields

page: PageIndex

Which page this describes.

tab_order: TabOrder

The traversal order this page’s /Tabs asks for.

A property of the page, not of the session: annotiter.pdf is three pages of identical annotations under /R, /C and /S, and the first Tab lands on a different one on each. Defaults to TabOrder::Structure, which is also what an unrecognized spelling means.

widgets: Vec<WidgetInfo>

The widgets, with what a field’s interaction state needs.

dicts: BTreeMap<u32, Dict>

Every annotation’s dictionary, keyed by its raw /Annots index.

A BTreeMap rather than a Vec because the walk skips entries it cannot read as dictionaries, so the indices have gaps and a positional list would silently shift everything after one.

page_height: f32

The page’s height in PDF units, for the one thing that needs it: how much room a combo box has to open its dropdown into.

The room is measured against a rectangle taken from the origin, whatever the crop box says, so this is the display height and the comparison on the other side is against zero. Reproduced rather than corrected: a page whose crop box starts away from the origin gets the oracle’s answer, right or wrong, because the popup’s position is what a golden pins.

Implementations

impl PageForm

pub fn field_of_index(&self, index: u32) -> Option<FieldId>

The page-local FieldId for a document-wide field position, when a widget of that field is on this page.

The inverse of WidgetInfo::field_index, and the conversion a calculation’s writes need: /CO names its targets in the document’s space and the session stores state in this one. None is the honest answer for a field whose widgets are all on other pages — this page has no state to write, and inventing a FieldId from the number would write some other field.

Trait Implementations

impl Clone for PageForm

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageForm

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

Formats the value using the given formatter.

impl Default for PageForm

fn default() -> Self

Returns the “default value” for a type.