Package net.webpdf.wsclient.openapi
Class OperationToolboxMoveMove
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationToolboxMoveMove
-
public class OperationToolboxMoveMove extends Object
The move operation element can be used to change the order of the document's pages.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationToolboxMoveMove.ModeEnumUsed to specify whether the selected page range should be inserted before or after the selected position in the documentstatic classOperationToolboxMoveMove.OrderEnumUsed to select the order of the selected pages at the new position
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_MODEstatic StringJSON_PROPERTY_ORDERstatic StringJSON_PROPERTY_PAGESstatic StringJSON_PROPERTY_TARGET_POSITION
-
Constructor Summary
Constructors Constructor Description OperationToolboxMoveMove()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)@Nullable OperationToolboxMoveMove.ModeEnumgetMode()Used to specify whether the selected page range should be inserted before or after the selected position in the document@Nullable OperationToolboxMoveMove.OrderEnumgetOrder()Used to select the order of the selected pages at the new position@Nullable StringgetPages()Used to define which page(s) should be moved.@Nullable IntegergetTargetPosition()Used to select the page number after or before which the selected page range should be inserted.inthashCode()OperationToolboxMoveMovemode(OperationToolboxMoveMove.ModeEnum mode)OperationToolboxMoveMoveorder(OperationToolboxMoveMove.OrderEnum order)OperationToolboxMoveMovepages(String pages)voidsetMode(OperationToolboxMoveMove.ModeEnum mode)voidsetOrder(OperationToolboxMoveMove.OrderEnum order)voidsetPages(String pages)voidsetTargetPosition(Integer targetPosition)OperationToolboxMoveMovetargetPosition(Integer targetPosition)StringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_MODE
public static final String JSON_PROPERTY_MODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ORDER
public static final String JSON_PROPERTY_ORDER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAGES
public static final String JSON_PROPERTY_PAGES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TARGET_POSITION
public static final String JSON_PROPERTY_TARGET_POSITION
- See Also:
- Constant Field Values
-
-
Method Detail
-
mode
public OperationToolboxMoveMove mode(OperationToolboxMoveMove.ModeEnum mode)
-
getMode
@Nullable public @Nullable OperationToolboxMoveMove.ModeEnum getMode()
Used to specify whether the selected page range should be inserted before or after the selected position in the document. * afterPage = After the selected position. * beforePage = Before the selected position.- Returns:
- mode
-
setMode
public void setMode(OperationToolboxMoveMove.ModeEnum mode)
-
order
public OperationToolboxMoveMove order(OperationToolboxMoveMove.OrderEnum order)
-
getOrder
@Nullable public @Nullable OperationToolboxMoveMove.OrderEnum getOrder()
Used to select the order of the selected pages at the new position. * preserve = Keeps the original order in which the pages were found in the document. * reverse = Reverses the original order in which the pages were found in the document.- Returns:
- order
-
setOrder
public void setOrder(OperationToolboxMoveMove.OrderEnum order)
-
pages
public OperationToolboxMoveMove pages(String pages)
-
getPages
@Nullable public @Nullable String getPages()
Used to define which page(s) should be moved. The page number can be an individual page, a page range, or a list (separated with commas) (e.g., \"1,5-6,9\").- Returns:
- pages
-
setPages
public void setPages(String pages)
-
targetPosition
public OperationToolboxMoveMove targetPosition(Integer targetPosition)
-
getTargetPosition
@Nullable public @Nullable Integer getTargetPosition()
Used to select the page number after or before which the selected page range should be inserted. This page must not be part of the page range being moved. minimum: 1- Returns:
- targetPosition
-
setTargetPosition
public void setTargetPosition(Integer targetPosition)
-
-