Package adams.flow.transformer.pdfproclet

Class Line

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, PdfProclet, PdfProcletWithVariableFileExtension, Serializable
    public class Line
extends AbstractPdfProclet
implements PdfProcletWithVariableFileExtension
    Draws a line. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -regexp-filename <adams.core.base.BaseRegExp> (property: regExpFilename)
    The regular expression that the filename must match.
    default: .*
 
    -extension <adams.core.base.BaseString> [-extension ...] (property: extensions)
    The file extension(s) that the processor will be used for.
    default: *
 
    -x1 <float> (property: X1)
    The absolute X1 position.
    default: 0.0
    minimum: 0.0
 
    -y1 <float> (property: Y1)
    The absolute Y1 position.
    default: 0.0
    minimum: 0.0
 
    -x2 <float> (property: X2)
    The absolute X2 position.
    default: 10.0
    minimum: 0.001
 
    -y2 <float> (property: Y2)
    The absolute Y2 position.
    default: 10.0
    minimum: 0.001
 
    -color <java.awt.Color> (property: color)
    The color of the rectangle.
    default: #000000
 
    -line-width <float> (property: lineWidth)
    The line width.
    default: 1.0
    minimum: 0.001
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Extensions

        protected BaseString[] m_Extensions
        the file extensions.

      • m_X1

        protected float m_X1
        the absolute X1 position.

      • m_Y1

        protected float m_Y1
        the absolute Y1 position.

      • m_X2

        protected float m_X2
        the absolute X2 position.

      • m_Y2

        protected float m_Y2
        the absolute Y2 position.

      • m_Color

        protected Color m_Color
        the color.

      • m_LineWidth

        protected float m_LineWidth
        the line width.

    • Constructor Detail

      • Line

        public Line()

    • Method Detail

      • setX1

        public void setX1​(float value)
        Sets the absolute X1 position.
        Parameters:
        value - the X1 position

      • getX1

        public float getX1()
        Returns the absolute X1 position.
        Returns:
        the X1 position

      • X1TipText

        public String X1TipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setY1

        public void setY1​(float value)
        Sets the absolute Y1 position.
        Parameters:
        value - the Y1 position

      • getY1

        public float getY1()
        Returns the absolute Y1 position.
        Returns:
        the Y1 position

      • Y1TipText

        public String Y1TipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setX2

        public void setX2​(float value)
        Sets the absolute X2 position.
        Parameters:
        value - the X2 position

      • getX2

        public float getX2()
        Returns the absolute X2 position.
        Returns:
        the X2 position

      • X2TipText

        public String X2TipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setY2

        public void setY2​(float value)
        Sets the absolute Y2 position.
        Parameters:
        value - the Y2 position

      • getY2

        public float getY2()
        Returns the absolute Y2 position.
        Returns:
        the Y2 position

      • Y2TipText

        public String Y2TipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setColor

        public void setColor​(Color value)
        Sets the color.
        Parameters:
        value - the color

      • getColor

        public Color getColor()
        Returns the color.
        Returns:
        the color

      • colorTipText

        public String colorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setLineWidth

        public void setLineWidth​(float value)
        Sets the line width.
        Parameters:
        value - the line width

      • getLineWidth

        public float getLineWidth()
        Returns the line width.
        Returns:
        the line width

      • lineWidthTipText

        public String lineWidthTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • doProcess

        protected boolean doProcess​(PDFGenerator generator,
                            File file)
                     throws Exception
        The actual processing of the document.
        Specified by:
        doProcess in class AbstractPdfProclet
        Parameters:
        generator - the context
        file - the file to add
        Returns:
        true if successfully added
        Throws:
        Exception - if something goes wrong

      • canProcess

        public boolean canProcess​(PDFGenerator generator,
                          Object obj)
        Whether the processor can handle this particular object.
        Specified by:
        canProcess in interface PdfProclet
        Specified by:
        canProcess in class AbstractPdfProclet
        Parameters:
        generator - the context
        obj - the object to check
        Returns:
        true if the object can be handled

      • doProcess

        protected boolean doProcess​(PDFGenerator generator,
                            Object obj)
                     throws Exception
        The actual processing of the document.
        Specified by:
        doProcess in class AbstractPdfProclet
        Parameters:
        generator - the context
        obj - the object to add
        Returns:
        true if successfully added
        Throws:
        Exception - if something goes wrong