Package com.helger.pdflayout.base
Interface IPLVisitor
-
public interface IPLVisitorVisitor callback- Author:
- Philip Helger
-
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static IPLVisitorcreateElementVisitor(com.helger.commons.functional.IThrowingFunction<? super IPLRenderableObject<?>,com.helger.commons.state.EChange,IOException> aElementConsumer)Special visitor method that visits only elements of this objects and ignores the others objects.default com.helger.commons.state.EChangeonElement(IPLRenderableObject<?> aElement)Call for each element in the current page set.default voidonPageSetEnd(PLPageSet aPageSet)Call on page set enddefault voidonPageSetStart(PLPageSet aPageSet)Call on page set start
-
-
-
Method Detail
-
onPageSetStart
default void onPageSetStart(@Nonnull PLPageSet aPageSet) throws IOException
Call on page set start- Parameters:
aPageSet- The current page set. Nevernull.- Throws:
IOException- on PDFBox error
-
onElement
@Nonnull default com.helger.commons.state.EChange onElement(@Nonnull IPLRenderableObject<?> aElement) throws IOException
Call for each element in the current page set. This method is also called for page set header and footer elements.- Parameters:
aElement- The current element. Nevernull.- Returns:
EChange.CHANGEDif the object was modified.- Throws:
IOException- on PDFBox error
-
onPageSetEnd
default void onPageSetEnd(@Nonnull PLPageSet aPageSet) throws IOException
Call on page set end- Parameters:
aPageSet- The current page set.- Throws:
IOException- on PDFBox error
-
createElementVisitor
@Nonnull static IPLVisitor createElementVisitor(@Nonnull com.helger.commons.functional.IThrowingFunction<? super IPLRenderableObject<?>,com.helger.commons.state.EChange,IOException> aElementConsumer)
Special visitor method that visits only elements of this objects and ignores the others objects.- Parameters:
aElementConsumer- The consumer to use. May not benull.- Returns:
- The new element visitor to use
-
-