Uses of Class
com.openhtmltopdf.render.Box
Packages that use Box
Package
Description
-
Uses of Box in com.openhtmltopdf.css.style
Methods in com.openhtmltopdf.css.style with parameters of type BoxModifier and TypeMethodDescriptionstatic intCalculatedStyle.getCSSMaxHeight(CssContext c, Box box) Aims to get the correct resolved max-height for a box in dots unit. returns -1 if there is no max-height defined.static intCalculatedStyle.getCSSMaxWidth(CssContext c, Box box) Aims to get the correct resolved max-width for a box in dots unit.booleanCalculatedStyle.isVisible(RenderingContext renderingContext, Box thisElement) Determine if the element is visible. -
Uses of Box in com.openhtmltopdf.extend
Methods in com.openhtmltopdf.extend with parameters of type BoxModifier and TypeMethodDescriptionSVGDrawer.buildSVGImage(Element svgElement, Box box, CssContext cssContext, double cssWidth, double cssHeight, double dotsPerPixel) voidOutputDevice.drawDebugOutline(RenderingContext c, Box box, FSColor color) voidOutputDevice.paintBackground(RenderingContext c, Box box) voidOutputDevice.paintBorder(RenderingContext c, Box box) OutputDevice.startStructure(StructureType type, Box box) Propagate the structure heirachy to allow for PDF/UA compliance. -
Uses of Box in com.openhtmltopdf.java2d
Methods in com.openhtmltopdf.java2d with parameters of type BoxConstructors in com.openhtmltopdf.java2d with parameters of type BoxModifierConstructorDescriptionJava2DSVGReplacedElement(Element e, SVGDrawer svgImpl, int width, int height, Box box, CssContext c) -
Uses of Box in com.openhtmltopdf.layout
Methods in com.openhtmltopdf.layout that return BoxModifier and TypeMethodDescriptionLayer.find(CssContext cssCtx, int absX, int absY, boolean findAnonymous) Deprecated.SharedContext.getBoxById(String id) Layer.getEnd()FloatManager.getMaster()Layer.getMaster()Layer.getSelectionEnd()Layer.getSelectionStart()Methods in com.openhtmltopdf.layout that return types with arguments of type BoxMethods in com.openhtmltopdf.layout with parameters of type BoxModifier and TypeMethodDescriptionvoidvoidprotected List<AffineTransform> Layer.applyTranform(RenderingContext c, Box box) Deprecated.static List<TextDecoration> InlineBoxing.calculateTextDecorations(Box box, int baseline, FSFontMetrics fm) voidBlockFormattingContext.clear(LayoutContext c, Box current) voidFloatManager.clear(CssContext cssCtx, BlockFormattingContext bfc, Box box) voidBoxCollector.collect(CssContext c, Shape clip, Layer layer, Box container, List<Box> blockContent, List<Box> inlineContent, BoxRangeLists rangeLists) VerticalAlignContext.createChild(Box root) static StrutMetricsInlineBoxing.createDefaultStrutMetrics(LayoutContext c, Box container) voidLayer.ensureHasPage(CssContext c, Box box) Layer.getFirstPage(CssContext c, Box box) Layer.getLastPage(CssContext c, Box box) booleanBoxCollector.intersectsAny(CssContext c, Shape clip, Box master) voidstatic intInlineBoxing.positionHorizontally(CssContext c, Box current, int start) static intInlineBoxing.positionHorizontallyRTL(CssContext c, Box current, int start, int width) Attempts to layout inline boxes from right to left.voidvoidLayoutContext.pushLayerIsolated(Box master) voidvoidLayer.setSelectionEnd(Box selectionEnd) voidLayer.setSelectionStart(Box selectionStart) Method parameters in com.openhtmltopdf.layout with type arguments of type BoxModifier and TypeMethodDescriptionvoidBoxCollector.collect(CssContext c, Shape clip, Layer layer, Box container, List<Box> blockContent, List<Box> inlineContent, BoxRangeLists rangeLists) voidBoxCollector.collect(CssContext c, Shape clip, Layer layer, List<Box> blockContent, List<Box> inlineContent, BoxRangeLists rangeLists) Constructors in com.openhtmltopdf.layout with parameters of type BoxModifierConstructorDescriptionFloatManager(Box master) Layer(Layer parent, Box master, CssContext c) Creates a child layer.Layer(Box master, CssContext c) Creates the root layer.Layer(Box master, CssContext c, boolean isolated) -
Uses of Box in com.openhtmltopdf.newtable
Subclasses of Box in com.openhtmltopdf.newtableModifier and TypeClassDescriptionclassclassclassclass -
Uses of Box in com.openhtmltopdf.pdfboxout
Fields in com.openhtmltopdf.pdfboxout declared as BoxMethods in com.openhtmltopdf.pdfboxout that return types with arguments of type BoxModifier and TypeMethodDescriptionPdfBoxFastOutputDevice.findPagePositionsByID(CssContext c, Pattern pattern) PdfBoxOutputDevice.findPagePositionsByID(CssContext c, Pattern pattern) PdfBoxRenderer.findPagePositionsByID(Pattern pattern) PdfBoxSlowOutputDevice.findPagePositionsByID(CssContext c, Pattern pattern) Methods in com.openhtmltopdf.pdfboxout with parameters of type BoxModifier and TypeMethodDescriptionvoidPdfBoxPerDocumentFormState.addControlIfRequired(Box box, org.apache.pdfbox.pdmodel.PDPage page, AffineTransform transform, RenderingContext c, float pageHeight) Adds a control to a list to be used later byprocessControls.voidPdfBoxPerDocumentFormState.addFormIfRequired(Box box, PdfBoxOutputDevice od) Adds a form to a map to be used later byprocessControls.voidPdfBoxAccessibilityHelper.addLink(Box anchor, Box target, org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation pdAnnotation, org.apache.pdfbox.pdmodel.PDPage page) static PdfBoxPDFReplacedElementPdfBoxPDFReplacedElement.create(org.apache.pdfbox.pdmodel.PDDocument target, byte[] pdfBytes, Element e, Box box, CssContext ctx, SharedContext shared) static org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestinationPdfBoxBookmarkManager.createBoxDestination(RenderingContext c, org.apache.pdfbox.pdmodel.PDDocument writer, PdfBoxFastOutputDevice od, float dotsPerPoint, Box root, Box box) Creates aPDPageXYZDestinationwith the Y set to the min Y of the border box and the X and Z set to null.static Rectangle2DPdfBoxFastLinkManager.createTargetArea(RenderingContext c, Box box, float pageHeight, AffineTransform transform, Box _root, PdfBoxOutputDevice _od) static Rectangle2DPdfBoxLinkManager.createTargetArea(RenderingContext c, Box box, float pageHeight, AffineTransform transform, Box _root, PdfBoxOutputDevice _od) Deprecated.voidPdfBoxFastOutputDevice.finish(RenderingContext c, Box root) voidPdfBoxOutputDevice.finish(RenderingContext c, Box root) voidPdfBoxSlowOutputDevice.finish(RenderingContext c, Box root) intPdfBoxFastOutputDevice.getPageRefY(Box box) intPdfBoxOutputDevice.getPageRefY(Box box) intPdfBoxSlowOutputDevice.getPageRefY(Box box) static org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElementPdfBoxAccessibilityHelper.getStructualElementForBox(Box targetBox) Given a box, gets its structual element.voidPdfBoxFastOutputDevice.paintBackground(RenderingContext c, Box box) We use paintBackground to do extra stuff such as processing links, forms and form controls.voidPdfBoxOutputDevice.paintBackground(RenderingContext c, Box box) We use paintBackground to do extra stuff such as processing links, forms and form controls.voidPdfBoxSlowOutputDevice.paintBackground(RenderingContext c, Box box) We use paintBackground to do extra stuff such as processing links, forms and form controls.intPdfBoxForm.process(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm acro, int startId, Box root) voidPdfBoxPerDocumentFormState.processControls(SharedContext sharedContext, org.apache.pdfbox.pdmodel.PDDocument writer, Box root) voidPdfBoxFastLinkManager.processLinkLater(RenderingContext c, Box box, org.apache.pdfbox.pdmodel.PDPage page, float pageHeight, AffineTransform transform) voidPdfBoxLinkManager.processLinkLater(RenderingContext c, Box box, org.apache.pdfbox.pdmodel.PDPage page, float pageHeight, AffineTransform transform) Deprecated.voidvoidvoidcom.openhtmltopdf.pdfboxout.PdfBoxAccessibilityHelper.TokenPdfBoxAccessibilityHelper.startStructure(StructureType type, Box box) PdfBoxFastOutputDevice.startStructure(StructureType type, Box box) PdfBoxSlowOutputDevice.startStructure(StructureType type, Box box) voidPdfBoxBookmarkManager.writeOutline(RenderingContext c, Box root) Constructors in com.openhtmltopdf.pdfboxout with parameters of type BoxModifierConstructorDescriptionControl(Box box, org.apache.pdfbox.pdmodel.PDPage page, AffineTransform transform, RenderingContext c, float pageHeight) PdfBoxAccessibilityHelper(PdfBoxFastOutputDevice od, Box root, Document doc) PdfBoxFastLinkManager(SharedContext ctx, float dotsPerPoint, Box root, PdfBoxFastOutputDevice od) PdfBoxLinkManager(SharedContext ctx, float dotsPerPoint, Box root, PdfBoxOutputDevice od) Deprecated.PdfBoxSVGReplacedElement(Element e, SVGDrawer svgImpl, int cssWidth, int cssHeight, Box box, CssContext css, SharedContext c) -
Uses of Box in com.openhtmltopdf.render
Subclasses of Box in com.openhtmltopdf.renderModifier and TypeClassDescriptionclassAn anonymous block box as defined in the CSS spec.classA block box as defined in the CSS spec.classclassclassABoxwhich contains the portion of an inline element layed out on a single line.classA line box contains a single line of text (or other inline content).classA dummy box representing one side of the margin area of a page.classA dummy box representing the viewportMethods in com.openhtmltopdf.render that return BoxModifier and TypeMethodDescriptionAnonymousBlockBox.find(CssContext cssCtx, int absX, int absY, boolean findAnonymous) Box.find(CssContext cssCtx, int absX, int absY, boolean findAnonymous) InlineLayoutBox.find(CssContext cssCtx, int absX, int absY, boolean findAnonymous) LineBox.find(CssContext cssCtx, int absX, int absY, boolean findAnonymous) Box.findAncestor(Predicate<Box> predicate) Walks up the ancestor tree to the root testing ancestors agains the predicate.RenderingContext.getBoxById(String id) Box.getChild(int i) Box.getContainingBlock()BlockBox.getDocumentParent()Box.getDocumentParent()protected Boxprotected BoxBox.getNextSibling()Box.getParent()FlowingColumnBox.getParent()protected BoxBox.getPrevious(Box child) protected BoxInlineLayoutBox.getPrevious(Box child) Box.getPreviousSibling()BlockBox.getStaticEquivalent()Box.rootBox()Returns the highest ancestor box.Methods in com.openhtmltopdf.render that return types with arguments of type BoxModifier and TypeMethodDescriptionBox.ancestors()Get all ancestors, up until the root box.Box.ancestorsWhile(Predicate<Box> predicate) Creates a list of ancestors by walking up the chain of parent, grandparent, etc.Box.getChildIterator()Box.getChildren()Box.getElementBoxes(Element elem) InlineLayoutBox.getElementBoxes(Element elem) InlineLayoutBox.getElementWithContent()LineBox.getNonFlowContent()Methods in com.openhtmltopdf.render with parameters of type BoxModifier and TypeMethodDescriptionvoidAdd a break opportunity.voidvoidBox.addChildForLayout(LayoutContext c, Box child) booleanFlowingColumnContainerBox.ColumnBreakStore.checkContainerShouldProcess(Box container) Whether an ancestor box needs to be added to the list of ancestors.voidAbstractOutputDevice.drawDebugOutline(RenderingContext c, Box box, FSColor color) intBlockBox.findOffset(Box box) protected Boxprotected Boxprotected BoxBox.getPrevious(Box child) protected BoxInlineLayoutBox.getPrevious(Box child) voidAbstractOutputDevice.paintBackground(RenderingContext c, Box box) voidAbstractOutputDevice.paintBorder(RenderingContext c, Box box) booleanBox.removeChild(Box target) Removes a child box if it is indeed a child and adjusts the index of subsequent children.booleanInlineLayoutBox.removeChild(Box child) Removes a child box if it is indeed a child and adjusts the index of subsequent children.voidBox.setContainingBlock(Box containingBlock) voidvoidBlockBox.setStaticEquivalent(Box staticEquivalent) Method parameters in com.openhtmltopdf.render with type arguments of type BoxModifier and TypeMethodDescriptionvoidBox.addAllChildren(List<Box> children) voidInlineLayoutBox.addAllChildren(List<? super Box> list, Layer layer) voidLineBox.addAllChildren(List<? super Box> list, Layer layer) voidAdd a break opportunity.Box.ancestorsWhile(Predicate<Box> predicate) Creates a list of ancestors by walking up the chain of parent, grandparent, etc.protected voidBox.dumpBoxes(LayoutContext c, String indent, List<Box> boxes, int which, StringBuilder result) Box.findAncestor(Predicate<Box> predicate) Walks up the ancestor tree to the root testing ancestors agains the predicate.Constructors in com.openhtmltopdf.render with parameters of type Box -
Uses of Box in com.openhtmltopdf.render.displaylist
Methods in com.openhtmltopdf.render.displaylist that return BoxModifier and TypeMethodDescriptionPaintLayerBackgroundAndBorder.getMaster()PaintPopTransformLayer.getMaster()PaintPushTransformLayer.getMaster()PaintRootElementBackground.getRoot()Methods in com.openhtmltopdf.render.displaylist with parameters of type BoxModifier and TypeMethodDescriptionprotected voidDisplayListCollector.addTransformItem(Box master, List<PagedBoxCollector.PageInfo> pages, DisplayListContainer dlPages) voidPagedBoxCollector.collect(CssContext c, Layer layer, Box container, int shadowPageNumber) The main box collection method.voidPagedBoxCollector.collect(CssContext c, Layer layer, Box container, int pgStart, int pgEnd, int shadowPageNumber) static AffineTransformTransformCreator.createDocumentCoordinatesTransform(Box master, CssContext c, AffineTransform _parentCtm) Creates an absolute transform in document coordinates.static AffineTransformTransformCreator.createPageCoordinatesTranform(RenderingContext c, Box box, PageBox page, int shadowPageNumber) Creates a transform that can be applied to a page, either PDF or Java2D.static AffineTransformTransformCreator.createPageMarginCoordinatesTransform(RenderingContext c, Box box, PageBox page, int xTranslate, int yTranslate) static RectanglePagedBoxCollector.findAdjustedBoundsForBorderBox(CssContext c, Box container, List<PageBox> pages) Finds the document coordinates border box bounds of a box adjusted for transform and clipped according to overflow hidden.static RectanglePagedBoxCollector.findAdjustedBoundsForContentBox(CssContext c, Box container) Finds the document coordinates content box bounds of a box adjusted for transform and clipped according to overflow hidden.protected intPagedBoxCollector.findEndPage(CssContext c, Box container, AffineTransform transform) static intPagedBoxCollector.findEndPage(CssContext c, Box container, List<PageBox> pages) protected intPagedBoxCollector.findStartPage(CssContext c, Box container, AffineTransform transform) static intPagedBoxCollector.findStartPage(CssContext c, Box container, List<PageBox> pages) Constructors in com.openhtmltopdf.render.displaylist with parameters of type BoxModifierConstructorDescriptionPaintLayerBackgroundAndBorder(Box master) PaintPopTransformLayer(Box master) PaintPushTransformLayer(Box master, int shadowPage) -
Uses of Box in com.openhtmltopdf.render.simplepainter
Methods in com.openhtmltopdf.render.simplepainter with parameters of type BoxModifier and TypeMethodDescriptionvoidSimpleBoxCollector.collect(RenderingContext c, Layer layer, Box container) -
Uses of Box in com.openhtmltopdf.svgsupport
Methods in com.openhtmltopdf.svgsupport with parameters of type BoxModifier and TypeMethodDescriptionBatikSVGDrawer.buildSVGImage(Element svgElement, Box box, CssContext c, double cssWidth, double cssHeight, double dotsPerPixel) Constructors in com.openhtmltopdf.svgsupport with parameters of type BoxModifierConstructorDescriptionBatikSVGImage(Element svgElement, Box box, double cssWidth, double cssHeight, double cssMaxWidth, double cssMaxHeight, double dotsPerPixel, CssContext ctx) PDFTranscoder(Box box, double dotsPerPixel, double width, double height) -
Uses of Box in com.openhtmltopdf.util
Classes in com.openhtmltopdf.util that implement interfaces with type arguments of type BoxModifier and TypeClassDescriptionclassA spliterator that can be used to create a stream of descendant boxes in breadth first order.Methods in com.openhtmltopdf.util that return BoxModifier and TypeMethodDescriptionstatic BoxBoxUtil.getBodyBoxOrSomething(Box root) static BoxBoxUtil.getBodyOrNull(Box root) Looks at the direct children of root to find one with an element with node name body.Methods in com.openhtmltopdf.util that return types with arguments of type BoxModifier and TypeMethodDescriptionNull-safe way to look up the ancestor tree as a stream.LambdaUtil.descendants(Box parent) A stream of all descendant boxes not including InlineText or InlineBox objects.LambdaUtil.descendantsList(Box parent) DescendantBoxSpliterator.trySplit()Methods in com.openhtmltopdf.util with parameters of type BoxModifier and TypeMethodDescriptionstatic StringLambdaUtil.ancestorDump(Box bx) Ancestor dump to string including starting box and referenced layers.Null-safe way to look up the ancestor tree as a stream.static StringLambdaUtil.boxDescription(Box box) Null-safe box description including object id, layer, containing layer and impl class.static StringLambdaUtil.descendantDump(Box root) Creates an indented dump of the box tree.LambdaUtil.descendants(Box parent) A stream of all descendant boxes not including InlineText or InlineBox objects.LambdaUtil.descendantsList(Box parent) static BoxBoxUtil.getBodyBoxOrSomething(Box root) static BoxBoxUtil.getBodyOrNull(Box root) Looks at the direct children of root to find one with an element with node name body.Method parameters in com.openhtmltopdf.util with type arguments of type BoxModifier and TypeMethodDescriptionbooleanDescendantBoxSpliterator.tryAdvance(Consumer<? super Box> action) Constructors in com.openhtmltopdf.util with parameters of type Box