GroupDocs.Viewer for Java 21.11 Release Notes

   /**
   * Scalable Vector Graphics File (.svgz) is a Scalar Vector Graphics file that uses XML based text format, compressed by GZIP for describing the appearance of an image.
   * Learn more about this file format <a href="https://docs.fileformat.com/image/svgz/">here</a>.
   */
   SVGZ("Compressed Scalable Vector Graphics File", ".svgz"),

   /**
    * <p>
    * Lotus Notes Database (.nsf)
    * Learn more about this file format https://docs.fileformat.com/database/nsf/
    * </p>
    */
   NSF("Lotus Notes Database", ".nsf")

   /**
    * <p>
    * Photoshop Large Document Format (.psb) represents Photoshop Large Document Format used for graphics designing and development.
    * Learn more about this file format <a href="https://docs.fileformat.com/image/psb">here</a>.
    * </p>
    */
   PSB("Photoshop Large Document Format", ".psb")

   /**
    * <p>
    * Corel Exchange (.cmx) is a drawing image file that may contain vector graphics as well as bitmap graphics.
    * Learn more about this file format <a href="https://docs.fileformat.com/image/cmx">here</a>.
    * </p>
    */
   CMX("Corel Metafile exchange", ".cmx")

   /**
    * <p>
    * Enhanced Windows Metafile compressed (.emz) represents graphical images device-independently compressed by GZIP. Metafiles of EMF comprises of variable-length records in chronological order that can render the stored image after parsing on any output device.
    * Learn more about this file format <a href="https://docs.fileformat.com/image/emz">here</a>.
    * </p>
    */
   EMZ("Windows Compressed Enhanced Metafile", ".emz")

   /**
    * <p>
    * ompressed Windows Metafile (.wmz) represents Microsoft Windows Metafile (WMF) compressed in GZIP archvive - for storing vector as well as bitmap-format images data.
    * Learn more about this file format <a href="https://docs.fileformat.com/image/wmz/">here</a>.
    * </p>
    */
   WMZ("Compressed Windows Metafilee", ".wmz")

   /**
    * Microsoft Compiled HTML Help File (.chm) is a well-known format for HELP (documentation to some application) documents.
    * Learn more about this file format <a href="https://docs.fileformat.com/web/chm/">here</a>.
    */
   CHM("Microsoft Compiled HTML Help File", ".chm")

   /**
    * Adobe Illustrator (.ai) is a file format for Adobe Illustrator drawings.
    * Learn more about this file format <a href="https://docs.fileformat.com/image/ai/">here</a>.
    */
   AI("Adobe Illustrator", ".ai")

   /**
    * Truevision TGA (Truevision Advanced Raster Adapter - TARGA) is used to store bitmap digital images developed by TRUEVISION.
    * Learn more about this file format <a href="https://docs.fileformat.com/image/tga">here</a>.
    */
   TGA("Truevision TGA (TARGA)", ".tga")

   /**
    * Animated Portable Network Graphic (.apng) is extension of  PNG format that support animation.
    * Learn more about this file format <a href="https://docs.fileformat.com/image/apng">here</a>.
    */
   APNG("Animated Portable Network Graphic", ".apng")

   /**
    * Email Mailbox File (.mbox)
    * Learn more about this file format <a href="https://docs.fileformat.com/email/mbox/">here</a>.
    */
   MBOX("Email Mailbox File", ".mbox")

  /**
   * Extracts file extension and maps it to file type.
   *
   * @param filePath The file name or file path.
   * @return When file type is supported returns it, otherwise returns default {@link FileType.UNKNOWN} file type.
   */
  public static FileType fromFilePath(String filePath) { ... }

/**
 * The Visio files processing documents view options.
 */
public class VisioRenderingOptions {
  /**
   * Render only Visio figures, not a diagram
   */
  public boolean isRenderFiguresOnly() { ... }

  /**
   * Render only Visio figures, not a diagram
   */
  public void setRenderFiguresOnly(boolean renderFiguresOnly) { ... }

  /**
   * Figure width, height will be calculated automatically
   */
  public int getFigureWidth() { ... }

  /**
   * Figure width, height will be calculated automatically. Default value is 100.
   */
  public void setFigureWidth(int figureWidth) { ... }


  /**
   * Initializes new instance of VisioRenderingOptions class.
   */
  public VisioRenderingOptions() { ... }
}

/**
 * <p>
 * Represents logger implementation which sends all messages to console.
 * </p>
 */
public final class ConsoleLogger implements ILogger {

  /**
   * Initializes a new instance of the ConsoleLogger class
   */
  public ConsoleLogger() { ... }

  public ConsoleLogger(boolean isTraceEnabled) { ... }

  public ConsoleLogger(boolean isTraceEnabled, boolean isDebugEnabled) { ... }

  public ConsoleLogger(boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled) { ... }

  public void setTraceEnabled(boolean isTraceEnabled) { ... }

  public void setDebugEnabled(boolean isDebugEnabled) { ... }

  public void setWarningEnabled(boolean isWarningEnabled) { ... }

  public void setErrorEnabled(boolean isErrorEnabled) { ... }

  /**
   * Writes a trace message to the console.
   * Trace log messages provide detailed information about application flow.
   * @param message   The trace message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void trace(String message, Object... arguments) { ... }

  /**
   * Writes a trace message to the console.
   * Trace log messages provide detailed information about application flow.
   * @param throwable The throwable object
   * @param message   The trace message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void trace(Throwable throwable, String message, Object... arguments) { ... }

  public boolean isTraceEnabled() { ... }

  /**
   * Writes a debug message to the console.
   * Debug log messages provide generally useful information about application flow.
   * @param message   The debug message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void debug(String message, Object... arguments) { ... }

  /**
   * Writes a debug message to the console.
   * Debug log messages provide generally useful information about application flow.
   * @param throwable The throwable object
   * @param message   The debug message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void debug(Throwable throwable, String message, Object... arguments) { ... }

  public boolean isDebugEnabled() { ... }

  /**
   * Writes a warning message to the console.
   * Warning log messages provide information about unexpected and recoverable events in application flow.
   * @param message   The warning message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void warning(String message, Object... arguments) { ... }

  /**
   * Writes a warning message to the console.
   * Warning log messages provide information about unexpected and recoverable events in application flow.
   * @param throwable The throwable object
   * @param message   The warning message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void warning(Throwable throwable, String message, Object... arguments) { ... }

  public boolean isWarningEnabled() { ... }

  /**
   * Writes an error message to the console.
   * Error log messages provide information about unrecoverable events in application flow.
   * @param message   The error message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void error(String message, Object... arguments) { ... }

  /**
   * Writes an error message to the console.
   * Error log messages provide information about unrecoverable events in application flow.
   * @param throwable The throwable object
   * @param message   The error message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void error(Throwable throwable, String message, Object... arguments) { ... }

  public boolean isErrorEnabled() { ... }
}

/**
 * Writes log messages to the file.
 */
public class FileLogger implements ILogger {
  private final String mFileName;
  private final boolean mTraceEnabled;
  private final boolean mDebugEnabled;
  private final boolean mWarningEnabled;
  private final boolean mErrorEnabled;

  /**
   * Create logger to file.
   *
   * @param fileName Full file name with path
   */
  public FileLogger(String fileName) { ... }

  /**
   * Create logger to file.
   */
  public FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled) { ... }

  public void setTraceEnabled(boolean isTraceEnabled) { ... }

  public void setDebugEnabled(boolean isDebugEnabled) { ... }

  public void setWarningEnabled(boolean isWarningEnabled) { ... }

  public void setErrorEnabled(boolean isErrorEnabled) { ... }

  /**
   * Writes a trace message to the file.
   * Trace log messages provide detailed information about application flow.
   * @param message   The trace message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void trace(String message, Object... arguments) { ... }

  /**
   * Writes a trace message to the file.
   * Trace log messages provide detailed information about application flow.
   * @param throwable The throwable object
   * @param message   The trace message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void trace(Throwable throwable, String message, Object... arguments) { ... }

  public boolean isTraceEnabled() { ... }

  /**
   * Writes a debug message to the file.
   * Debug log messages provide generally useful information about application flow.
   * @param message   The debug message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void debug(String message, Object... arguments) { ... }

  /**
   * Writes a debug message to the file.
   * Debug log messages provide generally useful information about application flow.
   * @param throwable The throwable object
   * @param message   The debug message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void debug(Throwable throwable, String message, Object... arguments) { ... }

  public boolean isDebugEnabled() { ... }

  /**
   * Writes a warning message to the file.
   * Warning log messages provide information about unexpected and recoverable events in application flow.
   * @param message   The warning message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void warning(String message, Object... arguments) { ... }

  /**
   * Writes a warning message to the file.
   * Warning log messages provide information about unexpected and recoverable events in application flow.
   * @param throwable The throwable object
   * @param message   The warning message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void warning(Throwable throwable, String message, Object... arguments) { ... }

  public boolean isWarningEnabled() { ... }

  /**
   * Writes an error message to the file.
   * Error log messages provide information about unrecoverable events in application flow.
   * @param message   The error message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void error(String message, Object... arguments) { ... }

  /**
   * Writes an error message to the file.
   * Error log messages provide information about unrecoverable events in application flow.
   * @param throwable The throwable object
   * @param message   The error message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  public void error(Throwable throwable, String message, Object... arguments) { ... }

  public boolean isErrorEnabled() { ... }
}

/**
 * Defines the methods that are used to perform logging.
 */
public interface ILogger {

  void setTraceEnabled(boolean isTraceEnabled);

  void setDebugEnabled(boolean isDebugEnabled);

  void setWarningEnabled(boolean isWarningEnabled);

  void setErrorEnabled(boolean isErrorEnabled);

  /**
   * Writes a trace message to the file.
   * Trace log messages provide detailed information about application flow.
   * @param message   The trace message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  void trace(String message, Object... arguments);

  /**
   * Writes a trace message to the file.
   * Trace log messages provide detailed information about application flow.
   * @param throwable The throwable object
   * @param message   The trace message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  void trace(Throwable throwable, String message, Object... arguments);

  boolean isTraceEnabled();

  /**
   * Writes a debug message to the file.
   * Debug log messages provide generally useful information about application flow.
   * @param message   The debug message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  void debug(String message, Object... arguments);

  /**
   * Writes a debug message to the file.
   * Debug log messages provide generally useful information about application flow.
   * @param throwable The throwable object
   * @param message   The debug message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  void debug(Throwable throwable, String message, Object... arguments);

  boolean isDebugEnabled();

  /**
   * Writes a warning message to the file.
   * Warning log messages provide information about unexpected and recoverable events in application flow.
   * @param message   The warning message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  void warning(String message, Object... arguments);

  /**
   * Writes a warning message to the file.
   * Warning log messages provide information about unexpected and recoverable events in application flow.
   * @param throwable The throwable object
   * @param message   The warning message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  void warning(Throwable throwable, String message, Object... arguments);

  boolean isWarningEnabled();

  /**
   * Writes an error message to the file.
   * Error log messages provide information about unrecoverable events in application flow.
   * @param message   The error message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  void error(String message, Object... arguments);

  /**
   * Writes an error message to the file.
   * Error log messages provide information about unrecoverable events in application flow.
   * @param throwable The throwable object
   * @param message   The error message, can contain {} to be replaced with arguments
   * @param arguments The arguments, replaces {} in message in order of passing
   */
  void error(Throwable throwable, String message, Object... arguments);

  boolean isErrorEnabled();
}

  /**
   * The logger implementation used for logging (Errors, Warnings, Traces).
   */
  public ILogger getLogger() { ... }

  /**
   * Initializes new instance of ViewerSettings class.
   * @param cache The cache.
   * @param logger The logger.
   */
  public ViewerSettings(ICache cache, ILogger logger) { ... }

// The following constructors has been added
public Viewer(InputStream stream, boolean leaveOpen)
public Viewer(InputStream stream, LoadOptions loadOptions, boolean leaveOpen)
public Viewer(InputStream stream, ViewerSettings settings, boolean leaveOpen)
public Viewer(InputStream stream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen)

  /**
   * Provides options for rendering Mail storage (Lotus Notes, MBox) data files.
   */
  public class MailStorageOptions {

    /**
     * The keywords used to filter messages.
     */
    public String getTextFilter() { ...}

    /**
     * Sets the keywords used to filter messages.
     *
     * @param textFilter the keywords used to filter messages.
     */
    public void setTextFilter(String textFilter) { ...}

    /**
     * The email-address used to filter messages by sender or recipient.
     *
     * @return The email-address
     */
    public String getAddressFilter() { ...}

    /**
     * Sets email-address used to filter messages by sender or recipient.
     *
     * @param addressFilter the email-address used to filter messages
     */
    public void setAddressFilter(String addressFilter) { ...}

    /**
     * The maximum number of messages or items for render.
     * <p>
     * Lotus notes data files can be large and retrieving all messages can take significant time.
     * This setting limits maximum number of messages or items that are rendered.
     * Default value is 0 - all messages will be rendered
     */
    public int getMaxItems() { ...}

    /**
     * Sets maximum number of messages or items for render.
     * <p>
     * Lotus notes data files can be large and retrieving all messages can take significant time.
     * This setting limits maximum number of messages or items that are rendered.
     * Default value is 0 - all messages will be rendered
     *
     * @param maxItems Maximum number of messages
     */
    public void setMaxItems(int maxItems) { ...}
  }

/**
 * Lotus Notes storage data files view options.
 */
public MailStorageOptions getMailStorageOptions() { ... }

/**
 * Lotus Notes storage data files view options.
 */
public void setMailStorageOptions(MailStorageOptions options) { ... }

  /**
   * Limits of image size options interface.
   */
  public interface IMaxSizeOptions {
    /**
     * Max width of an output image in pixels.
     */
    int getMaxWidth();

    /**
     * Max width of an output image in pixels.
     */
    void setMaxWidth(int maxWidth);

    /**
     * Max height of an output image in pixels.
     */
    int getMaxHeight();

    /**
     * Max height of an output image in pixels.
     */
    void setMaxHeight(int maxHeight);
  }

  /**
   * Max width of an output image in pixels.
   */
  int getMaxWidth();

  /**
   * Max width of an output image in pixels.
   */
  void setMaxWidth(int maxWidth);

  /**
   * Max height of an output image in pixels.
   */
  int getMaxHeight();

  /**
   * Max height of an output image in pixels.
   */
  void setMaxHeight(int maxHeight);

  /**
   * Time Format (can be included TimeZone)
   * for example: 'MM d yyyy HH:mm tt', if not set - current system format is used
   */
  public String getDateTimeFormat() { ... }

  /**
   * Time Format (can be included TimeZone)
   * for example: 'MM d yyyy HH:mm tt', if not set - current system format is used
   */
  public void setDateTimeFormat(String dateTimeFormat) { ... }

  /**
   * Message time zone offset
   */
  public TimeZone getTimeZoneOffset() { ... }

  /**
   * Message time zone offset
   */
  public void setTimeZoneOffset(TimeZone timeZoneOffset) { ... }

    /**
     * Attachment relative path e.g. "folder/file.docx"</example>" or filename when the file is located in the root of an archive, in e-mail message or data file.
     */
    String getFilePath() { ... }

/**
 * Max width of the output image (for rendering to PNG/JPG only)
 */
public int getMaxWidth() { ... }

/**
 * Max width of the output image (for rendering to PNG/JPG only)
 */
public void setMaxWidth(int maxWidth) { ... }

/**
 * Max height of the output image (for rendering to PNG/JPG only)
 */
public int getMaxHeight() { ... }

/**
 * Max height of the output image (for rendering to PNG/JPG only)
 */
public void setMaxHeight(int maxHeight) { ... }

/**
 * Image width (for rendering to PNG/JPG only)
 */
public int getWidth() { ... }

/**
 * Image width (for rendering to PNG/JPG only)
 */
public void setWidth(int width) { ... }

/**
 * Image height (for rendering to PNG/JPG only)
 */
public int getHeight() { ... }

/**
 * Image height (for rendering to PNG/JPG only)
 */
public void setHeight(int height) { ... }

    try (Viewer viewer = new Viewer("document.one")) {
        JpgViewOptions options = new JpgViewOptions("result_{0}.jpg");
        options.setQuality(50);

        viewer.view(options);
    }

/**
 * Max width of an output image in pixels. (When converting single image to HTML only)
 */
public int getImageMaxWidth() { ... }

/**
 * Max width of an output image in pixels. (When converting single image to HTML only)
 */
public void setImageMaxWidth(int imageMaxWidth) { ... }

/**
 * Max height of an output image in pixels. (When converting single image to HTML only)
 */
public int getImageMaxHeight() { ... }

/**
 * Max height of an output image in pixels. (When converting single image to HTML only)
 */
public void setImageMaxHeight(int imageMaxHeight) { ... }

/**
 * The width of the output image in pixels. (When converting single image to HTML only)
 */
public int getImageWidth() { ... }

/**
 * The width of the output image in pixels. (When converting single image to HTML only)
 */
public void setImageWidth(int imageWidth) { ... }

/**
 * The height of an output image in pixels. (When converting single image to HTML only)
 */
public int getImageHeight() { ... }

/**
 * The height of an output image in pixels. (When converting single image to HTML only)
 */
public void setImageHeight(int imageHeight) { ... }

  /**
   * Text files splitting to pages options.
   */
  public TextOptions getTextOptions() { ... }

  /**
   * Text files splitting to pages options.
   */
  public void setTextOptions(TextOptions textOptions) { .. }

  /**
   * Text files splitting to pages options.
   */
  public class TextOptions {

    /**
     * Max chars per row on page. Default value is 85.
     */
    public int getMaxCharsPerRow() { ... }

    /**
     * Max chars per row on page. Default value is 85.
     */
    public void setMaxCharsPerRow(int maxCharsPerRow) { ... }

    /**
     * Max rows per page. Default value is 55.
     */
    public int getMaxRowsPerPage() { ... }

    /**
     * Max rows per page. Default value is 55.
     */
    public void setMaxRowsPerPage(int maxRowsPerPage) { ... }
  }

  /**
   * Initializes new instance of {@link ViewInfoOptions} class to retrieve information about view when rendering into HTML.
   *
   * @return New instance of {@link ViewInfoOptions} class.
   */
  public static ViewInfoOptions forHtmlView() { ... }

  /**
   * Initializes new instance of {@link ViewInfoOptions} class to retrieve information about view when rendering into JPG.
   *
   * @return New instance of {@link ViewInfoOptions} class.
   */
  public static ViewInfoOptions forJpgView() { ... }


  /**
   * Initializes new instance of {@link ViewInfoOptions} class to retrieve information about view when rendering into PNG.
   *
   * @return New instance of {@link ViewInfoOptions} class.
   */
  public static ViewInfoOptions forPngView() { ... }