Struct FieldTree 

pub struct FieldTree {
    pub calculation_order: Vec<FieldId>,
    pub document_da: Option<String>,
    pub document_quadding: Option<Quadding>,
    pub need_appearances: bool,
    pub sig_flags: u32,
    /* private fields */
}

The complete AcroForm field tree.

Fields

calculation_order: Vec<FieldId>

Calculation order (/CO) — field IDs in evaluation order.

document_da: Option<String>

Document-level default appearance (/DA).

document_quadding: Option<Quadding>

Document-level quadding (/Q).

need_appearances: bool

Whether /NeedAppearances is set.

sig_flags: u32

SigFlags value.

Implementations

impl FieldTree

pub fn new() -> Self

Create an empty field tree.

pub fn alloc(&mut self, node: FieldNode) -> FieldId

Allocate a new node, returning its ID.

pub fn get(&self, id: FieldId) -> &FieldNode

Get a node by ID.

pub fn get_mut(&mut self, id: FieldId) -> &mut FieldNode

Get a mutable node by ID.

pub fn len(&self) -> usize

Number of nodes.

pub fn is_empty(&self) -> bool

Whether the tree is empty.

pub fn roots(&self) -> Vec<FieldId>

Return IDs of all root nodes (no parent).

pub fn terminal_fields(&self) -> Vec<FieldId>

Return IDs of all terminal (leaf/widget) fields.

pub fn fully_qualified_name(&self, id: FieldId) -> String

Compute the fully qualified field name by walking up the parent chain.

pub fn effective_field_type(&self, id: FieldId) -> Option<FieldType>

Walk up the tree to find the effective field type.

pub fn effective_value(&self, id: FieldId) -> Option<&FieldValue>

Walk up the tree to find the effective value.

pub fn effective_da(&self, id: FieldId) -> Option<&str>

Walk up the tree to find the effective DA string.

pub fn effective_quadding(&self, id: FieldId) -> Quadding

Walk up the tree to find the effective quadding.

pub fn effective_flags(&self, id: FieldId) -> FieldFlags

Walk up the tree to get effective flags.

pub fn effective_max_len(&self, id: FieldId) -> Option<u32>

Walk up the tree to find the effective MaxLen.

/MaxLen is treated as inheritable (like /FT, /DA, /Q): if a widget does not carry it directly, the value propagates from the nearest ancestor that does.

pub fn find_by_name(&self, name: &str) -> Option<FieldId>

Find a terminal field by fully qualified name.

pub fn all_ids(&self) -> impl Iterator<Item = FieldId>

Return all node IDs.

Trait Implementations

impl Debug for FieldTree

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

Formats the value using the given formatter.

impl Default for FieldTree

fn default() -> Self

Returns the “default value” for a type.

impl FormAccess for FieldTree

fn form_type(&self) -> FormKind

Returns the kind of form (AcroForm, XFA, or None).

fn field_names(&self) -> Vec<String>

Returns all fully-qualified field names in the form.

fn get_value(&self, path: &str) -> Option<String>

Gets the current value of a field by its fully-qualified name.

fn set_value(&mut self, path: &str, value: &str) -> Result<(), FormError>

Sets the value of a field by its fully-qualified name.