Class ScalingOptions

java.lang.Object
org.xhtmlrenderer.util.ScalingOptions

public class ScalingOptions extends Object
Encapsulates a set of parameters related to scaling quality and output. Values are final once constructed, except for target width and height, which can be change and the options instance reused. There is a default constructor for average quality and performance.
  • Field Details

    • downscalingHint

      private final DownscaleQuality downscalingHint
    • renderingHint

      private final Object renderingHint
    • targetWidth

      private final int targetWidth
    • targetHeight

      private final int targetHeight
  • Constructor Details

    • ScalingOptions

      public ScalingOptions(int targetWidth, int targetHeight, DownscaleQuality downscalingHint, Object hint)
      Constructor with all options.
      Parameters:
      targetWidth - Target width in pixels of image once scaled
      targetHeight - Target height in pixels of image once scaled
      downscalingHint - Directs downscaling quality. One of the enumerated types of DownscaleQuality such as DownscaleQuality.FAST.
      hint - Hint for interpolation to AWT image renderer, one of the Object constants from RenderingHints using RenderingHints.KEY_INTERPOLATION
  • Method Details

    • getDownscalingHint

      public DownscaleQuality getDownscalingHint()
    • getRenderingHint

      public Object getRenderingHint()
    • applyRenderingHints

      public void applyRenderingHints(Graphics2D g2)
      Applies any rendering hints configured for these ScalingOptions to a Graphics2D instance before image operations are called on it. These might be
      Parameters:
      g2 - A Graphics2D instance on which scaled images will be rendered.
    • getRenderingHints

      protected Map<RenderingHints.Key,Object> getRenderingHints()
      Returns a Map of image rendering hints applicable to Graphics2D.setRenderingHints(java.util.Map). By default, this will only include the interpolation hint specified for this ScalingOptions. Other hints could be added in an overridden version in a subclass.
      Returns:
      Map of rendering hints.
    • sizeMatches

      public boolean sizeMatches(int w, int h)
      Returns true if the target size specified by these options matches the size provided (e.g. image is already at target size).
      Parameters:
      w - an image width
      h - an image height
      Returns:
      true if image dimensions already match target size
    • getTargetWidth

      public int getTargetWidth()
    • getTargetHeight

      public int getTargetHeight()
    • withTarget

      public ScalingOptions withTarget(int targetWidth, int targetHeight)