PrintSetAdvanced (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.prefs.PrintSetAdvanced

```
public class PrintSetAdvanced
extends BaseManager
```
This class manages the settings for the advanced print mode of a print set.

See Also:
PrintSet.getPrintSetAdvanced(), PrintSet.getPrintMode()

Nested Class Summary
- Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager
  BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FIELD_ALIGNMENT_OPTION_CENTER`
`static int`	`FIELD_ALIGNMENT_OPTION_LEFT`
`static int`	`FIELD_ALIGNMENT_OPTION_RIGHT`
`static int`	`FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_ABOVE_THUMBNAIL`
`static int`	`FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_BELOW_THUMBNAIL`
`static int`	`FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_RIGHT_OF_THUMBNAIL`
`static int`	`IMAGE_SOURCE_OPTION_ENTIRE_ASSET`
`static int`	`IMAGE_SOURCE_OPTION_THUMBNAIL`
`static int`	`THUMBNAILS_ALIGNMENT_OPTION_CENTER`
`static int`	`THUMBNAILS_ALIGNMENT_OPTION_EAST`
`static int`	`THUMBNAILS_ALIGNMENT_OPTION_NORTH`
`static int`	`THUMBNAILS_ALIGNMENT_OPTION_NORTH_EAST`
`static int`	`THUMBNAILS_ALIGNMENT_OPTION_NORTH_WEST`
`static int`	`THUMBNAILS_ALIGNMENT_OPTION_SOUTH`
`static int`	`THUMBNAILS_ALIGNMENT_OPTION_SOUTH_EAST`
`static int`	`THUMBNAILS_ALIGNMENT_OPTION_SOUTH_WEST`
`static int`	`THUMBNAILS_ALIGNMENT_OPTION_WEST`

Fields inherited from class com.canto.cumulus.prefs.BaseManager
TYPE_EJP, TYPE_NATIVE

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allowPDFWPPICPGuestLogin()` Returns whether the generated WPP/ICP links use an automatic guest login or direct the caller to the login page of the WPP/ICP installation.
`boolean`	`drawFieldNames()` Returns whether field names should be printed as well.
`boolean`	`drawRecordFrame()` Returns whether a border should be painted around the entire record cell.
`boolean`	`drawThumbnailFrame()` Returns whether a border should be drawn around the thumbnail area.
`java.lang.String`	`getAppliedAssetAction()` Returns the name of the asset action to apply on printed thumbnails.
`int`	`getFieldAlignment()` Returns the mode for aligning the field content.
`int`	`getFieldBackgroundColor()` Returns the RGB value representing the background color for the fields content area in the default sRGB `ColorModel`.
`double`	`getFieldsMarginToFrame()` Returns the margin between the fields area border and the fields itself.
`double`	`getFieldSpacing()` Return the spacing between the printed fields.
`int`	`getFieldToThumbnailAlignment()` Returns the alignment of fields to the thumbnail image.
`PrintSetDocumentStore`	`getFooter72()` Returns the footer structure representing the footer configuration.
`int`	`getGridColumns()` Returns the number of columns for the record grid.
`int`	`getGridRows()` Returns the number of rows for the record grid.
`PrintSetDocumentStore`	`getHeader72()` Returns the header structure representing the header configuration.
`int`	`getImageSource()` Returns the source being used for printing the thumbnail image.
`double`	`getInnerMarginsHorizontal()` Returns the horizontal space between two cells of the grid.
`double`	`getInnerMarginsVertical()` Returns the vertical space between two cells of the grid.
`int`	`getJPEGQuality()` Returns the JPEG quality being used when creating asset previews.
`double`	`getOuterMarginsBottom()` Returns the outer grid margins for the bottom of the page.
`double`	`getOuterMarginsLeft()` Returns the outer grid margins for the left border.
`double`	`getOuterMarginsRight()` Returns the outer grid margins for the right border.
`double`	`getOuterMarginsTop()` Returns the outer grid margins for the top of the page.
`int`	`getPageBackgroundColor()` Returns the RGB value representing the background color for the entire page in the default sRGB `ColorModel`.
`java.lang.String`	`getPDFDocumentOwnerPassword()` Returns the PDF document owner password.
`boolean`	`getPDFEmbedAnnotations()` Returns whether the PDF should embed user comments as annotations.
`java.lang.String`	`getPDFOpenDocumentPassword()` Returns the password to open the PDF document.
`int`	`getPDFSecurity()` Returns the PDF security settings encoded into an int.
`URLMode`	`getPDFURLMode()` Returns the configured URL Mode when printing to PDF and embedding URLs.
`java.lang.String`	`getPDFWPPICPBaseURL()` Returns the base installation URL for the WPP/ICP installation.
`RecordFieldList`	`getRecordFieldList()` Returns the list of fields to print in advanced mode.
`int`	`getThumbnailAlignment()` Returns the alignment of the thumbnail within the entire area available for the thumbnail.
`int`	`getThumbnailBackgroundColor()` Returns the RGB value representing the background color for the thumbnail area in the default sRGB `ColorModel`.
`double`	`getThumbnailMarginToFields()` Returns the margin between thumbnail area and the field values.
`double`	`getThumbnailMarginToFrame()` Returns the margin between the thumbnail area border and the thumbnail itself.
`int`	`getThumbnailResolution()` Returns the resolution to use for generating asset previews.
`boolean`	`isApplyAssetActionOnThumbnailEnabled()` Returns whether this print sets applies an asset action on the printed thumbnail.
`boolean`	`isEditPDFSettingsWhenPrintingEnabled()` Returns whether this print sets PDF options can be edited when printing.
`boolean`	`isPDFEnabled()` Returns whether this print set can be used to print PDFs.
`boolean`	`isPDFSecurityEnabled()` Returns whether security options should be set when printing the PDF.
`boolean`	`isPDFWPPICPEnabled()` Returns whether thumbnails should be linked to their records in a WPP/ICP installation.
`boolean`	`pdfAllowContentCopyingAndExtractionAlsoForScreenReaders()` Returns whether the PDF document should allow content copying and extraction.
`boolean`	`pdfAllowDegradedPrinting()` Returns whether printing the PDF in low resolution is allowed.
`boolean`	`pdfAllowDocumentAssembly()` Returns whether the PDF document should allow document assembly.
`boolean`	`pdfAllowDocumentChanges()` Returns whether PDF document changes are allowed.
`boolean`	`pdfAllowFillIn()` Returns whether the PDF document should allow to fill in forms and sign the document.
`boolean`	`pdfAllowModifyAnnotations()` Returns whether PDF document annotation changes are allowed.
`boolean`	`pdfAllowPrinting()` Returns whether printing the PDF in high resolution is allowed.
`boolean`	`pdfAllowScreenReaders()` Returns whether the PDF document should allow content copying and extraction for screen readers.
`void`	`setAppliedAssetAction(java.lang.String value)` Sets the name of the asset action to apply on printed thumbnails.
`void`	`setApplyAssetActionOnThumbnail(boolean value)` Configures whether this print sets applies an asset action on the printed thumbnail.
`void`	`setDrawFieldNames(boolean draw)` Configures whether field names should be printed as well.
`void`	`setDrawRecordFrame(boolean value)` Configures whether a border should be painted around the entire record cell.
`void`	`setDrawThumbnailFrame(boolean value)` Configures whether a border should be drawn around the thumbnail area.
`void`	`setEditPDFSettingsWhenPrintingEnabled(boolean value)` Configures whether this print sets PDF options can be edited when printing.
`void`	`setFieldAlignment(int alignment)` Sets the mode for aligning the field content.
`void`	`setFieldBackgroundColor(int color)` Sets the background color for the fields content area as RGB value representing the color.
`void`	`setFieldsMarginToFrame(double value)` Sets the margin between the fields area border and the fields itself.
`void`	`setFieldSpacing(double spacing)` Sets the spacing between the printed fields.
`void`	`setFieldToThumbnailAlignment(int align)` Configures the alignment of fields to the thumbnail image.
`PrintSetDocumentStore`	`setFooter72()` This returns an empty footer structure which replaced the original one and can now be filled by the caller with the new footer information.
`void`	`setGridColumns(int cols)` Sets the number of columns for the record grid.
`void`	`setGridRows(int rows)` Sets the number of rows for the record grid.
`PrintSetDocumentStore`	`setHeader72()` This returns an empty header structure which replaced the original one and can now be filled by the caller with the new header information.
`void`	`setImageSource(int source)` Sets the source being used for printing the thumbnail image.
`void`	`setInnerMarginsHorizontal(double margin)` Sets the horizontal space between two cells of the grid.
`void`	`setInnerMarginsVertical(double margin)` Sets the vertical space between two cells of the grid.
`void`	`setJPEGQuality(int quality)` Sets the JPEG quality being used when creating asset previews.
`void`	`setOuterMarginsBottom(double margin)` Sets the outer grid margins for the bottom of the page.
`void`	`setOuterMarginsLeft(double margin)` Sets the outer grid margins for the left border.
`void`	`setOuterMarginsRight(double margin)` Sets the outer grid margins for the right border.
`void`	`setOuterMarginsTop(double margin)` Sets the outer grid margins for the top of the page.
`void`	`setPageBackgroundColor(int color)` Sets the background color for the entire page as RGB value representing the color.
`void`	`setPDFAllowContentCopyingAndExtractionAlsoForScreenReaders(boolean value)` Sets whether the PDF document should allow content copying and extraction.
`void`	`setPDFAllowDegradedPrinting(boolean value)` Sets whether printing the PDF in low resolution is allowed.
`void`	`setPDFAllowDocumentAssembly(boolean value)` Sets whether the PDF document should allow document assembly.
`void`	`setPDFAllowDocumentChanges(boolean value)` Configures whether PDF document changes are allowed.
`void`	`setPDFAllowFillIn(boolean value)` Sets whether the PDF document should allow to fill in forms and sign the document.
`void`	`setPDFAllowModifyAnnotations(boolean value)` Sets whether PDF document annotation changes are allowed.
`void`	`setPDFAllowPrinting(boolean value)` Sets whether printing the PDF in high resolution is allowed.
`void`	`setPDFAllowScreenReaders(boolean value)` Sets whether the PDF document should allow content copying and extraction for screen readers.
`void`	`setPDFDocumentOwnerPassword(java.lang.String value)` Sets the PDF document owner password.
`void`	`setPDFEmbedAnnotations(boolean value)` Specify whether the PDF should embed user comments as annotations.
`void`	`setPDFEnabled(boolean value)` Configures whether this print set can be used to print PDFs.
`void`	`setPDFOpenDocumentPassword(java.lang.String value)` Sets the password to open the PDF document.
`void`	`setPDFSecurityEnabled(boolean value)` Sets whether security options should be set when printing the PDF.
`void`	`setPDFURLMode(URLMode urlMode)` Configures the URL Mode when printing to PDF and embedding URLs.
`void`	`setPDFWPPICPBaseURL(java.lang.String url)` Sets the base installation URL for the WPP/ICP installation.
`void`	`setPDFWPPICPEnabled(boolean value)` Sets whether thumbnails should be linked to their records in a WPP/ICP installation.
`void`	`setPDFWPPICPGuestLogin(boolean value)` Configures whether the generated WPP/ICP links should use an automatic guest login or direct the caller to the login page of the WPP/ICP installation.
`void`	`setThumbnailAlignment(int alignment)` Configures the alignment of the thumbnail within the entire area available for the thumbnail.
`void`	`setThumbnailBackgroundColor(int color)` Sets the background color for the thumbnail area as RGB value representing the color.
`void`	`setThumbnailMarginToFields(double value)` Sets the margin between thumbnail area and the field values.
`void`	`setThumbnailMarginToFrame(double value)` Sets the margin between the thumbnail area border and the thumbnail itself.
`void`	`setThumbnailResolution(int value)` Sets the resolution to use for generating asset previews.
`boolean`	`supportsHeaderFooter72()` Returns whether header and footer are available in the new 7.5 format which is interchangeable between different platforms.

Methods inherited from class com.canto.cumulus.prefs.BaseManager
addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - THUMBNAILS_ALIGNMENT_OPTION_NORTH_WEST
```
public static final int THUMBNAILS_ALIGNMENT_OPTION_NORTH_WEST
```
    See Also:
    Constant Field Values
  - THUMBNAILS_ALIGNMENT_OPTION_NORTH
```
public static final int THUMBNAILS_ALIGNMENT_OPTION_NORTH
```
    See Also:
    Constant Field Values
  - THUMBNAILS_ALIGNMENT_OPTION_NORTH_EAST
```
public static final int THUMBNAILS_ALIGNMENT_OPTION_NORTH_EAST
```
    See Also:
    Constant Field Values
  - THUMBNAILS_ALIGNMENT_OPTION_WEST
```
public static final int THUMBNAILS_ALIGNMENT_OPTION_WEST
```
    See Also:
    Constant Field Values
  - THUMBNAILS_ALIGNMENT_OPTION_CENTER
```
public static final int THUMBNAILS_ALIGNMENT_OPTION_CENTER
```
    See Also:
    Constant Field Values
  - THUMBNAILS_ALIGNMENT_OPTION_EAST
```
public static final int THUMBNAILS_ALIGNMENT_OPTION_EAST
```
    See Also:
    Constant Field Values
  - THUMBNAILS_ALIGNMENT_OPTION_SOUTH_WEST
```
public static final int THUMBNAILS_ALIGNMENT_OPTION_SOUTH_WEST
```
    See Also:
    Constant Field Values
  - THUMBNAILS_ALIGNMENT_OPTION_SOUTH
```
public static final int THUMBNAILS_ALIGNMENT_OPTION_SOUTH
```
    See Also:
    Constant Field Values
  - THUMBNAILS_ALIGNMENT_OPTION_SOUTH_EAST
```
public static final int THUMBNAILS_ALIGNMENT_OPTION_SOUTH_EAST
```
    See Also:
    Constant Field Values
  - FIELD_ALIGNMENT_OPTION_LEFT
```
public static final int FIELD_ALIGNMENT_OPTION_LEFT
```
    See Also:
    Constant Field Values
  - FIELD_ALIGNMENT_OPTION_CENTER
```
public static final int FIELD_ALIGNMENT_OPTION_CENTER
```
    See Also:
    Constant Field Values
  - FIELD_ALIGNMENT_OPTION_RIGHT
```
public static final int FIELD_ALIGNMENT_OPTION_RIGHT
```
    See Also:
    Constant Field Values
  - FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_RIGHT_OF_THUMBNAIL
```
public static final int FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_RIGHT_OF_THUMBNAIL
```
    See Also:
    Constant Field Values
  - FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_BELOW_THUMBNAIL
```
public static final int FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_BELOW_THUMBNAIL
```
    See Also:
    Constant Field Values
  - FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_ABOVE_THUMBNAIL
```
public static final int FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_ABOVE_THUMBNAIL
```
    See Also:
    Constant Field Values
  - IMAGE_SOURCE_OPTION_THUMBNAIL
```
public static final int IMAGE_SOURCE_OPTION_THUMBNAIL
```
    See Also:
    Constant Field Values
  - IMAGE_SOURCE_OPTION_ENTIRE_ASSET
```
public static final int IMAGE_SOURCE_OPTION_ENTIRE_ASSET
```
    See Also:
    Constant Field Values
- Method Detail
  - getGridRows
```
public int getGridRows()
```
    Returns the number of rows for the record grid.
    
    Returns:
    number of rows
  - setGridRows
```
public void setGridRows(int rows)
```
    Sets the number of rows for the record grid.
    
    Parameters:
    rows - number of rows
  - getGridColumns
```
public int getGridColumns()
```
    Returns the number of columns for the record grid.
    
    Returns:
    number of columns
  - setGridColumns
```
public void setGridColumns(int cols)
```
    Sets the number of columns for the record grid.
    
    Parameters:
    cols - number of columns
  - getOuterMarginsTop
```
public double getOuterMarginsTop()
```
    Returns the outer grid margins for the top of the page.
    
    Returns:
    top outer grid margins in mm
  - setOuterMarginsTop
```
public void setOuterMarginsTop(double margin)
```
    Sets the outer grid margins for the top of the page.
    
    Parameters:
    margin - top outer grid margins in mm
  - getOuterMarginsLeft
```
public double getOuterMarginsLeft()
```
    Returns the outer grid margins for the left border.
    
    Returns:
    left outer grid margins in mm
  - setOuterMarginsLeft
```
public void setOuterMarginsLeft(double margin)
```
    Sets the outer grid margins for the left border.
    
    Parameters:
    margin - left outer grid margins in mm
  - getOuterMarginsBottom
```
public double getOuterMarginsBottom()
```
    Returns the outer grid margins for the bottom of the page.
    
    Returns:
    bottom outer grid margins in mm
  - setOuterMarginsBottom
```
public void setOuterMarginsBottom(double margin)
```
    Sets the outer grid margins for the bottom of the page.
    
    Parameters:
    margin - bottom outer grid margins in mm
  - getOuterMarginsRight
```
public double getOuterMarginsRight()
```
    Returns the outer grid margins for the right border.
    
    Returns:
    right outer grid margins in mm
  - setOuterMarginsRight
```
public void setOuterMarginsRight(double margin)
```
    Sets the outer grid margins for the right border.
    
    Parameters:
    margin - right outer grid margins in mm
  - getInnerMarginsHorizontal
```
public double getInnerMarginsHorizontal()
```
    Returns the horizontal space between two cells of the grid.
    
    Returns:
    horizontal space between two cells in mm
  - setInnerMarginsHorizontal
```
public void setInnerMarginsHorizontal(double margin)
```
    Sets the horizontal space between two cells of the grid.
    
    Parameters:
    margin - horizontal space between two cells in mm
  - getInnerMarginsVertical
```
public double getInnerMarginsVertical()
```
    Returns the vertical space between two cells of the grid.
    
    Returns:
    vertical space between two cells in mm
  - setInnerMarginsVertical
```
public void setInnerMarginsVertical(double margin)
```
    Sets the vertical space between two cells of the grid.
    
    Parameters:
    margin - vertical space between two cells in mm
  - getThumbnailAlignment
```
public int getThumbnailAlignment()
```
    Returns the alignment of the thumbnail within the entire area available for the thumbnail. The possible values are THUMBNAILS_ALIGNMENT_OPTION_CENTER, THUMBNAILS_ALIGNMENT_OPTION_EAST, THUMBNAILS_ALIGNMENT_OPTION_NORTH, THUMBNAILS_ALIGNMENT_OPTION_NORTH_EAST, THUMBNAILS_ALIGNMENT_OPTION_NORTH_WEST, THUMBNAILS_ALIGNMENT_OPTION_SOUTH, THUMBNAILS_ALIGNMENT_OPTION_SOUTH_EAST, THUMBNAILS_ALIGNMENT_OPTION_SOUTH_WEST and THUMBNAILS_ALIGNMENT_OPTION_WEST. Defaults to THUMBNAILS_ALIGNMENT_OPTION_CENTER.
    
    Returns:
    thumbnail alignment
  - setThumbnailAlignment
```
public void setThumbnailAlignment(int alignment)
```
    Configures the alignment of the thumbnail within the entire area available for the thumbnail. The possible values are THUMBNAILS_ALIGNMENT_OPTION_CENTER, THUMBNAILS_ALIGNMENT_OPTION_EAST, THUMBNAILS_ALIGNMENT_OPTION_NORTH, THUMBNAILS_ALIGNMENT_OPTION_NORTH_EAST, THUMBNAILS_ALIGNMENT_OPTION_NORTH_WEST, THUMBNAILS_ALIGNMENT_OPTION_SOUTH, THUMBNAILS_ALIGNMENT_OPTION_SOUTH_EAST, THUMBNAILS_ALIGNMENT_OPTION_SOUTH_WEST and THUMBNAILS_ALIGNMENT_OPTION_WEST.
    
    Parameters:
    alignment - thumbnail alignment
  - getThumbnailBackgroundColor
```
public int getThumbnailBackgroundColor()
```
    Returns the RGB value representing the background color for the thumbnail area in the default sRGB ColorModel. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
    
    Returns:
    the RGB value of the color in the default sRGB ColorModel.
  - setThumbnailBackgroundColor
```
public void setThumbnailBackgroundColor(int color)
```
    Sets the background color for the thumbnail area as RGB value representing the color. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
    
    Parameters:
    color - the combined RGB components
  - getThumbnailResolution
```
public int getThumbnailResolution()
```
    Returns the resolution to use for generating asset previews. Defaults to 72.
    
    Returns:
    resolution in dpi
  - setThumbnailResolution
```
public void setThumbnailResolution(int value)
```
    Sets the resolution to use for generating asset previews.
    
    Parameters:
    value - resolution in dpi
  - getThumbnailMarginToFields
```
public double getThumbnailMarginToFields()
```
    Returns the margin between thumbnail area and the field values.
    
    Returns:
    margin between thumbnail area and the field values in mm
  - setThumbnailMarginToFields
```
public void setThumbnailMarginToFields(double value)
```
    Sets the margin between thumbnail area and the field values.
    
    Parameters:
    value - margin between thumbnail area and the field values in mm
  - getThumbnailMarginToFrame
```
public double getThumbnailMarginToFrame()
```
    Returns the margin between the thumbnail area border and the thumbnail itself.
    
    Returns:
    margin between the thumbnail area border and the thumbnail itself in mm
  - setThumbnailMarginToFrame
```
public void setThumbnailMarginToFrame(double value)
```
    Sets the margin between the thumbnail area border and the thumbnail itself.
    
    Parameters:
    value - margin between the thumbnail area border and the thumbnail itself in mm
  - getFieldsMarginToFrame
```
public double getFieldsMarginToFrame()
```
    Returns the margin between the fields area border and the fields itself.
    
    Returns:
    margin between the fields area border and the fields itself in mm
    Since:
    
    8.0
  - setFieldsMarginToFrame
```
public void setFieldsMarginToFrame(double value)
```
    Sets the margin between the fields area border and the fields itself.
    
    Parameters:
    value - margin between the fields area border and the fields itself in mm
    Since:
    
    8.0
  - drawThumbnailFrame
```
public boolean drawThumbnailFrame()
```
    Returns whether a border should be drawn around the thumbnail area.
    
    Returns:
    true if a border should be drawn around the thumbnail area
  - setDrawThumbnailFrame
```
public void setDrawThumbnailFrame(boolean value)
```
    Configures whether a border should be drawn around the thumbnail area.
    
    Parameters:
    value - set to true if a border should be drawn around the thumbnail area
  - drawRecordFrame
```
public boolean drawRecordFrame()
```
    Returns whether a border should be painted around the entire record cell.
    
    Returns:
    true if a border should be painted around the entire record cell
  - setDrawRecordFrame
```
public void setDrawRecordFrame(boolean value)
```
    Configures whether a border should be painted around the entire record cell.
    
    Parameters:
    value - set to true if a border should be painted around the entire record cell
  - getFieldAlignment
```
public int getFieldAlignment()
```
    Returns the mode for aligning the field content. The supported values are FIELD_ALIGNMENT_OPTION_LEFT, FIELD_ALIGNMENT_OPTION_CENTER and FIELD_ALIGNMENT_OPTION_RIGHT. Defaults to FIELD_ALIGNMENT_OPTION_LEFT.
    
    Returns:
    field values alignment
  - setFieldAlignment
```
public void setFieldAlignment(int alignment)
```
    Sets the mode for aligning the field content. The supported values are FIELD_ALIGNMENT_OPTION_LEFT, FIELD_ALIGNMENT_OPTION_CENTER and FIELD_ALIGNMENT_OPTION_RIGHT.
    
    Parameters:
    alignment - field values alignment
  - getFieldBackgroundColor
```
public int getFieldBackgroundColor()
```
    Returns the RGB value representing the background color for the fields content area in the default sRGB ColorModel. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
    
    Returns:
    the RGB value of the color in the default sRGB ColorModel.
  - setFieldBackgroundColor
```
public void setFieldBackgroundColor(int color)
```
    Sets the background color for the fields content area as RGB value representing the color. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
    
    Parameters:
    color - the combined RGB components
  - getFieldSpacing
```
public double getFieldSpacing()
```
    Return the spacing between the printed fields.
    
    Returns:
    spacing between the printed fields in mm
  - setFieldSpacing
```
public void setFieldSpacing(double spacing)
```
    Sets the spacing between the printed fields.
    
    Parameters:
    spacing - spacing between the printed fields in mm
  - getJPEGQuality
```
public int getJPEGQuality()
```
    Returns the JPEG quality being used when creating asset previews. Possible values are 1 to 10. Defaults to 7.
    
    Returns:
    JPEG quality being used when creating asset previews
    Since:
    
    7.5.1
  - setJPEGQuality
```
public void setJPEGQuality(int quality)
```
    Sets the JPEG quality being used when creating asset previews. Possible values are 1 to 10.
    
    Parameters:
    quality - JPEG quality being used when creating asset previews
    Since:
    
    7.5.1
  - drawFieldNames
```
public boolean drawFieldNames()
```
    Returns whether field names should be printed as well.
    
    Returns:
    true if field names should be printed
  - setDrawFieldNames
```
public void setDrawFieldNames(boolean draw)
```
    Configures whether field names should be printed as well.
    
    Parameters:
    draw - set to true if field names should be printed
  - getFieldToThumbnailAlignment
```
public int getFieldToThumbnailAlignment()
```
    Returns the alignment of fields to the thumbnail image. The supported values are FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_RIGHT_OF_THUMBNAIL and FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_BELOW_THUMBNAIL. Defaults to FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_RIGHT_OF_THUMBNAIL.
    
    Returns:
    alignment of fields to the thumbnail image
  - setFieldToThumbnailAlignment
```
public void setFieldToThumbnailAlignment(int align)
```
    Configures the alignment of fields to the thumbnail image. The supported values are FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_RIGHT_OF_THUMBNAIL and FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_BELOW_THUMBNAIL.
    
    Parameters:
    align - alignment of fields to the thumbnail image
  - supportsHeaderFooter72
```
public boolean supportsHeaderFooter72()
```
    Returns whether header and footer are available in the new 7.5 format which is interchangeable between different platforms.
    
    Returns:
    true header and footer are available in the new 7.5 format
  - getHeader72
```
public PrintSetDocumentStore getHeader72()
```
    Returns the header structure representing the header configuration.
    
    Returns:
    header structure
    Since:
    
    7.5
  - getFooter72
```
public PrintSetDocumentStore getFooter72()
```
    Returns the footer structure representing the footer configuration.
    
    Returns:
    footer structure
    Since:
    
    7.5
  - setHeader72
```
public PrintSetDocumentStore setHeader72()
```
    This returns an empty header structure which replaced the original one and can now be filled by the caller with the new header information.
    
    Returns:
    empty header structure to be filled by the caller
  - setFooter72
```
public PrintSetDocumentStore setFooter72()
```
    This returns an empty footer structure which replaced the original one and can now be filled by the caller with the new footer information.
    
    Returns:
    empty footer structure to be filled by the caller
  - getPageBackgroundColor
```
public int getPageBackgroundColor()
```
    Returns the RGB value representing the background color for the entire page in the default sRGB ColorModel. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
    
    Returns:
    the RGB value of the color in the default sRGB ColorModel.
  - setPageBackgroundColor
```
public void setPageBackgroundColor(int color)
```
    Sets the background color for the entire page as RGB value representing the color. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
    
    Parameters:
    color - the combined RGB components
  - getImageSource
```
public int getImageSource()
```
    Returns the source being used for printing the thumbnail image. Possible values are IMAGE_SOURCE_OPTION_THUMBNAIL and IMAGE_SOURCE_OPTION_ENTIRE_ASSET. Defaults to IMAGE_SOURCE_OPTION_ENTIRE_ASSET.
    
    Returns:
    image source for thumbnail images
  - setImageSource
```
public void setImageSource(int source)
```
    Sets the source being used for printing the thumbnail image. Possible values are IMAGE_SOURCE_OPTION_THUMBNAIL and IMAGE_SOURCE_OPTION_ENTIRE_ASSET.
    
    Parameters:
    source - image source for thumbnail images
  - isPDFEnabled
```
public boolean isPDFEnabled()
```
    Returns whether this print set can be used to print PDFs.
    
    Returns:
    true if PDF printing is allowed
  - setPDFEnabled
```
public void setPDFEnabled(boolean value)
```
    Configures whether this print set can be used to print PDFs.
    
    Parameters:
    value - set to true if PDF printing should be allowed
  - isEditPDFSettingsWhenPrintingEnabled
```
public boolean isEditPDFSettingsWhenPrintingEnabled()
```
    Returns whether this print sets PDF options can be edited when printing.
    
    Returns:
    true if editing is allowed
    Since:
    
    8.1
  - setEditPDFSettingsWhenPrintingEnabled
```
public void setEditPDFSettingsWhenPrintingEnabled(boolean value)
```
    Configures whether this print sets PDF options can be edited when printing.
    
    Parameters:
    value - set to true if editing should be allowed
    Since:
    
    8.1
  - isPDFSecurityEnabled
```
public boolean isPDFSecurityEnabled()
```
    Returns whether security options should be set when printing the PDF.
    
    Returns:
    true if security options should be set when printing the PDF
  - setPDFSecurityEnabled
```
public void setPDFSecurityEnabled(boolean value)
```
    Sets whether security options should be set when printing the PDF.
    
    Parameters:
    value - set to true if security options should be set when printing the PDF
  - isPDFWPPICPEnabled
```
public boolean isPDFWPPICPEnabled()
```
    Returns whether thumbnails should be linked to their records in a WPP/ICP installation.
    
    Returns:
    true if thumbnails should be linked to their records in a WPP/ICP installation
  - setPDFWPPICPEnabled
```
public void setPDFWPPICPEnabled(boolean value)
```
    Sets whether thumbnails should be linked to their records in a WPP/ICP installation.
    
    Parameters:
    value - set to true if thumbnails should be linked to their records in a WPP/ICP installation
  - getPDFWPPICPBaseURL
```
public java.lang.String getPDFWPPICPBaseURL()
```
    Returns the base installation URL for the WPP/ICP installation. Defaults to http://your.wpp.server/Cumulus.
    
    Returns:
    string for the base URL of the WPP/ICP installation
  - setPDFWPPICPBaseURL
```
public void setPDFWPPICPBaseURL(java.lang.String url)
```
    Sets the base installation URL for the WPP/ICP installation.
    
    Parameters:
    url - base URL of the WPP/ICP installation
  - allowPDFWPPICPGuestLogin
```
public boolean allowPDFWPPICPGuestLogin()
```
    Returns whether the generated WPP/ICP links use an automatic guest login or direct the caller to the login page of the WPP/ICP installation.
    
    Returns:
    true if the guest login should be used
  - setPDFWPPICPGuestLogin
```
public void setPDFWPPICPGuestLogin(boolean value)
```
    Configures whether the generated WPP/ICP links should use an automatic guest login or direct the caller to the login page of the WPP/ICP installation.
    
    Parameters:
    value - set to true if the guest login should be used
  - getPDFURLMode
```
public URLMode getPDFURLMode()
```
    Returns the configured URL Mode when printing to PDF and embedding URLs. Currently only URLs of type URLMode.SHOW_RECORD and URLMode.ASSET_URL are supported.
    
    Returns:
    configured url mode for embedded URLs
    Since:
    
    8.5
  - setPDFURLMode
```
public void setPDFURLMode(URLMode urlMode)
```
    Configures the URL Mode when printing to PDF and embedding URLs. Currently only URLs of type URLMode.SHOW_RECORD and URLMode.ASSET_URL are supported.
    
    Parameters:
    urlMode - configured url mode for embedded URLs
    Since:
    
    8.5
  - getPDFEmbedAnnotations
```
public boolean getPDFEmbedAnnotations()
```
    Returns whether the PDF should embed user comments as annotations.
    
    Returns:
    whether the PDF should embed user comments as annotations
    Since:
    
    9.0
  - setPDFEmbedAnnotations
```
public void setPDFEmbedAnnotations(boolean value)
```
    Specify whether the PDF should embed user comments as annotations.
    
    Parameters:
    value - specify whether the PDF should embed user comments as annotations
    Since:
    
    9.0
  - getPDFSecurity
```
public int getPDFSecurity()
```
    Returns the PDF security settings encoded into an int.
    
    Returns:
    PDF security settings
  - pdfAllowPrinting
```
public boolean pdfAllowPrinting()
```
    Returns whether printing the PDF in high resolution is allowed.
    
    Returns:
    true if printing the PDF in high resolution is allowed
  - setPDFAllowPrinting
```
public void setPDFAllowPrinting(boolean value)
```
    Sets whether printing the PDF in high resolution is allowed.
    
    Parameters:
    value - set to true if printing the PDF in high resolution is allowed
  - pdfAllowDegradedPrinting
```
public boolean pdfAllowDegradedPrinting()
```
    Returns whether printing the PDF in low resolution is allowed.
    
    Returns:
    true if printing the PDF in low resolution is allowed
  - setPDFAllowDegradedPrinting
```
public void setPDFAllowDegradedPrinting(boolean value)
```
    Sets whether printing the PDF in low resolution is allowed.
    
    Parameters:
    value - set to true if printing the PDF in low resolution is allowed
  - pdfAllowDocumentChanges
```
public boolean pdfAllowDocumentChanges()
```
    Returns whether PDF document changes are allowed.
    
    Returns:
    true if PDF document changes are allowed
  - setPDFAllowDocumentChanges
```
public void setPDFAllowDocumentChanges(boolean value)
```
    Configures whether PDF document changes are allowed.
    
    Parameters:
    value - set to true if PDF document changes are allowed
  - pdfAllowModifyAnnotations
```
public boolean pdfAllowModifyAnnotations()
```
    Returns whether PDF document annotation changes are allowed.
    
    Returns:
    true if PDF document annotation changes are allowed
  - setPDFAllowModifyAnnotations
```
public void setPDFAllowModifyAnnotations(boolean value)
```
    Sets whether PDF document annotation changes are allowed.
    
    Parameters:
    value - set to true if PDF document annotation changes are allowed
  - pdfAllowContentCopyingAndExtractionAlsoForScreenReaders
```
public boolean pdfAllowContentCopyingAndExtractionAlsoForScreenReaders()
```
    Returns whether the PDF document should allow content copying and extraction.
    
    Returns:
    true if PDF document should allow content copying and extraction
  - setPDFAllowContentCopyingAndExtractionAlsoForScreenReaders
```
public void setPDFAllowContentCopyingAndExtractionAlsoForScreenReaders(boolean value)
```
    Sets whether the PDF document should allow content copying and extraction.
    
    Parameters:
    value - set to true if PDF document should allow content copying and extraction
  - pdfAllowFillIn
```
public boolean pdfAllowFillIn()
```
    Returns whether the PDF document should allow to fill in forms and sign the document.
    
    Returns:
    true if PDF document should allow to fill in forms and sign the document
  - setPDFAllowFillIn
```
public void setPDFAllowFillIn(boolean value)
```
    Sets whether the PDF document should allow to fill in forms and sign the document.
    
    Parameters:
    value - set to true if PDF document should allow to fill in forms and sign the document
  - pdfAllowScreenReaders
```
public boolean pdfAllowScreenReaders()
```
    Returns whether the PDF document should allow content copying and extraction for screen readers.
    
    Returns:
    true if PDF document should allow content copying and extraction for screen readers
  - setPDFAllowScreenReaders
```
public void setPDFAllowScreenReaders(boolean value)
```
    Sets whether the PDF document should allow content copying and extraction for screen readers.
    
    Parameters:
    value - set to true if PDF document should allow content copying and extraction for screen readers
  - pdfAllowDocumentAssembly
```
public boolean pdfAllowDocumentAssembly()
```
    Returns whether the PDF document should allow document assembly.
    
    Returns:
    true if PDF document should allow document assembly
  - setPDFAllowDocumentAssembly
```
public void setPDFAllowDocumentAssembly(boolean value)
```
    Sets whether the PDF document should allow document assembly.
    
    Parameters:
    value - set to true if PDF document should allow document assembly
  - getPDFDocumentOwnerPassword
```
public java.lang.String getPDFDocumentOwnerPassword()
```
    Returns the PDF document owner password.
    
    Returns:
    PDF document owner password
  - setPDFDocumentOwnerPassword
```
public void setPDFDocumentOwnerPassword(java.lang.String value)
```
    Sets the PDF document owner password. You should not save the print set after setting the password because the password will be saved in clear text and therefore is readable to anyone with access to Cumulus.
    
    Parameters:
    value - PDF document owner password
  - getPDFOpenDocumentPassword
```
public java.lang.String getPDFOpenDocumentPassword()
```
    Returns the password to open the PDF document.
    
    Returns:
    password to open the PDF document
  - setPDFOpenDocumentPassword
```
public void setPDFOpenDocumentPassword(java.lang.String value)
```
    Sets the password to open the PDF document. You should not save the print set after setting the password because the password will be saved in clear text and therefore is readable to anyone with access to Cumulus.
    
    Parameters:
    value - password to open the PDF document
  - getRecordFieldList
```
public RecordFieldList getRecordFieldList()
```
    Returns the list of fields to print in advanced mode.
    
    Returns:
    list of record fields to print
  - isApplyAssetActionOnThumbnailEnabled
```
public boolean isApplyAssetActionOnThumbnailEnabled()
```
    Returns whether this print sets applies an asset action on the printed thumbnail.
    
    Returns:
    true if an asset action should be applied
    Since:
    
    8.5
  - setApplyAssetActionOnThumbnail
```
public void setApplyAssetActionOnThumbnail(boolean value)
```
    Configures whether this print sets applies an asset action on the printed thumbnail.
    
    Parameters:
    value - true if an asset action should be applied
    Since:
    
    8.5
  - getAppliedAssetAction
```
public java.lang.String getAppliedAssetAction()
```
    Returns the name of the asset action to apply on printed thumbnails.
    
    Returns:
    asset action name
    Since:
    
    8.5
  - setAppliedAssetAction
```
public void setAppliedAssetAction(java.lang.String value)
```
    Sets the name of the asset action to apply on printed thumbnails.
    
    Parameters:
    value - asset action name
    Since:
    
    8.5

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class PrintSetAdvanced

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

Method Summary

Methods inherited from class com.canto.cumulus.prefs.BaseManager

Methods inherited from class java.lang.Object

Field Detail

THUMBNAILS_ALIGNMENT_OPTION_NORTH_WEST

THUMBNAILS_ALIGNMENT_OPTION_NORTH

THUMBNAILS_ALIGNMENT_OPTION_NORTH_EAST

THUMBNAILS_ALIGNMENT_OPTION_WEST

THUMBNAILS_ALIGNMENT_OPTION_CENTER

THUMBNAILS_ALIGNMENT_OPTION_EAST

THUMBNAILS_ALIGNMENT_OPTION_SOUTH_WEST

THUMBNAILS_ALIGNMENT_OPTION_SOUTH

THUMBNAILS_ALIGNMENT_OPTION_SOUTH_EAST

FIELD_ALIGNMENT_OPTION_LEFT

FIELD_ALIGNMENT_OPTION_CENTER

FIELD_ALIGNMENT_OPTION_RIGHT

FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_RIGHT_OF_THUMBNAIL

FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_BELOW_THUMBNAIL

FIELD_TO_THUMBNAIL_ALIGNMENT_OPTION_ABOVE_THUMBNAIL

IMAGE_SOURCE_OPTION_THUMBNAIL

IMAGE_SOURCE_OPTION_ENTIRE_ASSET

Method Detail

getGridRows

setGridRows

getGridColumns

setGridColumns

getOuterMarginsTop

setOuterMarginsTop

getOuterMarginsLeft

setOuterMarginsLeft

getOuterMarginsBottom

setOuterMarginsBottom

getOuterMarginsRight

setOuterMarginsRight

getInnerMarginsHorizontal

setInnerMarginsHorizontal

getInnerMarginsVertical

setInnerMarginsVertical

getThumbnailAlignment

setThumbnailAlignment

getThumbnailBackgroundColor

setThumbnailBackgroundColor

getThumbnailResolution

setThumbnailResolution

getThumbnailMarginToFields

setThumbnailMarginToFields

getThumbnailMarginToFrame

setThumbnailMarginToFrame

getFieldsMarginToFrame

setFieldsMarginToFrame

drawThumbnailFrame

setDrawThumbnailFrame

drawRecordFrame

setDrawRecordFrame

getFieldAlignment

setFieldAlignment

getFieldBackgroundColor

setFieldBackgroundColor

getFieldSpacing

setFieldSpacing

getJPEGQuality

setJPEGQuality

drawFieldNames

setDrawFieldNames

getFieldToThumbnailAlignment

setFieldToThumbnailAlignment

supportsHeaderFooter72

getHeader72

getFooter72

setHeader72

setFooter72

getPageBackgroundColor

setPageBackgroundColor

getImageSource

setImageSource