Class PlainText
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,SizeOfHandler
,PdfProclet
,PdfProcletWithAbsolutePosition
,PdfProcletWithFilenameOutput
,PdfProcletWithOptionalAbsolutePosition
,PdfProcletWithPageBreaks
,PdfProcletWithVariableFileExtension
,Serializable
public class PlainText extends AbstractPdfProcletWithPageBreaks implements PdfProcletWithVariableFileExtension, PdfProcletWithOptionalAbsolutePosition
Adds plain-text files line by 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: .*
-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
-font-content <adams.core.io.PdfFont> (property: fontContent) The font to use for the file content. default: Helvetica-Normal-12
-color-content <java.awt.Color> (property: colorContent) The color to use for the content. default: #000000
-extension <adams.core.base.BaseString> [-extension ...] (property: extensions) The file extension(s) that the processor will be used for. default: txt
-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
- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Color
m_ColorContent
the color for the content.protected BaseString[]
m_Extensions
the file extensions.protected PdfFont
m_FontContent
the font for the content.protected boolean
m_UseAbsolutePosition
whether to use absolute position.protected float
m_X
the absolute X position.protected float
m_Y
the absolute Y position.-
Fields inherited from class adams.flow.transformer.pdfproclet.AbstractPdfProcletWithPageBreaks
m_NumFilesPerPage, m_PageBreakAfter, m_PageBreakBefore
-
Fields inherited from class adams.flow.transformer.pdfproclet.AbstractPdfProcletWithFilenameOutput
m_AddFilename, m_ColorFilename, m_FontFilename
-
Fields inherited from class adams.flow.transformer.pdfproclet.AbstractPdfProclet
m_RegExpFilename, MATCH_ALL_EXTENSION
-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
-
Constructor Summary
Constructors Constructor Description PlainText()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canProcess(PDFGenerator generator, Object obj)
Whether the processor can handle this particular object.String
colorContentTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.protected boolean
doProcess(PDFGenerator generator, File file)
The actual processing of the document.protected boolean
doProcess(PDFGenerator generator, Object obj)
The actual processing of the document.protected boolean
doProcess(PDFGenerator generator, List<String> paragraphs)
The actual processing of the document.String
extensionsTipText()
Returns the tip text for this property.String
fontContentTipText()
Returns the tip text for this property.Color
getColorContent()
Returns the color to use for the content.BaseString[]
getExtensions()
Returns the extensions that the processor can process.PdfFont
getFontContent()
Returns the font to use for adding the content.boolean
getUseAbsolutePosition()
Returns whether absolute positioning is used (from bottom-left corner).float
getX()
Returns the absolute X position.float
getY()
Returns the absolute Y position.String
globalInfo()
Returns a short description of the writer.void
setColorContent(Color value)
Sets the color to use for the content.void
setExtensions(BaseString[] value)
Sets the extensions that the processor can process.void
setFontContent(PdfFont value)
Sets the font to use for adding the content.void
setUseAbsolutePosition(boolean value)
Sets whether to use absolute positioning (from bottom-left corner).void
setX(float value)
Sets the absolute X position.void
setY(float value)
Sets the absolute Y position.String
useAbsolutePositionTipText()
Returns the tip text for this property.String
XTipText()
Returns the tip text for this property.String
YTipText()
Returns the tip text for this property.-
Methods inherited from class adams.flow.transformer.pdfproclet.AbstractPdfProcletWithPageBreaks
getNumFilesPerPage, getPageBreakAfter, getPageBreakBefore, numFilesPerPageTipText, pageBreakAfterTipText, pageBreakBeforeTipText, postProcess, postProcess, preProcess, preProcess, setNumFilesPerPage, setPageBreakAfter, setPageBreakBefore
-
Methods inherited from class adams.flow.transformer.pdfproclet.AbstractPdfProcletWithFilenameOutput
addFilename, addFilenameTipText, colorFilenameTipText, fontFilenameTipText, getAddFilename, getColorFilename, getFontFilename, setAddFilename, setColorFilename, setFontFilename
-
Methods inherited from class adams.flow.transformer.pdfproclet.AbstractPdfProclet
addColumnTextAt, addElement, canProcess, getRegExpFilename, process, process, regExpFilenameTipText, setRegExpFilename
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.Destroyable
destroy
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine
-
Methods inherited from interface adams.flow.transformer.pdfproclet.PdfProclet
canProcess, getRegExpFilename, process, process, regExpFilenameTipText, setRegExpFilename
-
-
-
-
Field Detail
-
m_FontContent
protected PdfFont m_FontContent
the font for the content.
-
m_ColorContent
protected Color m_ColorContent
the color for the content.
-
m_Extensions
protected BaseString[] m_Extensions
the file extensions.
-
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.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a short description of the writer.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- Returns:
- a description of the writer
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractPdfProcletWithPageBreaks
-
setFontContent
public void setFontContent(PdfFont value)
Sets the font to use for adding the content.- Parameters:
value
- the font
-
getFontContent
public PdfFont getFontContent()
Returns the font to use for adding the content.- Returns:
- the font
-
fontContentTipText
public String fontContentTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setColorContent
public void setColorContent(Color value)
Sets the color to use for the content.- Parameters:
value
- the color
-
getColorContent
public Color getColorContent()
Returns the color to use for the content.- Returns:
- the color
-
colorContentTipText
public String colorContentTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
getExtensions
public BaseString[] getExtensions()
Returns the extensions that the processor can process.- Specified by:
getExtensions
in interfacePdfProclet
- Specified by:
getExtensions
in interfacePdfProcletWithVariableFileExtension
- Specified by:
getExtensions
in classAbstractPdfProclet
- Returns:
- the extensions (no dot)
-
setExtensions
public void setExtensions(BaseString[] value)
Sets the extensions that the processor can process.- Specified by:
setExtensions
in interfacePdfProcletWithVariableFileExtension
- Parameters:
value
- the extensions (no dot)
-
extensionsTipText
public String extensionsTipText()
Returns the tip text for this property.- Specified by:
extensionsTipText
in interfacePdfProcletWithVariableFileExtension
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setUseAbsolutePosition
public void setUseAbsolutePosition(boolean value)
Sets whether to use absolute positioning (from bottom-left corner).- Specified by:
setUseAbsolutePosition
in interfacePdfProcletWithOptionalAbsolutePosition
- Parameters:
value
- true if absolute
-
getUseAbsolutePosition
public boolean getUseAbsolutePosition()
Returns whether absolute positioning is used (from bottom-left corner).- Specified by:
getUseAbsolutePosition
in interfacePdfProcletWithOptionalAbsolutePosition
- Returns:
- true if absolute
-
useAbsolutePositionTipText
public String useAbsolutePositionTipText()
Returns the tip text for this property.- Specified by:
useAbsolutePositionTipText
in interfacePdfProcletWithOptionalAbsolutePosition
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setX
public void setX(float value)
Sets the absolute X position.- Specified by:
setX
in interfacePdfProcletWithAbsolutePosition
- Specified by:
setX
in interfacePdfProcletWithOptionalAbsolutePosition
- Parameters:
value
- the X position
-
getX
public float getX()
Returns the absolute X position.- Specified by:
getX
in interfacePdfProcletWithAbsolutePosition
- Specified by:
getX
in interfacePdfProcletWithOptionalAbsolutePosition
- Returns:
- the X position
-
XTipText
public String XTipText()
Returns the tip text for this property.- Specified by:
XTipText
in interfacePdfProcletWithAbsolutePosition
- Specified by:
XTipText
in interfacePdfProcletWithOptionalAbsolutePosition
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setY
public void setY(float value)
Sets the absolute Y position.- Specified by:
setY
in interfacePdfProcletWithAbsolutePosition
- Specified by:
setY
in interfacePdfProcletWithOptionalAbsolutePosition
- Parameters:
value
- the Y position
-
getY
public float getY()
Returns the absolute Y position.- Specified by:
getY
in interfacePdfProcletWithAbsolutePosition
- Specified by:
getY
in interfacePdfProcletWithOptionalAbsolutePosition
- Returns:
- the Y position
-
YTipText
public String YTipText()
Returns the tip text for this property.- Specified by:
YTipText
in interfacePdfProcletWithAbsolutePosition
- Specified by:
YTipText
in interfacePdfProcletWithOptionalAbsolutePosition
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
doProcess
protected boolean doProcess(PDFGenerator generator, List<String> paragraphs) throws Exception
The actual processing of the document.- Parameters:
generator
- the contextparagraphs
- the paragraphs to add- Returns:
- true if successfully added
- Throws:
Exception
- if something goes wrong
-
doProcess
protected boolean doProcess(PDFGenerator generator, File file) throws Exception
The actual processing of the document.- Specified by:
doProcess
in classAbstractPdfProclet
- Parameters:
generator
- the contextfile
- 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 interfacePdfProclet
- Specified by:
canProcess
in classAbstractPdfProclet
- Parameters:
generator
- the contextobj
- 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 classAbstractPdfProclet
- Parameters:
generator
- the contextobj
- the object to add- Returns:
- true if successfully added
- Throws:
Exception
- if something goes wrong
-
-