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

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ColorSelectionShapePainter, SelectionShapePainter, StrokeSelectionShapePainter, Serializable
```
public class RectanglePainter
extends AbstractStrokeSelectionShapePainter
implements ColorSelectionShapePainter
```
Paints a simple rectangle, using the top-left and bottom-right coordinates.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected Color m_Color
the color to use.
- Fields inherited from class adams.gui.visualization.image.selectionshape.AbstractStrokeSelectionShapePainter
  m_StrokeThickness
- 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

RectanglePainter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canAddTracePoint(ImagePanel.PaintPanel owner, List<Point> trace, Point p)`	Returns whether the current point is at leats the specified distance away from the last one.
`protected boolean`	`canPaint(ImagePanel.PaintPanel owner, Graphics g, Point topLeft, Point bottomRight, List<Point> trace)`	Checks whether painting is possible.
`String`	`colorTipText()`	Returns the tip text for this property.
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected void`	`doPaintSelectionShapeWithStroke(ImagePanel.PaintPanel owner, Graphics g, Point topLeft, Point bottomRight, List<Point> trace)`	Paints the selection shape.
`Color`	`getColor()`	Returns the color to use.
`String`	`globalInfo()`	Returns a string describing the object.
`void`	`setColor(Color value)`	Sets the color to use.

Methods inherited from class adams.gui.visualization.image.selectionshape.AbstractStrokeSelectionShapePainter
applyStroke, doPaintSelectionShape, getStrokeThickness, getStrokeWidth, setStrokeThickness, strokeThicknessTipText

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

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

- Field Detail
  - m_Color
```
protected Color m_Color
```
    the color to use.
- Constructor Detail
  - RectanglePainter
```
public RectanglePainter()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractStrokeSelectionShapePainter
  - setColor
```
public void setColor(Color value)
```
    Sets the color to use.
    
    Specified by:
    
    setColor in interface ColorSelectionShapePainter
    
    Parameters:
    
    value - the color
  - getColor
```
public Color getColor()
```
    Returns the color to use.
    
    Specified by:
    
    getColor in interface ColorSelectionShapePainter
    
    Returns:
    
    the color
  - colorTipText
```
public String colorTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    colorTipText in interface ColorSelectionShapePainter
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - canAddTracePoint
```
public boolean canAddTracePoint(ImagePanel.PaintPanel owner,
                                List<Point> trace,
                                Point p)
```
    Returns whether the current point is at leats the specified distance away from the last one.
    
    Specified by:
    
    canAddTracePoint in interface SelectionShapePainter
    
    Parameters:
    
    owner - the panel this shape is used with
    
    trace - the trace so far
    
    p - the point to check
    
    Returns:
    
    true if can be added
  - canPaint
```
protected boolean canPaint(ImagePanel.PaintPanel owner,
                           Graphics g,
                           Point topLeft,
                           Point bottomRight,
                           List<Point> trace)
```
    Checks whether painting is possible.
    
    Specified by:
    
    canPaint 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
    
    Returns:
    
    true if painting is possible
  - doPaintSelectionShapeWithStroke
```
protected void doPaintSelectionShapeWithStroke(ImagePanel.PaintPanel owner,
                                               Graphics g,
                                               Point topLeft,
                                               Point bottomRight,
                                               List<Point> trace)
```
    Paints the selection shape.
    
    Specified by:
    
    doPaintSelectionShapeWithStroke in class AbstractStrokeSelectionShapePainter
    
    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

Class RectanglePainter

Field Summary

Fields inherited from class adams.gui.visualization.image.selectionshape.AbstractStrokeSelectionShapePainter

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

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

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

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.Destroyable

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.option.OptionHandler

Methods inherited from interface adams.gui.visualization.image.selectionshape.SelectionShapePainter

Field Detail

m_Color

Constructor Detail

RectanglePainter

Method Detail

globalInfo

defineOptions

setColor

getColor

colorTipText

canAddTracePoint

canPaint

doPaintSelectionShapeWithStroke