Record Class FixedPdfRenderer.Options

java.lang.Object

java.lang.Record

io.leandev.appfuse.pdf.FixedPdfRenderer.Options

Enclosing interface:

FixedPdfRenderer

public static record FixedPdfRenderer.Options(boolean overlayOnly, double offsetXmm, double offsetYmm, Clock clock, BooleanSupplier cancelled, IntConsumer onPage, FixedPdfRenderer.LayoutPolicy layoutPolicy)
extends Record

平移校準以 mm，作用於全部輸出元素；不更改紙張尺寸。overlayOnly 略過 STATIC 層。

Since:

4.0.0

Constructor Summary

Constructors

Constructor	Description
Options(boolean overlayOnly, double offsetXmm, double offsetYmm, Clock clock, BooleanSupplier cancelled)
Options(boolean overlayOnly, double offsetXmm, double offsetYmm, Clock clock, BooleanSupplier cancelled, IntConsumer onPage)
Options(boolean overlayOnly, double offsetXmm, double offsetYmm, Clock clock, BooleanSupplier cancelled, IntConsumer onPage, FixedPdfRenderer.LayoutPolicy layoutPolicy)	Creates an instance of a Options record class.

Method Summary

Modifier and Type	Method	Description
BooleanSupplier	cancelled()	Returns the value of the cancelled record component.
Clock	clock()	Returns the value of the clock record component.
static FixedPdfRenderer.Options	defaults()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
FixedPdfRenderer.LayoutPolicy	layoutPolicy()	Returns the value of the layoutPolicy record component.
FixedPdfRenderer.Options	layoutPolicy(FixedPdfRenderer.LayoutPolicy policy)	不縮字、不截斷、不移動元素；越頁內容可能被實體頁面裁切。
double	offsetXmm()	Returns the value of the offsetXmm record component.
double	offsetYmm()	Returns the value of the offsetYmm record component.
IntConsumer	onPage()	Returns the value of the onPage record component.
FixedPdfRenderer.Options	onPage(IntConsumer callback)	每完成一頁同步回呼；回呼失敗使本次產生失敗。
boolean	overlayOnly()	Returns the value of the overlayOnly record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Options

public Options(boolean overlayOnly,
 double offsetXmm,
 double offsetYmm,
 Clock clock,
 BooleanSupplier cancelled,
 IntConsumer onPage,
 FixedPdfRenderer.LayoutPolicy layoutPolicy)

Creates an instance of a Options record class.

Parameters:

overlayOnly - the value for the overlayOnly record component

offsetXmm - the value for the offsetXmm record component

offsetYmm - the value for the offsetYmm record component

clock - the value for the clock record component

cancelled - the value for the cancelled record component

onPage - the value for the onPage record component

layoutPolicy - the value for the layoutPolicy record component

Options

public Options(boolean overlayOnly,
 double offsetXmm,
 double offsetYmm,
 Clock clock,
 BooleanSupplier cancelled,
 IntConsumer onPage)

Options

public Options(boolean overlayOnly,
 double offsetXmm,
 double offsetYmm,
 Clock clock,
 BooleanSupplier cancelled)

Method Details

onPage

public FixedPdfRenderer.Options onPage(IntConsumer callback)

每完成一頁同步回呼；回呼失敗使本次產生失敗。

layoutPolicy

public FixedPdfRenderer.Options layoutPolicy(FixedPdfRenderer.LayoutPolicy policy)

不縮字、不截斷、不移動元素；越頁內容可能被實體頁面裁切。

defaults

public static FixedPdfRenderer.Options defaults()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

overlayOnly

public boolean overlayOnly()

Returns the value of the overlayOnly record component.

Returns:

the value of the overlayOnly record component

offsetXmm

public double offsetXmm()

Returns the value of the offsetXmm record component.

Returns:

the value of the offsetXmm record component

offsetYmm

public double offsetYmm()

Returns the value of the offsetYmm record component.

Returns:

the value of the offsetYmm record component

clock

public Clock clock()

Returns the value of the clock record component.

Returns:

the value of the clock record component

cancelled

public BooleanSupplier cancelled()

Returns the value of the cancelled record component.

Returns:

the value of the cancelled record component

onPage

public IntConsumer onPage()

Returns the value of the onPage record component.

Returns:

the value of the onPage record component

layoutPolicy

public FixedPdfRenderer.LayoutPolicy layoutPolicy()

Returns the value of the layoutPolicy record component.

Returns:

the value of the layoutPolicy record component