Package adams.gui.print

Class ScalableComponentWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.print.JComponentWriter

adams.gui.print.ScalableComponentWriter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

BufferedImageBasedWriter, PostscriptWriter

public abstract class ScalableComponentWriter
extends JComponentWriter

Abstract ancestor for scalable writers.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_ScalingEnabled	whether scaling is enabled.
protected double	m_xScale	the x scale factor.
protected double	m_yScale	the y scale factor.

Fields inherited from class adams.gui.print.JComponentWriter

m_Component, m_CustomHeight, m_CustomWidth, m_Enabled, m_OutputFile, m_UseCustomDimensions

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
ScalableComponentWriter()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getScalingEnabled()	Whether scaling is enabled or ignored.
double	getXScale()	returns the scale factor for the x-axis.
double	getYScale()	returns the scale factor for the y-axis.
String	scalingEnabledTipText()	Returns the tip text for this property.
void	setScalingEnabled(boolean value)	sets whether to enable scaling.
void	setXScale(double value)	Sets the scale factor.
void	setYScale(double value)	sets the Y scale factor.
String	XScaleTipText()	Returns the tip text for this property.
String	YScaleTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.print.JComponentWriter

customHeightTipText, customWidthTipText, enabledTipText, fileTipText, forCommandLine, forName, generateOutput, getComponent, getCustomHeight, getCustomWidth, getDescription, getEnabled, getExtensions, getFile, getFileFilters, getUseCustomDimensions, getWriterForExtension, getWriterForFile, getWriterForFile, getWriters, main, setComponent, setCustomHeight, setCustomWidth, setEnabled, setFile, setUseCustomDimensions, toOutput, toOutput, toOutput, useCustomDimensionsTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_xScale

protected double m_xScale

the x scale factor.

m_yScale

protected double m_yScale

the y scale factor.

m_ScalingEnabled

protected boolean m_ScalingEnabled

whether scaling is enabled.

Constructor Detail

ScalableComponentWriter

public ScalableComponentWriter()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class JComponentWriter

setScalingEnabled

public void setScalingEnabled(boolean value)

sets whether to enable scaling.

Parameters:

value - whether scaling is enabled

getScalingEnabled

public boolean getScalingEnabled()

Whether scaling is enabled or ignored.

Returns:

true if scaling is enabled

scalingEnabledTipText

public String scalingEnabledTipText()

Returns the tip text for this property.

Returns:

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

setXScale

public void setXScale(double value)

Sets the scale factor.

Parameters:

value - the scale factor for the x-axis

getXScale

public double getXScale()

returns the scale factor for the x-axis.

Returns:

the scale factor for the x-axis

XScaleTipText

public String XScaleTipText()

Returns the tip text for this property.

Returns:

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

setYScale

public void setYScale(double value)

sets the Y scale factor.

Parameters:

value - the scale factor for the y-axis

getYScale

public double getYScale()

returns the scale factor for the y-axis.

Returns:

the scale factor for the y-axis

YScaleTipText

public String YScaleTipText()

Returns the tip text for this property.

Returns:

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