Package chemaxon.formats.documents.jchemoffice

Interface ISettings

All Superinterfaces:
IGenericOptions
All Known Implementing Classes:
ReportSettings
@PublicApi public interface ISettings extends IGenericOptions

  • Method Details

    • getLocation

      Location getLocation()
      Gets the location in the Document. i.e. pageNumber, horizontal and vertical position on the page
      Returns:
      Location in the Document

    • setLocation

      void setLocation(Location location)
      Sets the location in the Document. i.e. pageNumber, horizontal and vertical position on the page
      Parameters:
      location - - The location in the Document

    • getImageWriter

      chemaxon.marvin.io.image.ImageExporter getImageWriter()
      Gets the molecule image writer, i.e the default image writer is the jpeg writer
      Returns:
      ImageExporter

    • setImageWriter

      void setImageWriter(chemaxon.marvin.io.image.ImageExporter imageWriter) throws ArgumentException
      Sets the molecule image writer with a custom writer what will overwrite the default jpeg writer
      Parameters:
      imageWriter - - The ImageExporter with image exporting options
      Throws:
      ArgumentException

    • getImageGenerationMethod

      ImageGenerationType getImageGenerationMethod()
      Gets the image generation type if it is based on the ImageExporter and settings or through string based settings
      Returns:
      ImageGenerationType

    • getImageSettings

      String getImageSettings()
      Gets the image rendering setting in string format
      Returns:
      Rendering settings

    • setImageSettings

      void setImageSettings(String settings) throws ArgumentException
      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");
      Parameters:
      settings - - Rendering settings
      Throws:
      ArgumentException

    • copyFrom

      void copyFrom(ISettings settings) throws ArgumentException
      Copies the entire settings from another settings instance
      Parameters:
      settings - - ISettings object
      Throws:
      ArgumentException

    • setDefaultStructureCellWidth

      void setDefaultStructureCellWidth(int width)
      Sets the default Structure Cell width
      Parameters:
      width - - Width of the Structure Cell

    • getDefaultStructureCellWidth

      int getDefaultStructureCellWidth()
      Gets the default Structure Cell width
      Returns:
      Width of the Structure Cell

    • setDefaultStructureCellHeight

      void setDefaultStructureCellHeight(int height)
      Sets the default Structure Cell height
      Parameters:
      height - - Height of the Structure Cell

    • getDefaultStructureCellHeight

      int getDefaultStructureCellHeight()
      Gets the default Structure Cell height
      Returns:
      Height of the Structure Cell

    • getValidateImageSettings

      boolean getValidateImageSettings()
      The default values is True, which means that the system runs an extra validation on the rendering settings string before using it.
      Returns:
      - true if the application runs an extra validation on the image rendering settings (string).

    • setValidateImageSettings

      void setValidateImageSettings(boolean validate)
      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.

    • getCardLayoutSettings

      ICardLayout getCardLayoutSettings()
      Retrieve card layout report settings.
      Returns:
      : Card layout settings for card layout reports.

    • setCardLayoutSettings

      void setCardLayoutSettings(ICardLayout layout)
      Store the new card layout settings to this global settings.

    • getConditionalFormatting

      Set<PropertyColoring> getConditionalFormatting()
      Retrieve conditional formatting to amend it.
      Returns:
      : dictionary of property coloring objects

    • getTableCellFormats

      IPropertyTableCellFormats getTableCellFormats()
      Retrieve the defined/default cell formats of the property table. These formats are override-able programmatically.