Package net.webpdf.wsclient.openapi
Class OperationScalePagesToolboxScale
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationScalePagesToolboxScale
-
public class OperationScalePagesToolboxScale extends Object
Used to define page scaling operations.
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_DIMENSIONSstatic StringJSON_PROPERTY_HORIZONTAL_ALIGNMENTstatic StringJSON_PROPERTY_PAGESstatic StringJSON_PROPERTY_PRESERVE_ASPECT_RATIOstatic StringJSON_PROPERTY_SCALE_BOXESstatic StringJSON_PROPERTY_VERTICAL_ALIGNMENT
-
Constructor Summary
Constructors Constructor Description OperationScalePagesToolboxScale()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationScalePagesToolboxScaledimensions(OperationPaddedRectangle dimensions)booleanequals(Object o)@Nullable OperationPaddedRectanglegetDimensions()Get dimensions@Nullable StringgetHorizontalAlignment()If margins are created when the page is scaled or if the page content must be positioned relative to a context (for example, the crop box), this value specifies how margins are to be split and how overall page content is to be positioned on the page@Nullable StringgetPages()Specifies which page(s) should be scaled.@Nullable BooleangetPreserveAspectRatio()Specifies whether the ratio of the page dimensions to each other should be maintained when scaling the page.@Nullable BooleangetScaleBoxes()Specifies whether the scaling of the page should also affect the boxes (Mediabox, Cropbox, etc.) of a page.@Nullable StringgetVerticalAlignment()If margins are created when the page is scaled or if the page content must be positioned relative to a context (for example, the crop box), this value specifies how margins are to be split and how overall page content is to be positioned on the pageinthashCode()OperationScalePagesToolboxScalehorizontalAlignment(String horizontalAlignment)OperationScalePagesToolboxScalepages(String pages)OperationScalePagesToolboxScalepreserveAspectRatio(Boolean preserveAspectRatio)OperationScalePagesToolboxScalescaleBoxes(Boolean scaleBoxes)voidsetDimensions(OperationPaddedRectangle dimensions)voidsetHorizontalAlignment(String horizontalAlignment)voidsetPages(String pages)voidsetPreserveAspectRatio(Boolean preserveAspectRatio)voidsetScaleBoxes(Boolean scaleBoxes)voidsetVerticalAlignment(String verticalAlignment)StringtoString()OperationScalePagesToolboxScaleverticalAlignment(String verticalAlignment)
-
-
-
Field Detail
-
JSON_PROPERTY_DIMENSIONS
public static final String JSON_PROPERTY_DIMENSIONS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_HORIZONTAL_ALIGNMENT
public static final String JSON_PROPERTY_HORIZONTAL_ALIGNMENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAGES
public static final String JSON_PROPERTY_PAGES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRESERVE_ASPECT_RATIO
public static final String JSON_PROPERTY_PRESERVE_ASPECT_RATIO
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SCALE_BOXES
public static final String JSON_PROPERTY_SCALE_BOXES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VERTICAL_ALIGNMENT
public static final String JSON_PROPERTY_VERTICAL_ALIGNMENT
- See Also:
- Constant Field Values
-
-
Method Detail
-
dimensions
public OperationScalePagesToolboxScale dimensions(OperationPaddedRectangle dimensions)
-
getDimensions
@Nullable public @Nullable OperationPaddedRectangle getDimensions()
Get dimensions- Returns:
- dimensions
-
setDimensions
public void setDimensions(OperationPaddedRectangle dimensions)
-
horizontalAlignment
public OperationScalePagesToolboxScale horizontalAlignment(String horizontalAlignment)
-
getHorizontalAlignment
@Nullable public @Nullable String getHorizontalAlignment()
If margins are created when the page is scaled or if the page content must be positioned relative to a context (for example, the crop box), this value specifies how margins are to be split and how overall page content is to be positioned on the page. * left = Contents are to be arranged left-justified. * center = Content should be centered. * right = Contents should be arranged right-justified.- Returns:
- horizontalAlignment
-
setHorizontalAlignment
public void setHorizontalAlignment(String horizontalAlignment)
-
pages
public OperationScalePagesToolboxScale pages(String pages)
-
getPages
@Nullable public @Nullable String getPages()
Specifies which page(s) should be scaled. The page number can be either a single page, a range of pages or a list (separated by commas) (e.g. \"1.5-6.9\"). The specification of all pages is done with \"\\*\".- Returns:
- pages
-
setPages
public void setPages(String pages)
-
preserveAspectRatio
public OperationScalePagesToolboxScale preserveAspectRatio(Boolean preserveAspectRatio)
-
getPreserveAspectRatio
@Nullable public @Nullable Boolean getPreserveAspectRatio()
Specifies whether the ratio of the page dimensions to each other should be maintained when scaling the page. This may result in deviations from the given target height or width (depending on requirements).- Returns:
- preserveAspectRatio
-
setPreserveAspectRatio
public void setPreserveAspectRatio(Boolean preserveAspectRatio)
-
scaleBoxes
public OperationScalePagesToolboxScale scaleBoxes(Boolean scaleBoxes)
-
getScaleBoxes
@Nullable public @Nullable Boolean getScaleBoxes()
Specifies whether the scaling of the page should also affect the boxes (Mediabox, Cropbox, etc.) of a page. If this is not the case (false), the actual page dimensions, crop boxes, etc. remain as they were originally and only page contents are scaled. The content can become much smaller or larger than the containing page in this way, which can lead to either large blank areas or overflow of the page content.- Returns:
- scaleBoxes
-
setScaleBoxes
public void setScaleBoxes(Boolean scaleBoxes)
-
verticalAlignment
public OperationScalePagesToolboxScale verticalAlignment(String verticalAlignment)
-
getVerticalAlignment
@Nullable public @Nullable String getVerticalAlignment()
If margins are created when the page is scaled or if the page content must be positioned relative to a context (for example, the crop box), this value specifies how margins are to be split and how overall page content is to be positioned on the page. * top = Content should be positioned at the top of the page. * center = Content should be centered. * bottom = content should be positioned at the bottom.- Returns:
- verticalAlignment
-
setVerticalAlignment
public void setVerticalAlignment(String verticalAlignment)
-
-