Package adams.gui.visualization.image.selectionshape

Class AbstractStrokeSelectionShapePainter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.image.selectionshape.AbstractSelectionShapePainter

adams.gui.visualization.image.selectionshape.AbstractStrokeSelectionShapePainter

All Implemented Interfaces:

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

Direct Known Subclasses:

PolygonPainter, RectanglePainter

public abstract class AbstractStrokeSelectionShapePainter
extends AbstractSelectionShapePainter
implements StrokeSelectionShapePainter

For selection shape painters that use a stroke.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected float	m_StrokeThickness	the thickness of the stroke.

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

Method Summary

Modifier and Type	Method	Description
protected void	applyStroke(Graphics g, float stroke)	Applies the stroke thickness.
void	defineOptions()	Adds options to the internal list of options.
protected void	doPaintSelectionShape(ImagePanel.PaintPanel owner, Graphics g, Point topLeft, Point bottomRight, List<Point> trace)	Paints the selection shape.
protected abstract void	doPaintSelectionShapeWithStroke(ImagePanel.PaintPanel owner, Graphics g, Point topLeft, Point bottomRight, List<Point> trace)	Paints the selection shape.
float	getStrokeThickness()	Returns the current stroke thickness.
protected float	getStrokeWidth(Graphics g, float defValue)	Returns the thickness of the stroke.
void	setStrokeThickness(float value)	Sets the stroke thickness to use.
String	strokeThicknessTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.image.selectionshape.AbstractSelectionShapePainter

canPaint, paintSelectionShape

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.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.gui.visualization.image.selectionshape.SelectionShapePainter

canAddTracePoint, paintSelectionShape

Field Detail

m_StrokeThickness

protected float m_StrokeThickness

the thickness of the stroke.

Constructor Detail

AbstractStrokeSelectionShapePainter

public AbstractStrokeSelectionShapePainter()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setStrokeThickness

public void setStrokeThickness(float value)

Sets the stroke thickness to use.

Specified by:

setStrokeThickness in interface StrokeSelectionShapePainter

Parameters:

value - the thickness

getStrokeThickness

public float getStrokeThickness()

Returns the current stroke thickness.

Specified by:

getStrokeThickness in interface StrokeSelectionShapePainter

Returns:

the thickness

strokeThicknessTipText

public String strokeThicknessTipText()

Returns the tip text for this property.

Specified by:

strokeThicknessTipText in interface StrokeSelectionShapePainter

Returns:

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

getStrokeWidth

protected float getStrokeWidth(Graphics g,
                               float defValue)

Returns the thickness of the stroke.

Parameters:

g - graphics context to get the thickness from

defValue - the default value to return in case of failure

Returns:

the stroke, default value if failed to extract

applyStroke

protected void applyStroke(Graphics g,
                           float stroke)

Applies the stroke thickness.

Parameters:

stroke - the thickness to apply

doPaintSelectionShape

protected void doPaintSelectionShape(ImagePanel.PaintPanel owner,
                                     Graphics g,
                                     Point topLeft,
                                     Point bottomRight,
                                     List<Point> trace)

Paints the selection shape.

Specified by:

doPaintSelectionShape in class AbstractSelectionShapePainter

Parameters:

owner - the panel this shape is used with

g - the graphics context

topLeft - the top-left corner

bottomRight - the bottom-right corner

trace - the mouse movement trace

doPaintSelectionShapeWithStroke

protected abstract void doPaintSelectionShapeWithStroke(ImagePanel.PaintPanel owner,
                                                        Graphics g,
                                                        Point topLeft,
                                                        Point bottomRight,
                                                        List<Point> trace)

Paints the selection shape.

Parameters:

owner - the panel this shape is used with

g - the graphics context

topLeft - the top-left corner

bottomRight - the bottom-right corner

trace - the mouse movement trace