PrintSet (Cumulus Java Classes Documentation)

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

All Implemented Interfaces:

Item
```
public class PrintSet
extends BaseManager
implements Item
```
This class manages all the settings of a single print set.

See Also:
PrintSetsList.getPrintSet(String)

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`	`PAGE_ORIENTATION_OPTION_LANDSCAPE`
`static int`	`PAGE_ORIENTATION_OPTION_PORTRAIT`
`static int`	`PRINT_MODE_OPTION_ADVANCED`
`static int`	`PRINT_MODE_OPTION_SIMPLE`
`static int`	`SIMPLE_MODE_RVS_MODE_OPTION_CURRENT_RVS`
`static int`	`SIMPLE_MODE_RVS_MODE_OPTION_SPECIFIC_RVS`
`static int`	`UNIT_DISPLAY_OPTION_CM`
`static int`	`UNIT_DISPLAY_OPTION_INCH`

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

Method Summary

Methods
Modifier and Type	Method and Description
`JPack`	`exportSet()` Exports this set into a `JPack`.
`java.lang.String`	`getDescription(int languageID)` Returns the description for the given language id.
`java.lang.String`	`getDisplayName(int languageID, boolean fallbackToDefaultName)` Returns the display name for the given language id.
`int`	`getDisplayUnit()` Returns the unit to use for displaying measurements.
`java.lang.String`	`getID()` Returns the UID of the item in the items namespace.
`boolean`	`getIsDefault()` Returns whether this print set is the default print set.
`java.lang.String`	`getName()` Returns the name of this print set.
`java.lang.String`	`getPageFormat()` Returns a display string for the chosen page format.
`double`	`getPageHeight()` Returns the page format height.
`double`	`getPageMarginBottom()` Returns the page margin at the bottom.
`double`	`getPageMarginLeft()` Returns the page margin at the left side.
`double`	`getPageMarginRight()` Returns the page margin at the right side.
`double`	`getPageMarginTop()` Returns the page margin at the top.
`int`	`getPageOrientation()` Returns the page orientation.
`double`	`getPageWidth()` Returns the page format width.
`int`	`getPrintMode()` Returns the mode being used when printing using this print set.
`PrintSetAdvanced`	`getPrintSetAdvanced()` Returns the settings for printing in advanced mode.
`RestrictionsList`	`getRestrictionsList()` Returns the list of roles and users that are allowed to view this set.
`int`	`getSimpleMode()` Returns whether the current record view set or a specific record view set should be used if this print set is in simple mode and used for printing.
`java.lang.String`	`getSimpleModeRecordViewSet()` Returns the name of the record view set to use when printing using this print set in simple mode and with `getSimpleMode()` returning `SIMPLE_MODE_RVS_MODE_OPTION_SPECIFIC_RVS`.
`java.lang.String`	`getSimpleModeViewModeName()` Returns the view mode to use when printing in simple mode.
`boolean`	`isDefault()` Returns whether this item is the default item.
`boolean`	`isSharingRestricted()` Returns whether the set visibility is restricted to a group of users or roles.
`void`	`setDescription(int languageID, java.lang.String description)` Sets the description for the given language.
`void`	`setDisplayName(int languageID, java.lang.String displayName)` Sets the display name for the given language.
`void`	`setDisplayUnit(int unit)` Configures the unit to use for displaying measurements.
`void`	`setPageFormat(java.lang.String format)` Sets the display string for the chosen format.
`void`	`setPageHeight(double height)` Sets the page format height.
`void`	`setPageMarginBottom(double margin)` Sets the page margin at the bottom.
`void`	`setPageMarginLeft(double margin)` Sets the page margin at the left side.
`void`	`setPageMarginRight(double margin)` Sets the page margin at the right side.
`void`	`setPageMarginTop(double margin)` Sets the page margin at the top.
`void`	`setPageOrientation(int orientation)` Configures the page orientation.
`void`	`setPageWidth(double width)` Sets the page format width.
`void`	`setPrintMode(int mode)` Configures the mode being used when printing using this print set.
`void`	`setSharingRestricted(boolean value)` Sets whether the set visibility is restricted to a group of users or roles.
`void`	`setSimpleMode(int mode)` Sets whether the current record view set or a specific record view set should be used if this print set is in simple mode and used for printing.
`void`	`setSimpleModeRecordViewSet(java.lang.String rvs)` Sets the name of the record view set to use when printing using this print set in simple mode and with `getSimpleMode()` returning `SIMPLE_MODE_RVS_MODE_OPTION_SPECIFIC_RVS`.
`void`	`setSimpleModeViewModeName(java.lang.String value)` Configures the view mode to use when printing in simple mode.

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
  - PAGE_ORIENTATION_OPTION_PORTRAIT
```
public static final int PAGE_ORIENTATION_OPTION_PORTRAIT
```
    See Also:
    Constant Field Values
  - PAGE_ORIENTATION_OPTION_LANDSCAPE
```
public static final int PAGE_ORIENTATION_OPTION_LANDSCAPE
```
    See Also:
    Constant Field Values
  - UNIT_DISPLAY_OPTION_CM
```
public static final int UNIT_DISPLAY_OPTION_CM
```
    See Also:
    Constant Field Values
  - UNIT_DISPLAY_OPTION_INCH
```
public static final int UNIT_DISPLAY_OPTION_INCH
```
    See Also:
    Constant Field Values
  - PRINT_MODE_OPTION_SIMPLE
```
public static final int PRINT_MODE_OPTION_SIMPLE
```
    See Also:
    Constant Field Values
  - PRINT_MODE_OPTION_ADVANCED
```
public static final int PRINT_MODE_OPTION_ADVANCED
```
    See Also:
    Constant Field Values
  - SIMPLE_MODE_RVS_MODE_OPTION_CURRENT_RVS
```
public static final int SIMPLE_MODE_RVS_MODE_OPTION_CURRENT_RVS
```
    See Also:
    Constant Field Values
  - SIMPLE_MODE_RVS_MODE_OPTION_SPECIFIC_RVS
```
public static final int SIMPLE_MODE_RVS_MODE_OPTION_SPECIFIC_RVS
```
    See Also:
    Constant Field Values
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of this print set.
    
    Returns:
    name of this print set
  - getIsDefault
```
public boolean getIsDefault()
```
    Returns whether this print set is the default print set.
    
    Returns:
    true if this is the default print set
  - getPageWidth
```
public double getPageWidth()
```
    Returns the page format width.
    
    Returns:
    page width in mm
  - setPageWidth
```
public void setPageWidth(double width)
```
    Sets the page format width.
    
    Parameters:
    width - page width in mm
  - getPageHeight
```
public double getPageHeight()
```
    Returns the page format height.
    
    Returns:
    page height in mm
  - setPageHeight
```
public void setPageHeight(double height)
```
    Sets the page format height.
    
    Parameters:
    height - page height in mm
  - getPageFormat
```
public java.lang.String getPageFormat()
```
    Returns a display string for the chosen page format.
    
    Returns:
    display string for the chosen format
  - setPageFormat
```
public void setPageFormat(java.lang.String format)
```
    Sets the display string for the chosen format.
    
    Parameters:
    format - display format string
  - getPageMarginTop
```
public double getPageMarginTop()
```
    Returns the page margin at the top.
    
    Returns:
    top margin in mm
  - setPageMarginTop
```
public void setPageMarginTop(double margin)
```
    Sets the page margin at the top.
    
    Parameters:
    margin - top margin in mm
  - getPageMarginBottom
```
public double getPageMarginBottom()
```
    Returns the page margin at the bottom.
    
    Returns:
    bottom margin in mm
  - setPageMarginBottom
```
public void setPageMarginBottom(double margin)
```
    Sets the page margin at the bottom.
    
    Parameters:
    margin - bottom margin in mm
  - getPageMarginLeft
```
public double getPageMarginLeft()
```
    Returns the page margin at the left side.
    
    Returns:
    left margin in mm
  - setPageMarginLeft
```
public void setPageMarginLeft(double margin)
```
    Sets the page margin at the left side.
    
    Parameters:
    margin - left margin in mm
  - getPageMarginRight
```
public double getPageMarginRight()
```
    Returns the page margin at the right side.
    
    Returns:
    right margin in mm
  - setPageMarginRight
```
public void setPageMarginRight(double margin)
```
    Sets the page margin at the right side.
    
    Parameters:
    margin - right margin in mm
  - getPageOrientation
```
public int getPageOrientation()
```
    Returns the page orientation. Possible values are PAGE_ORIENTATION_OPTION_PORTRAIT and PAGE_ORIENTATION_OPTION_LANDSCAPE. Defaults to PAGE_ORIENTATION_OPTION_PORTRAIT.
    
    Returns:
    page orientation
  - setPageOrientation
```
public void setPageOrientation(int orientation)
```
    Configures the page orientation. Possible values are PAGE_ORIENTATION_OPTION_PORTRAIT and PAGE_ORIENTATION_OPTION_LANDSCAPE.
    
    Parameters:
    orientation - page orientation
  - getDisplayUnit
```
public int getDisplayUnit()
```
    Returns the unit to use for displaying measurements. The possible values are UNIT_DISPLAY_OPTION_CM and UNIT_DISPLAY_OPTION_INCH. Defaults to UNIT_DISPLAY_OPTION_CM.
    
    Returns:
    measurement display unit
  - setDisplayUnit
```
public void setDisplayUnit(int unit)
```
    Configures the unit to use for displaying measurements. The possible values are UNIT_DISPLAY_OPTION_CM and UNIT_DISPLAY_OPTION_INCH.
    
    Parameters:
    unit - measurement display unit
  - getPrintMode
```
public int getPrintMode()
```
    Returns the mode being used when printing using this print set. The possible values are PRINT_MODE_OPTION_SIMPLE and PRINT_MODE_OPTION_ADVANCED. Defaults to PRINT_MODE_OPTION_SIMPLE.
    
    Returns:
    the print mode to use when printing using this print set
  - setPrintMode
```
public void setPrintMode(int mode)
```
    Configures the mode being used when printing using this print set. The possible values are PRINT_MODE_OPTION_SIMPLE and PRINT_MODE_OPTION_ADVANCED.
    
    Parameters:
    mode - print mode to use when printing using this print set
  - getSimpleMode
```
public int getSimpleMode()
```
    Returns whether the current record view set or a specific record view set should be used if this print set is in simple mode and used for printing. Possible values are SIMPLE_MODE_RVS_MODE_OPTION_CURRENT_RVS and SIMPLE_MODE_RVS_MODE_OPTION_SPECIFIC_RVS. Defaults to SIMPLE_MODE_RVS_MODE_OPTION_CURRENT_RVS.
    
    Returns:
    the record view set mode when printing in simple mode
  - setSimpleMode
```
public void setSimpleMode(int mode)
```
    Sets whether the current record view set or a specific record view set should be used if this print set is in simple mode and used for printing. Possible values are SIMPLE_MODE_RVS_MODE_OPTION_CURRENT_RVS and SIMPLE_MODE_RVS_MODE_OPTION_SPECIFIC_RVS.
    
    Parameters:
    mode - record view set mode when printing in simple mode
    See Also:
    setSimpleModeRecordViewSet(String)
  - getSimpleModeRecordViewSet
```
public java.lang.String getSimpleModeRecordViewSet()
```
    Returns the name of the record view set to use when printing using this print set in simple mode and with getSimpleMode() returning SIMPLE_MODE_RVS_MODE_OPTION_SPECIFIC_RVS. Defaults to null.
    
    Returns:
    record view set name
  - setSimpleModeRecordViewSet
```
public void setSimpleModeRecordViewSet(java.lang.String rvs)
```
    Sets the name of the record view set to use when printing using this print set in simple mode and with getSimpleMode() returning SIMPLE_MODE_RVS_MODE_OPTION_SPECIFIC_RVS.
    
    Parameters:
    rvs - record view set name
  - getSimpleModeViewModeName
```
public java.lang.String getSimpleModeViewModeName()
```
    Returns the view mode to use when printing in simple mode. Possible values are RecordView.RECORD_VIEW_TYPE_THUMBNAIL, RecordView.RECORD_VIEW_TYPE_DETAILS, RecordView.RECORD_VIEW_TYPE_INFO_VIEW, RecordView.RECORD_VIEW_TYPE_PALETTE and RecordView.RECORD_VIEW_TYPE_PREVIEW_VIEW. Defaults to null.
    
    Returns:
    view mode to use when printing in simple mode
  - setSimpleModeViewModeName
```
public void setSimpleModeViewModeName(java.lang.String value)
```
    Configures the view mode to use when printing in simple mode. Possible values are RecordView.RECORD_VIEW_TYPE_THUMBNAIL, RecordView.RECORD_VIEW_TYPE_DETAILS, RecordView.RECORD_VIEW_TYPE_INFO_VIEW, RecordView.RECORD_VIEW_TYPE_PALETTE and RecordView.RECORD_VIEW_TYPE_PREVIEW_VIEW.
    
    Parameters:
    value - view mode to use when printing in simple mode
  - getPrintSetAdvanced
```
public PrintSetAdvanced getPrintSetAdvanced()
```
    Returns the settings for printing in advanced mode.
    
    Returns:
    advanced mode print settings
  - getID
```
public java.lang.String getID()
```
    Description copied from interface: Item
    
    Returns the UID of the item in the items namespace.
    
    Specified by:
    
    getID in interface Item
    
    Returns:
    item UID
  - isDefault
```
public boolean isDefault()
```
    Description copied from interface: Item
    
    Returns whether this item is the default item.
    
    Specified by:
    
    isDefault in interface Item
    
    Returns:
    true if this is the default item
  - getDescription
```
public java.lang.String getDescription(int languageID)
```
    Returns the description for the given language id.
    
    Specified by:
    
    getDescription in interface Item
    
    Parameters:
    languageID - specifying the language for the description
    
    Returns:
    description text
    Since:
    
    8.0
  - setDescription
```
public void setDescription(int languageID,
                  java.lang.String description)
```
    Sets the description for the given language.
    
    Specified by:
    
    setDescription in interface Item
    
    Parameters:
    languageID - the language to set the description for
    description - the new description
    Since:
    
    8.0
  - getDisplayName
```
public java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)
```
    Returns the display name for the given language id.
    
    Specified by:
    
    getDisplayName in interface Item
    
    Parameters:
    languageID - specifying the language for the display name
    fallbackToDefaultName - when set to true this method returns the default name when now localized display name is available otherwise null
    
    Returns:
    display name
    Since:
    
    8.5
  - setDisplayName
```
public void setDisplayName(int languageID,
                  java.lang.String displayName)
```
    Sets the display name for the given language.
    
    Specified by:
    
    setDisplayName in interface Item
    
    Parameters:
    languageID - the language to set the display name for
    displayName - the new display name
    Since:
    
    8.5
  - exportSet
```
public JPack exportSet()
```
    Exports this set into a JPack.
    
    Specified by:
    
    exportSet in interface Item
    
    Returns:
    exported data as JPack
    Since:
    
    8.1
    
    See Also:
    PrintSetsList.importSet(com.canto.cumulus.utils.JPack, SetImportDuplicatesMode)
  - isSharingRestricted
```
public boolean isSharingRestricted()
```
    Returns whether the set visibility is restricted to a group of users or roles.
    
    Specified by:
    
    isSharingRestricted in interface Item
    
    Returns:
    true if the set visibility is restricted to a group of users or roles
    Since:
    
    8.6
  - setSharingRestricted
```
public void setSharingRestricted(boolean value)
```
    Sets whether the set visibility is restricted to a group of users or roles.
    
    Specified by:
    
    setSharingRestricted in interface Item
    
    Parameters:
    value - set to true if the set visibility should be restricted to a group of users or roles
    Since:
    
    8.6
  - getRestrictionsList
```
public RestrictionsList getRestrictionsList()
```
    Returns the list of roles and users that are allowed to view this set. Only applicable for shared set and if isSharingRestricted() returns true.
    
    Specified by:
    
    getRestrictionsList in interface Item
    
    Returns:
    list of roles and users that are allowed to view this set
    Since:
    
    8.6

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 PrintSet

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

PAGE_ORIENTATION_OPTION_PORTRAIT

PAGE_ORIENTATION_OPTION_LANDSCAPE

UNIT_DISPLAY_OPTION_CM

UNIT_DISPLAY_OPTION_INCH

PRINT_MODE_OPTION_SIMPLE

PRINT_MODE_OPTION_ADVANCED

SIMPLE_MODE_RVS_MODE_OPTION_CURRENT_RVS

SIMPLE_MODE_RVS_MODE_OPTION_SPECIFIC_RVS

Method Detail

getName

getIsDefault

getPageWidth

setPageWidth

getPageHeight

setPageHeight

getPageFormat

setPageFormat

getPageMarginTop

setPageMarginTop

getPageMarginBottom

setPageMarginBottom

getPageMarginLeft

setPageMarginLeft

getPageMarginRight

setPageMarginRight

getPageOrientation

setPageOrientation

getDisplayUnit

setDisplayUnit

getPrintMode

setPrintMode

getSimpleMode

setSimpleMode

getSimpleModeRecordViewSet

setSimpleModeRecordViewSet

getSimpleModeViewModeName

setSimpleModeViewModeName

getPrintSetAdvanced

getID

isDefault

getDescription

setDescription

getDisplayName

setDisplayName

exportSet

isSharingRestricted

setSharingRestricted

getRestrictionsList