Package chemaxon.formats.documents.jchemoffice

Class ReportSettings

java.lang.Object
chemaxon.formats.documents.jchemoffice.GenericOptions
chemaxon.formats.documents.jchemoffice.ReportSettings
All Implemented Interfaces:
IGenericOptions, ISettings
@PublicAPI public class ReportSettings extends GenericOptions implements ISettings
ReportSettings class can be instantiated and used in writer functionalities. That is the default implementation of settings, custom implementation is possible. For more detailed description of methods please check ISettings interface.

  • Constructor Details

    • ReportSettings

      public ReportSettings()

    • ReportSettings

      public ReportSettings(Location location)

    • ReportSettings

      public ReportSettings(Location location, chemaxon.marvin.io.image.ImageExporter imageWriter) throws chemaxon.util.ArgumentException
      Throws:
      chemaxon.util.ArgumentException

    • ReportSettings

      public ReportSettings(Location location, String settings) throws chemaxon.util.ArgumentException
      Throws:
      chemaxon.util.ArgumentException

    • ReportSettings

      public ReportSettings(ISettings settings) throws chemaxon.util.ArgumentException
      Throws:
      chemaxon.util.ArgumentException

    • ReportSettings

      public ReportSettings(Location location, ISettings settings) throws chemaxon.util.ArgumentException
      Throws:
      chemaxon.util.ArgumentException

  • Method Details

    • getLocation

      public Location getLocation()
      Description copied from interface: ISettings
      Gets the location in the Document. i.e. pageNumber, horizontal and vertical position on the page
      Specified by:
      getLocation in interface ISettings
      Returns:
      Location in the Document

    • setLocation

      public void setLocation(Location location)
      Description copied from interface: ISettings
      Sets the location in the Document. i.e. pageNumber, horizontal and vertical position on the page
      Specified by:
      setLocation in interface ISettings
      Parameters:
      location - - The location in the Document

    • getImageWriter

      public chemaxon.marvin.io.image.ImageExporter getImageWriter()
      Description copied from interface: ISettings
      Gets the molecule image writer, i.e the default image writer is the jpeg writer
      Specified by:
      getImageWriter in interface ISettings
      Returns:
      ImageExporter

    • setImageWriter

      public void setImageWriter(chemaxon.marvin.io.image.ImageExporter imageWriter) throws chemaxon.util.ArgumentException
      Description copied from interface: ISettings
      Sets the molecule image writer with a custom writer what will overwrite the default jpeg writer
      Specified by:
      setImageWriter in interface ISettings
      Parameters:
      imageWriter - - The ImageExporter with image exporting options
      Throws:
      chemaxon.util.ArgumentException

    • getImageGenerationMethod

      public ImageGenerationType getImageGenerationMethod()
      Description copied from interface: ISettings
      Gets the image generation type if it is based on the ImageExporter and settings or through string based settings
      Specified by:
      getImageGenerationMethod in interface ISettings
      Returns:
      ImageGenerationType

    • getImageSettings

      public String getImageSettings()
      Description copied from interface: ISettings
      Gets the image rendering setting in string format
      Specified by:
      getImageSettings in interface ISettings
      Returns:
      Rendering settings

    • setImageSettings

      public void setImageSettings(String settings) throws chemaxon.util.ArgumentException
      Description copied from interface: ISettings
      Sets the image rendering settings in String format

      The following is one example how to use the setImageSettings. The code: 

       ISettings settings = new ReportSettings();
 Isettings.setImageSettings(
         "emf:marginSize1.6,wireThickness0.03333333333333333,ballstick,bondl14.4,atsiz0.35714285714285715,bondHashSpacing0.1388888888888889,boldbondw2.0,atomFont:Arial-PLAIN-10,bondw0.09350649350649351");
      Specified by:
      setImageSettings in interface ISettings
      Parameters:
      settings - - Rendering settings
      Throws:
      chemaxon.util.ArgumentException

    • copyFrom

      public void copyFrom(ISettings settings) throws chemaxon.util.ArgumentException
      Description copied from interface: ISettings
      Copies the entire settings from another settings instance
      Specified by:
      copyFrom in interface ISettings
      Parameters:
      settings - - ISettings object
      Throws:
      chemaxon.util.ArgumentException

    • setDefaultStructureCellWidth

      public void setDefaultStructureCellWidth(int width)
      Description copied from interface: ISettings
      Sets the default Structure Cell width
      Specified by:
      setDefaultStructureCellWidth in interface ISettings
      Parameters:
      width - - Width of the Structure Cell

    • getDefaultStructureCellWidth

      public int getDefaultStructureCellWidth()
      Description copied from interface: ISettings
      Gets the default Structure Cell width
      Specified by:
      getDefaultStructureCellWidth in interface ISettings
      Returns:
      Width of the Structure Cell

    • setDefaultStructureCellHeight

      public void setDefaultStructureCellHeight(int height)
      Description copied from interface: ISettings
      Sets the default Structure Cell height
      Specified by:
      setDefaultStructureCellHeight in interface ISettings
      Parameters:
      height - - Height of the Structure Cell

    • getDefaultStructureCellHeight

      public int getDefaultStructureCellHeight()
      Description copied from interface: ISettings
      Gets the default Structure Cell height
      Specified by:
      getDefaultStructureCellHeight in interface ISettings
      Returns:
      Height of the Structure Cell

    • getValidateImageSettings

      public boolean getValidateImageSettings()
      Description copied from interface: ISettings
      The default values is True, which means that the system runs an extra validation on the rendering settings string before using it.
      Specified by:
      getValidateImageSettings in interface ISettings
      Returns:
      - true if the application runs an extra validation on the image rendering settings (string).

    • setValidateImageSettings

      public void setValidateImageSettings(boolean validate)
      Description copied from interface: ISettings
      Do extra validation on rendering settings string or not. If not that it should be derived from a reliable source. The default values is True.
      Specified by:
      setValidateImageSettings in interface ISettings

    • getCardLayoutSettings

      public ICardLayout getCardLayoutSettings()
      Description copied from interface: ISettings
      Retrieve card layout report settings.
      Specified by:
      getCardLayoutSettings in interface ISettings
      Returns:
      : Card layout settings for card layout reports.

    • setCardLayoutSettings

      public void setCardLayoutSettings(ICardLayout layout)
      Description copied from interface: ISettings
      Store the new card layout settings to this global settings.
      Specified by:
      setCardLayoutSettings in interface ISettings

    • getConditionalFormatting

      public Set<PropertyColoring> getConditionalFormatting()
      Description copied from interface: ISettings
      Retrieve conditional formatting to amend it.
      Specified by:
      getConditionalFormatting in interface ISettings
      Returns:
      : dictionary of property coloring objects

    • getTableCellFormats

      public IPropertyTableCellFormats getTableCellFormats()
      Description copied from interface: ISettings
      Retrieve the defined/default cell formats of the property table. These formats are override-able programmatically.
      Specified by:
      getTableCellFormats in interface ISettings