Package net.webpdf.wsclient.openapi

Class OperationFitRectangleDestinationFitRectangle

java.lang.Object

net.webpdf.wsclient.openapi.OperationFitRectangleDestinationFitRectangle

public class OperationFitRectangleDestinationFitRectangle
extends Object

The fitRectangle element is used to specify a location within the document. It will jump to a page in the document and set a zoom factor that will ensure, as far as possible, that a rectangle produced by the offsets from the page margins is displayed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationFitRectangleDestinationFitRectangle.MetricsEnum	Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_BOTTOM_OFFSET
static String	JSON_PROPERTY_LEFT_OFFSET
static String	JSON_PROPERTY_METRICS
static String	JSON_PROPERTY_PAGE
static String	JSON_PROPERTY_RIGHT_OFFSET
static String	JSON_PROPERTY_TOP_OFFSET

Constructor Summary

Constructors

Constructor	Description
OperationFitRectangleDestinationFitRectangle()

Method Summary

Modifier and Type	Method	Description
OperationFitRectangleDestinationFitRectangle	bottomOffset(Integer bottomOffset)
boolean	equals(Object o)
@Nullable Integer	getBottomOffset()	The area's offset from the bottom page margin.
@Nullable Integer	getLeftOffset()	The area's offset from the left page margin.
@Nullable OperationFitRectangleDestinationFitRectangle.MetricsEnum	getMetrics()	Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches
@Nullable Integer	getPage()	The document page to which the jump will be.
@Nullable Integer	getRightOffset()	The area's offset from the right page margin.
@Nullable Integer	getTopOffset()	The area's offset from the top page margin.
int	hashCode()
OperationFitRectangleDestinationFitRectangle	leftOffset(Integer leftOffset)
OperationFitRectangleDestinationFitRectangle	metrics(OperationFitRectangleDestinationFitRectangle.MetricsEnum metrics)
OperationFitRectangleDestinationFitRectangle	page(Integer page)
OperationFitRectangleDestinationFitRectangle	rightOffset(Integer rightOffset)
void	setBottomOffset(Integer bottomOffset)
void	setLeftOffset(Integer leftOffset)
void	setMetrics(OperationFitRectangleDestinationFitRectangle.MetricsEnum metrics)
void	setPage(Integer page)
void	setRightOffset(Integer rightOffset)
void	setTopOffset(Integer topOffset)
OperationFitRectangleDestinationFitRectangle	topOffset(Integer topOffset)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_BOTTOM_OFFSET

public static final String JSON_PROPERTY_BOTTOM_OFFSET

See Also:

Constant Field Values

JSON_PROPERTY_LEFT_OFFSET

public static final String JSON_PROPERTY_LEFT_OFFSET

See Also:

Constant Field Values

JSON_PROPERTY_METRICS

public static final String JSON_PROPERTY_METRICS

See Also:

Constant Field Values

JSON_PROPERTY_PAGE

public static final String JSON_PROPERTY_PAGE

See Also:

Constant Field Values

JSON_PROPERTY_RIGHT_OFFSET

public static final String JSON_PROPERTY_RIGHT_OFFSET

See Also:

Constant Field Values

JSON_PROPERTY_TOP_OFFSET

public static final String JSON_PROPERTY_TOP_OFFSET

See Also:

Constant Field Values

Constructor Detail

OperationFitRectangleDestinationFitRectangle

public OperationFitRectangleDestinationFitRectangle()

Method Detail

bottomOffset

public OperationFitRectangleDestinationFitRectangle bottomOffset(Integer bottomOffset)

getBottomOffset

@Nullable
public @Nullable Integer getBottomOffset()

The area's offset from the bottom page margin.

Returns:

bottomOffset

setBottomOffset

public void setBottomOffset(Integer bottomOffset)

leftOffset

public OperationFitRectangleDestinationFitRectangle leftOffset(Integer leftOffset)

getLeftOffset

@Nullable
public @Nullable Integer getLeftOffset()

The area's offset from the left page margin.

Returns:

leftOffset

setLeftOffset

public void setLeftOffset(Integer leftOffset)

metrics

public OperationFitRectangleDestinationFitRectangle metrics(OperationFitRectangleDestinationFitRectangle.MetricsEnum metrics)

getMetrics

@Nullable
public @Nullable OperationFitRectangleDestinationFitRectangle.MetricsEnum getMetrics()

Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches

Returns:

metrics

setMetrics

public void setMetrics(OperationFitRectangleDestinationFitRectangle.MetricsEnum metrics)

page

public OperationFitRectangleDestinationFitRectangle page(Integer page)

getPage

@Nullable
public @Nullable Integer getPage()

The document page to which the jump will be. minimum: 1

Returns:

page

setPage

public void setPage(Integer page)

rightOffset

public OperationFitRectangleDestinationFitRectangle rightOffset(Integer rightOffset)

getRightOffset

@Nullable
public @Nullable Integer getRightOffset()

The area's offset from the right page margin.

Returns:

rightOffset

setRightOffset

public void setRightOffset(Integer rightOffset)

topOffset

public OperationFitRectangleDestinationFitRectangle topOffset(Integer topOffset)

getTopOffset

@Nullable
public @Nullable Integer getTopOffset()

The area's offset from the top page margin.

Returns:

topOffset

setTopOffset

public void setTopOffset(Integer topOffset)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object