Package adams.flow.transformer.draw

Class FloodFill

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.draw.AbstractDrawOperation

adams.flow.transformer.draw.AbstractColorDrawOperation

adams.flow.transformer.draw.FloodFill

All Implemented Interfaces:

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

public class FloodFill
extends AbstractColorDrawOperation

Performs a flood-fill starting at the given position. The position also determines the color to replace.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-color <java.awt.Color> (property: color)
    The color of the pixel.
    default: #000000
 

-x <int> (property: X)
    The X of the starting position of the flood-fill.
    default: 1
    minimum: 1
 

-y <int> (property: Y)
    The Y of the start position of the flood-fill.
    default: 1
    minimum: 1
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_X	the X position.
protected int	m_Y	the Y position.

Fields inherited from class adams.flow.transformer.draw.AbstractColorDrawOperation

m_Color

Fields inherited from class adams.flow.transformer.draw.AbstractDrawOperation

m_Owner

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

Method Summary

Modifier and Type	Method	Description
protected String	check(BufferedImageContainer image)	Checks the image.
void	defineOptions()	Adds options to the internal list of options.
protected String	doDraw(BufferedImageContainer image)	Performs the actual draw operation.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
int	getX()	Returns the X of the start position.
int	getY()	Returns the Y of the start position.
String	globalInfo()	Returns a string describing the object.
void	setX(int value)	Sets the X of the start position.
void	setY(int value)	Sets the Y of the start position.
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.draw.AbstractColorDrawOperation

colorTipText, getColor, setColor

Methods inherited from class adams.flow.transformer.draw.AbstractDrawOperation

draw, getOwner, setOwner

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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_X

protected int m_X

the X position.

m_Y

protected int m_Y

the Y position.

Constructor Detail

FloodFill

public FloodFill()

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 AbstractColorDrawOperation

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractDrawOperation

Returns:

null if no info available, otherwise short string

setX

public void setX(int value)

Sets the X of the start position.

Parameters:

value - the position, 1-based

getX

public int getX()

Returns the X of the start position.

Returns:

the position, 1-based

XTipText

public String XTipText()

Returns the tip text for this property.

Returns:

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

setY

public void setY(int value)

Sets the Y of the start position.

Parameters:

value - the position, 1-based

getY

public int getY()

Returns the Y of the start position.

Returns:

the position, 1-based

YTipText

public String YTipText()

Returns the tip text for this property.

Returns:

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

check

protected String check(BufferedImageContainer image)

Checks the image.

Overrides:

check in class AbstractDrawOperation

Parameters:

image - the image to check

Returns:

null if OK, otherwise error message

doDraw

protected String doDraw(BufferedImageContainer image)

Performs the actual draw operation.

Specified by:

doDraw in class AbstractDrawOperation

Parameters:

image - the image to draw on

Returns:

null if OK, otherwise error message