Index (Office-stamper Utils 3.1 API)

A B C D E F G H I L M N O P R S T V W X
All Classes and Interfaces|All Packages

A

apply(T, U, V) - Method in interface pro.verron.officestamper.utils.function.TriFunction: Applies this function to the given arguments and produces a result.
applyParagraphStyle(R, PPr) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Applies the style of the given paragraph to the given content object (if the content object is a R).
asString(Object) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Extracts textual content from a given object, handling various object types, such as runs, text elements, and other specific constructs.

B

ByteUtils - Class in pro.verron.officestamper.utils.bit: Utility class providing common operations for byte manipulation and conversions.

C

collect(Collector) - Method in interface pro.verron.officestamper.utils.iterator.ResetableIterator: Collects the elements of this iterator into a container using the provided collector.
create(String, PPr) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Creates a new run with the specified text and inherits the style of the parent paragraph.
create(String, RPr) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Creates a new run with the specified text, and the specified run style.

D

deleteCommentFromElements(BigInteger, List) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Deletes all elements associated with the specified comment from the provided list of items.
DocxIterator - Class in pro.verron.officestamper.utils.wml: An iterator that allows the traversal of objects within a WordprocessingML-based document part.
DocxIterator(ContentAccessor) - Constructor for class pro.verron.officestamper.utils.wml.DocxIterator: Creates a new DocxIterator instance that iterates over the content of the given ContentAccessor.
DocxRenderer - Class in pro.verron.officestamper.utils.wml: A utility class for rendering DOCX documents into string representations.
docxToString(WordprocessingMLPackage) - Static method in class pro.verron.officestamper.utils.wml.DocxRenderer: Converts a DOCX document represented by a WordprocessingMLPackage into its string representation.

E

ensureValidity(Tc) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Utility method to ensure the validity of a table cell by adding an empty paragraph if necessary.
exportPowerPoint(PresentationMLPackage, OutputStream) - Static method in class pro.verron.officestamper.utils.openpackaging.OpenpackagingUtils: Exports a PowerPoint document to the provided output stream.
exportWord(WordprocessingMLPackage, OutputStream) - Static method in class pro.verron.officestamper.utils.openpackaging.OpenpackagingUtils: Exports a Word document to the provided output stream.
extractCommentElements(WordprocessingMLPackage) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Extracts a list of comment elements from the specified WordprocessingMLPackage document.

F

filter(Predicate) - Method in interface pro.verron.officestamper.utils.iterator.ResetableIterator: Returns a new ResetableIterator that filters elements based on the provided predicate.
findComment(WordprocessingMLPackage, BigInteger) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Finds a comment with the given ID in the specified WordprocessingMLPackage document.
findFirstAffectedRunPr(ContentAccessor, int, int) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Finds the first affected run properties within the specified range.

G

getFirstParentWithClass(Child, Class, int) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Attempts to find the first parent of a given child element that is an instance of the specified class within the defined search depth.

H

hasNext() - Method in class pro.verron.officestamper.utils.iterator.SlicingIterator
hasNext() - Method in class pro.verron.officestamper.utils.pml.PptxIterator
hasNext() - Method in class pro.verron.officestamper.utils.sml.XlsxIterator
hasNext() - Method in class pro.verron.officestamper.utils.wml.DocxIterator

I

insertSmartTag(String, P, String, int, int) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Inserts a smart tag with the specified element type into the given paragraph at the position of the expression.
isTagElement(CTSmartTagRun, String) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Checks if the given CTSmartTagRun contains an element that matches the expected element.

L

loadPowerPoint(InputStream) - Static method in class pro.verron.officestamper.utils.openpackaging.OpenpackagingUtils: Loads a PowerPoint document from the provided input stream.
loadWord(InputStream) - Static method in class pro.verron.officestamper.utils.openpackaging.OpenpackagingUtils: Loads a Word document from the provided input stream.

M

map(Function) - Method in interface pro.verron.officestamper.utils.iterator.ResetableIterator: Returns a new ResetableIterator that applies the given function to each element.

N

newAttribute(String, String) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Creates a new attribute object with the specified key and value.
newBody(List) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new Body object containing the provided elements.
newBr() - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new Br (break) object with text wrapping enabled.
newCell() - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new cell object.
newComment(BigInteger, String) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new comment with the provided value.
newCommentRangeEnd(BigInteger, ContentAccessor) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new CommentRangeEnd object with the specified ID and parent.
newCommentRangeStart(BigInteger, ContentAccessor) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new CommentRangeStart object with the specified ID and parent.
newCommentReference(BigInteger, ContentAccessor) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new R.CommentReference object with the specified ID and parent.
newComments(List) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new Comments object and populates it with a list of Comments.Comment objects.
newCommentsPart() - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new CommentsPart object.
newCtAttr(String, String) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new CTAttr object with the specified name and value.
newDrawing(Inline) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new Drawing object containing the provided Inline object.
newInline(BinaryPartAbstractImage, String, String, Integer) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new Inline object for the given image part, filename hint, and alt text.
newParagraph(String) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new paragraph containing the provided string value.
newParagraph(String...) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new paragraph containing the provided text values.
newParagraph(List) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new paragraph containing the provided list of values.
newParagraph(R) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new paragraph containing the provided run.
newPartName(String) - Static method in class pro.verron.officestamper.utils.openpackaging.OpenpackagingFactory: Creates a new PartName instance from the given string representation.
newPict(Object) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new Pict object containing the provided inner object.
newPPr() - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new PPr (paragraph properties) object.
newRow() - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new row object.
newRun(Integer, BinaryPartAbstractImage, String, String) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new run containing an image with the specified attributes.
newRun(String) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new run containing the provided string value.
newRun(List) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new run containing the provided values deemed worth keeping.
newRun(Drawing) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new run containing a single drawing.
newRun(Text) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new run containing a single text object.
newSdtBlock(Object) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new SdtBlock object containing the provided inner object.
newSdtRun(Object) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new SdtRun object containing the provided inner object.
newSmartTag(String, CTAttr, Object...) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new smart tag run with the specified element, run and attribute.
newTbl() - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new table object.
newText(String) - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new Text object with the specified value, preserving spaces.
newWord() - Static method in class pro.verron.officestamper.utils.wml.WmlFactory: Creates a new WordprocessingMLPackage object initialized with a main document part, and an empty comments part.
next() - Method in class pro.verron.officestamper.utils.iterator.SlicingIterator
next() - Method in class pro.verron.officestamper.utils.pml.PptxIterator
next() - Method in class pro.verron.officestamper.utils.sml.XlsxIterator
next() - Method in class pro.verron.officestamper.utils.wml.DocxIterator

O

OpenpackagingFactory - Class in pro.verron.officestamper.utils.openpackaging: Utility class for creating Open Packaging objects.
OpenpackagingUtils - Class in pro.verron.officestamper.utils.openpackaging: Utility class for working with Open Packaging documents.

P

PptxIterator - Class in pro.verron.officestamper.utils.pml: An iterator implementation for traversing PowerPoint presentation content.
PptxIterator(PresentationMLPackage) - Constructor for class pro.verron.officestamper.utils.pml.PptxIterator: Constructs a new PptxIterator for the given presentation package.
PptxRenderer - Class in pro.verron.officestamper.utils.pml: Utility class for rendering PowerPoint presentations to string representations.
pptxToString(PresentationMLPackage) - Static method in class pro.verron.officestamper.utils.pml.PptxRenderer: Converts the content of a PowerPoint presentation into a string by extracting text paragraphs from the presentation and formatting them as strings.
pro.verron.officestamper.utils - module pro.verron.officestamper.utils: The pro.verron.officestamper.utils module provides low-level utilities shared by the OfficeStamper engine and associated tools.
pro.verron.officestamper.utils.bit - package pro.verron.officestamper.utils.bit
pro.verron.officestamper.utils.function - package pro.verron.officestamper.utils.function
pro.verron.officestamper.utils.iterator - package pro.verron.officestamper.utils.iterator
pro.verron.officestamper.utils.openpackaging - package pro.verron.officestamper.utils.openpackaging
pro.verron.officestamper.utils.pml - package pro.verron.officestamper.utils.pml
pro.verron.officestamper.utils.sml - package pro.verron.officestamper.utils.sml
pro.verron.officestamper.utils.wml - package pro.verron.officestamper.utils.wml

R

readableSize(int) - Static method in class pro.verron.officestamper.utils.bit.ByteUtils: Converts the size of a byte array into a human-readable string representation using standard size prefixes (e.g., KB, MB, GB).
remove(Child) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Removes the specified child element from its parent container.
replace(ContentAccessor, List, int, int) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Replaces content within the specified range with the provided insert objects.
replaceExpressionWithRun(ContentAccessor, String, List, Consumer) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Replaces all occurrences of the specified expression with the provided run objects.
reset() - Method in interface pro.verron.officestamper.utils.iterator.ResetableIterator: Resets the iterator to its initial state, allowing for iteration to start over from the beginning.
reset() - Method in class pro.verron.officestamper.utils.iterator.SlicingIterator
reset() - Method in class pro.verron.officestamper.utils.pml.PptxIterator
reset() - Method in class pro.verron.officestamper.utils.sml.XlsxIterator
reset() - Method in class pro.verron.officestamper.utils.wml.DocxIterator
ResetableIterator<T> - Interface in pro.verron.officestamper.utils.iterator: An interface that extends the Iterator interface, providing an additional capability to reset the iterator back to its initial state.

S

selectClass(Class) - Method in class pro.verron.officestamper.utils.wml.DocxIterator: Selects and casts elements of the specified class type from the iterator.
setTagAttribute(CTSmartTagRun, String, String) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Sets or updates an attribute for the specified smart tag.
setText(R, String) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Sets the text of the given run to the given value.
sha1b64(byte[]) - Static method in class pro.verron.officestamper.utils.bit.ByteUtils: Computes the SHA-1 hash of the given input bytes and encodes the result in Base64.
slice(T, T) - Method in interface pro.verron.officestamper.utils.iterator.ResetableIterator: Returns a new ResetableIterator that provides a slice of the original iterator's elements.
SlicingIterator<T> - Class in pro.verron.officestamper.utils.iterator: A ResetableIterator implementation that provides a sliced view of another iterator.
SlicingIterator(ResetableIterator, T, T) - Constructor for class pro.verron.officestamper.utils.iterator.SlicingIterator: Constructs a new SlicingIterator with the specified source iterator and boundaries.

T

TriFunction<T,U,V,W> - Interface in pro.verron.officestamper.utils.function: Represents a functional interface that takes three input arguments of types T, U, and V and produces a result of type W.

V

visitDocument(WordprocessingMLPackage, TraversalUtilVisitor) - Static method in class pro.verron.officestamper.utils.wml.WmlUtils: Visits the document's main content, header, footer, footnotes, and endnotes using the specified visitor.

W

WmlFactory - Class in pro.verron.officestamper.utils.wml: Utility class for creating and configuring various WordML (WML) elements.
WmlUtils - Class in pro.verron.officestamper.utils.wml: Utility class with methods to help in the interaction with WordprocessingMLPackage documents and their elements, such as comments, parents, and child elements.

X

XlsxIterator - Class in pro.verron.officestamper.utils.sml: XlsxIterator is an ResetableIterator implementation that iterates through the elements of an Excel spreadsheet document.
XlsxIterator(SpreadsheetMLPackage) - Constructor for class pro.verron.officestamper.utils.sml.XlsxIterator: Constructs a new XlsxIterator for iterating through the elements of a SpreadsheetML package.
XlsxRenderer - Class in pro.verron.officestamper.utils.sml: Utility class for rendering SpreadsheetML (Excel) files to string representations.
xlsxToString(SpreadsheetMLPackage) - Static method in class pro.verron.officestamper.utils.sml.XlsxRenderer: Converts the content of a SpreadsheetMLPackage into a string by extracting and formatting cell data from the Excel file.

A B C D E F G H I L M N O P R S T V W X
All Classes and Interfaces|All Packages