Package adams.flow.transformer.pdfproclet

Class Image

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, PdfProclet, PdfProcletWithAbsolutePosition, PdfProcletWithFilenameOutput, PdfProcletWithOptionalAbsolutePosition, PdfProcletWithPageBreaks, Serializable
    public class Image
extends AbstractPdfProcletWithPageBreaks
implements PdfProcletWithOptionalAbsolutePosition
    Adds GIF, JPEG and PNG image files. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -regexp-filename <adams.core.base.BaseRegExp> (property: regExpFilename)
    The regular expression that the filename must match.
    default: .*
    more: https://docs.oracle.com/javase/tutorial/essential/regex/
    https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html
 
    -add-filename <boolean> (property: addFilename)
    Whether to add the file name before the actual file content as separate
    paragraph.
    default: false
 
    -font-filename <adams.core.io.PdfFont> (property: fontFilename)
    The font to use for printing the file name header.
    default: Helvetica-Bold-12
 
    -color-filename <java.awt.Color> (property: colorFilename)
    The color to use for printing the file name header.
    default: #000000
 
    -page-break-before <boolean> (property: pageBreakBefore)
    If true, then a page-break is added before the content of the file is inserted.
    default: false
 
    -page-break-after <boolean> (property: pageBreakAfter)
    If true, then a page-break is added after the content of the file is inserted.
    default: false
 
    -num-files <int> (property: numFilesPerPage)
    The number of files to put on a page before adding an automatic page break;
     use -1 for unlimited.
    default: -1
    minimum: -1
 
    -rotation <int> (property: rotation)
    The rotation in degrees.
    default: 0
    minimum: 0
    maximum: 360
 
    -scale <double> (property: scale)
    The scaling factor for the image, ie, scaling it to the page dimensions;
    use 0 to turn scaling off.
    default: 1.0
    minimum: 0.0
    maximum: 1.0
 
    -use-absolute-position <boolean> (property: useAbsolutePosition)
    If enabled, the absolute position is used (from bottom-left corner).
    default: false
 
    -x <float> (property: X)
    The absolute X position.
    default: 0.0
    minimum: 0.0
 
    -y <float> (property: Y)
    The absolute Y position.
    default: 0.0
    minimum: 0.0
 
    -scaling-type <SCALE_TO_FIT|SCALE_PERCENT> (property: scalingType)
    The type of scaling to use.
    default: SCALE_TO_FIT
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Rotation

        protected int m_Rotation
        the degrees to rotate images.

      • m_Scale

        protected double m_Scale
        the percentage (0-1) to scale the images to.

      • m_UseAbsolutePosition

        protected boolean m_UseAbsolutePosition
        whether to use absolute position.

      • m_X

        protected float m_X
        the absolute X position.

      • m_Y

        protected float m_Y
        the absolute Y position.

      • m_ScalingType

        protected Image.ScalingType m_ScalingType
        the type of scaling to use.

    • Constructor Detail

      • Image

        public Image()