Package net.webpdf.wsclient.openapi

Class OperationToolboxOptionsOptions

java.lang.Object

net.webpdf.wsclient.openapi.OperationToolboxOptionsOptions

public class OperationToolboxOptionsOptions
extends Object

The options operation element can be used to change the way documents are displayed. **Tip:** For all hereby contained options, please consult the chapter \"Display Options\". This is especially important concerning the content format of headers and footers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationToolboxOptionsOptions.InitialViewEnum	Defines which sub-windows will be opened when the PDF document is opened
static class	OperationToolboxOptionsOptions.MagnificationEnum	Sets the zoom settings according to a defined mode
static class	OperationToolboxOptionsOptions.PageLayoutEnum	Sets the page layout when the PDF document is opened

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_BACKGROUND
static String	JSON_PROPERTY_BOXES
static String	JSON_PROPERTY_HEADER_FOOTER
static String	JSON_PROPERTY_INITIAL_PAGE
static String	JSON_PROPERTY_INITIAL_VIEW
static String	JSON_PROPERTY_LANGUAGE
static String	JSON_PROPERTY_MAGNIFICATION
static String	JSON_PROPERTY_MAGNIFICATION_ZOOM
static String	JSON_PROPERTY_PAGE_LAYOUT
static String	JSON_PROPERTY_PAGE_TRANSITIONS
static String	JSON_PROPERTY_VIEWER_PREFERENCES

Constructor Summary

Constructors

Constructor	Description
OperationToolboxOptionsOptions()

Method Summary

Modifier and Type	Method	Description
OperationToolboxOptionsOptions	background(OperationBackgroundToolboxOptions background)
OperationToolboxOptionsOptions	boxes(OperationBoxesToolboxOptions boxes)
boolean	equals(Object o)
@Nullable OperationBackgroundToolboxOptions	getBackground()	Get background
@Nullable OperationBoxesToolboxOptions	getBoxes()	Get boxes
@Nullable OperationHeaderFooterToolboxOptions	getHeaderFooter()	Get headerFooter
@Nullable Integer	getInitialPage()	Defines the page that will be shown when the document is opened.
@Nullable OperationToolboxOptionsOptions.InitialViewEnum	getInitialView()	Defines which sub-windows will be opened when the PDF document is opened
@Nullable String	getLanguage()	Specifies the language (and optionally the country) for the content of the document.
@Nullable OperationToolboxOptionsOptions.MagnificationEnum	getMagnification()	Sets the zoom settings according to a defined mode
@Nullable Integer	getMagnificationZoom()	Used to set the value for zooming.
@Nullable OperationToolboxOptionsOptions.PageLayoutEnum	getPageLayout()	Sets the page layout when the PDF document is opened
@Nullable OperationPageTransitionsToolboxOptions	getPageTransitions()	Get pageTransitions
@Nullable OperationViewerPreferences	getViewerPreferences()	Get viewerPreferences
int	hashCode()
OperationToolboxOptionsOptions	headerFooter(OperationHeaderFooterToolboxOptions headerFooter)
OperationToolboxOptionsOptions	initialPage(Integer initialPage)
OperationToolboxOptionsOptions	initialView(OperationToolboxOptionsOptions.InitialViewEnum initialView)
OperationToolboxOptionsOptions	language(String language)
OperationToolboxOptionsOptions	magnification(OperationToolboxOptionsOptions.MagnificationEnum magnification)
OperationToolboxOptionsOptions	magnificationZoom(Integer magnificationZoom)
OperationToolboxOptionsOptions	pageLayout(OperationToolboxOptionsOptions.PageLayoutEnum pageLayout)
OperationToolboxOptionsOptions	pageTransitions(OperationPageTransitionsToolboxOptions pageTransitions)
void	setBackground(OperationBackgroundToolboxOptions background)
void	setBoxes(OperationBoxesToolboxOptions boxes)
void	setHeaderFooter(OperationHeaderFooterToolboxOptions headerFooter)
void	setInitialPage(Integer initialPage)
void	setInitialView(OperationToolboxOptionsOptions.InitialViewEnum initialView)
void	setLanguage(String language)
void	setMagnification(OperationToolboxOptionsOptions.MagnificationEnum magnification)
void	setMagnificationZoom(Integer magnificationZoom)
void	setPageLayout(OperationToolboxOptionsOptions.PageLayoutEnum pageLayout)
void	setPageTransitions(OperationPageTransitionsToolboxOptions pageTransitions)
void	setViewerPreferences(OperationViewerPreferences viewerPreferences)
String	toString()
OperationToolboxOptionsOptions	viewerPreferences(OperationViewerPreferences viewerPreferences)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_BACKGROUND

public static final String JSON_PROPERTY_BACKGROUND

See Also:

Constant Field Values

JSON_PROPERTY_BOXES

public static final String JSON_PROPERTY_BOXES

See Also:

Constant Field Values

JSON_PROPERTY_HEADER_FOOTER

public static final String JSON_PROPERTY_HEADER_FOOTER

See Also:

Constant Field Values

JSON_PROPERTY_INITIAL_PAGE

public static final String JSON_PROPERTY_INITIAL_PAGE

See Also:

Constant Field Values

JSON_PROPERTY_INITIAL_VIEW

public static final String JSON_PROPERTY_INITIAL_VIEW

See Also:

Constant Field Values

JSON_PROPERTY_LANGUAGE

public static final String JSON_PROPERTY_LANGUAGE

See Also:

Constant Field Values

JSON_PROPERTY_MAGNIFICATION

public static final String JSON_PROPERTY_MAGNIFICATION

See Also:

Constant Field Values

JSON_PROPERTY_MAGNIFICATION_ZOOM

public static final String JSON_PROPERTY_MAGNIFICATION_ZOOM

See Also:

Constant Field Values

JSON_PROPERTY_PAGE_LAYOUT

public static final String JSON_PROPERTY_PAGE_LAYOUT

See Also:

Constant Field Values

JSON_PROPERTY_PAGE_TRANSITIONS

public static final String JSON_PROPERTY_PAGE_TRANSITIONS

See Also:

Constant Field Values

JSON_PROPERTY_VIEWER_PREFERENCES

public static final String JSON_PROPERTY_VIEWER_PREFERENCES

See Also:

Constant Field Values

Constructor Detail

OperationToolboxOptionsOptions

public OperationToolboxOptionsOptions()

Method Detail

background

public OperationToolboxOptionsOptions background(OperationBackgroundToolboxOptions background)

getBackground

@Nullable
public @Nullable OperationBackgroundToolboxOptions getBackground()

Get background

Returns:

background

setBackground

public void setBackground(OperationBackgroundToolboxOptions background)

boxes

public OperationToolboxOptionsOptions boxes(OperationBoxesToolboxOptions boxes)

getBoxes

@Nullable
public @Nullable OperationBoxesToolboxOptions getBoxes()

Get boxes

Returns:

boxes

setBoxes

public void setBoxes(OperationBoxesToolboxOptions boxes)

headerFooter

public OperationToolboxOptionsOptions headerFooter(OperationHeaderFooterToolboxOptions headerFooter)

getHeaderFooter

@Nullable
public @Nullable OperationHeaderFooterToolboxOptions getHeaderFooter()

Get headerFooter

Returns:

headerFooter

setHeaderFooter

public void setHeaderFooter(OperationHeaderFooterToolboxOptions headerFooter)

initialPage

public OperationToolboxOptionsOptions initialPage(Integer initialPage)

getInitialPage

@Nullable
public @Nullable Integer getInitialPage()

Defines the page that will be shown when the document is opened. minimum: 1

Returns:

initialPage

setInitialPage

public void setInitialPage(Integer initialPage)

initialView

public OperationToolboxOptionsOptions initialView(OperationToolboxOptionsOptions.InitialViewEnum initialView)

getInitialView

@Nullable
public @Nullable OperationToolboxOptionsOptions.InitialViewEnum getInitialView()

Defines which sub-windows will be opened when the PDF document is opened. * none = No special view * outlines = Opens the \"Bookmarks\" tab * thumbnails = Opens the \"Thumbnails\" tab * fullscreen = Opens the document in full screen mode

Returns:

initialView

setInitialView

public void setInitialView(OperationToolboxOptionsOptions.InitialViewEnum initialView)

language

public OperationToolboxOptionsOptions language(String language)

getLanguage

@Nullable
public @Nullable String getLanguage()

Specifies the language (and optionally the country) for the content of the document. The value is encoded as RFC 3066 (Tags for the Identification of Languages) and includes either the language only (e.g. \"de\") or the language and a country identifier (e.g. \"de-DE\").

Returns:

language

setLanguage

public void setLanguage(String language)

magnification

public OperationToolboxOptionsOptions magnification(OperationToolboxOptionsOptions.MagnificationEnum magnification)

getMagnification

@Nullable
public @Nullable OperationToolboxOptionsOptions.MagnificationEnum getMagnification()

Sets the zoom settings according to a defined mode. * none = Uses the application's default view * fitWidth = Page width * fitPage = Page dimensions * fitHeight = Page height * fitVisible = Page content width * fitActual = Uses the original page dimensions (100% zoom factor) * zoom = Sets an explicit magnification value

Returns:

magnification

setMagnification

public void setMagnification(OperationToolboxOptionsOptions.MagnificationEnum magnification)

magnificationZoom

public OperationToolboxOptionsOptions magnificationZoom(Integer magnificationZoom)

getMagnificationZoom

@Nullable
public @Nullable Integer getMagnificationZoom()

Used to set the value for zooming. minimum: 0 maximum: 6400

Returns:

magnificationZoom

setMagnificationZoom

public void setMagnificationZoom(Integer magnificationZoom)

pageLayout

public OperationToolboxOptionsOptions pageLayout(OperationToolboxOptionsOptions.PageLayoutEnum pageLayout)

getPageLayout

@Nullable
public @Nullable OperationToolboxOptionsOptions.PageLayoutEnum getPageLayout()

Sets the page layout when the PDF document is opened. * singlePage = Individual pages * singlePageContinous = Continuous individual pages * twoPages = double pages starting with odd pages * twoPagesRight = double pages starting with even pages * twoPagesContinous = continuous double pages starting with odd pages * twoPagesContinousRight = continuous double pages starting with even pages

Returns:

pageLayout

setPageLayout

public void setPageLayout(OperationToolboxOptionsOptions.PageLayoutEnum pageLayout)

pageTransitions

public OperationToolboxOptionsOptions pageTransitions(OperationPageTransitionsToolboxOptions pageTransitions)

getPageTransitions

@Nullable
public @Nullable OperationPageTransitionsToolboxOptions getPageTransitions()

Get pageTransitions

Returns:

pageTransitions

setPageTransitions

public void setPageTransitions(OperationPageTransitionsToolboxOptions pageTransitions)

viewerPreferences

public OperationToolboxOptionsOptions viewerPreferences(OperationViewerPreferences viewerPreferences)

getViewerPreferences

@Nullable
public @Nullable OperationViewerPreferences getViewerPreferences()

Get viewerPreferences

Returns:

viewerPreferences

setViewerPreferences

public void setViewerPreferences(OperationViewerPreferences viewerPreferences)

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