adams.gui.print
Class PDFWriter

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.gui.print.JComponentWriter
              adams.gui.print.ScalableComponentWriter
                  adams.gui.print.BufferedImageBasedWriter
                      adams.gui.print.PDFWriter

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, SizeOfHandler, Serializable

public class PDFWriter
extends BufferedImageBasedWriter

Outputs PDF documents.

Valid options are:

-D (property: debug)
    If set to true, scheme may output additional info to the console.
 

-file <adams.core.io.PlaceholderFile> (property: file)
    The file to save the image to.
    default: .
 

-scaling (property: scalingEnabled)
    If set to true, then scaling will be used.
 

-scale-x <double> (property: XScale)
    The scaling factor for the X-axis.
    default: 1.0
 

-scale-y <double> (property: YScale)
    The scaling factor for the Y axis.
    default: 1.0
 

-custom-dimensions (property: useCustomDimensions)
    Whether to use custom dimensions or use the component's ones.
 

-custom-width <int> (property: customWidth)
    The custom width.
    default: -1
 

-custom-height <int> (property: customHeight)
    The custom height.
    default: -1
 

-background <java.awt.Color> (property: background)
    The background color.
    default: #ffffff
 

-type <RGB|GRAY> (property: type)
    The type of image to create.
    default: RGB
 

-rotation <int> (property: imageRotation)
    The degrees to rotate the images by (0-360).
    default: 0
 

-scale <double> (property: imageScale)
    The scale factor (0-1) for images based on the page size.
    default: 0.9
 

Based on weka.gui.visualize.PDFWriter

Version:

$Revision: 4584 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.gui.print.BufferedImageBasedWriter

BufferedImageBasedWriter.Type

Field Summary

protected int	m_ImageRotation the degrees to rotate images.
protected double	m_ImageScale the percentage (0-1) to scale the images to.

Fields inherited from class adams.gui.print.BufferedImageBasedWriter

m_Background, m_Type

Fields inherited from class adams.gui.print.ScalableComponentWriter

m_ScalingEnabled, m_xScale, m_yScale

Fields inherited from class adams.gui.print.JComponentWriter

m_Component, m_CustomHeight, m_CustomWidth, m_OutputFile, m_UseCustomDimensions

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

PDFWriter()

Method Summary

void	defineOptions() Adds options to the internal list of options.
void	generateOutput() generates the actual output.
String	getDescription() returns the name of the writer, to display in the FileChooser.
String[]	getExtensions() returns the extensions (incl.
int	getImageRotation() Returns the degrees by which to rotate the images.
double	getImageScale() Returns the scale factor (0-1) for images based on the page size.
String	globalInfo() Returns a string describing the object.
String	imageRotationTipText() Returns the tip text for this property.
String	imageScaleTipText() Returns the tip text for this property.
void	setImageRotation(int value) Sets the degrees to rotate the image by.
void	setImageScale(double value) Sets the scale factor (0-1) for images based on the page size.

Methods inherited from class adams.gui.print.BufferedImageBasedWriter

backgroundTipText, createBufferedImage, getBackground, getType, setBackground, setType, typeTipText

Methods inherited from class adams.gui.print.ScalableComponentWriter

getScalingEnabled, getXScale, getYScale, scalingEnabledTipText, setScalingEnabled, setXScale, setYScale, XScaleTipText, YScaleTipText

Methods inherited from class adams.gui.print.JComponentWriter

customHeightTipText, customWidthTipText, fileTipText, forCommandLine, forName, getComponent, getCustomHeight, getCustomWidth, getFile, getFileFilters, getUseCustomDimensions, getWriterForExtension, getWriterForFile, getWriterForFile, getWriters, main, setComponent, setCustomHeight, setCustomWidth, setFile, setUseCustomDimensions, toOutput, toOutput, toOutput, useCustomDimensionsTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_ImageRotation

protected int m_ImageRotation

the degrees to rotate images.

m_ImageScale

protected double m_ImageScale

the percentage (0-1) to scale the images to.

Constructor Detail

PDFWriter

public PDFWriter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getDescription

public String getDescription()

returns the name of the writer, to display in the FileChooser.

Specified by:

getDescription in class JComponentWriter

Returns:

the name of the writer

getExtensions

public String[] getExtensions()

returns the extensions (incl. ".") of the output format, to use in the FileChooser.

Specified by:

getExtensions in class JComponentWriter

Returns:

the file extensions

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class BufferedImageBasedWriter

setImageRotation

public void setImageRotation(int value)

Sets the degrees to rotate the image by.

Parameters:

value - the degrees

getImageRotation

public int getImageRotation()

Returns the degrees by which to rotate the images.

Returns:

the degrees

imageRotationTipText

public String imageRotationTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setImageScale

public void setImageScale(double value)

Sets the scale factor (0-1) for images based on the page size.

Parameters:

value - the scale factor

getImageScale

public double getImageScale()

Returns the scale factor (0-1) for images based on the page size.

Returns:

the scale factor

imageScaleTipText

public String imageScaleTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

generateOutput

public void generateOutput()
                    throws Exception

generates the actual output.

Specified by:

generateOutput in class JComponentWriter

Throws:

Exception - if something goes wrong