Package adams.gui.visualization.image.leftclick

Class FixedBoundingBox

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.image.leftclick.AbstractLeftClickProcessor

adams.gui.visualization.image.leftclick.AbstractSelectionRectangleBasedLeftClickProcessor

adams.gui.visualization.image.leftclick.FixedBoundingBox

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractLeftClickProcessor>, SizeOfHandler, ObjectPrefixHandler, ImagePanelLeftClickListener, Serializable, EventListener

public class FixedBoundingBox
extends AbstractSelectionRectangleBasedLeftClickProcessor

Allows the user to create fixed-sized bounding boxes around the left-click position (<ctrl> left-click in box removes it).

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

-prefix <java.lang.String> (property: prefix)
    The prefix to use for the fields in the report.
    default: Object.
 

-num-digits <int> (property: numDigits)
    The number of digits to use for left-padding the index with zeroes.
    default: 4
    minimum: 0
 

-width <int> (property: width)
    The width of the bounding box.
    default: 10
    minimum: 1
 

-height <int> (property: height)
    The height of the bounding box.
    default: 10
    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_Height	the height.
protected int	m_Width	the width.

Fields inherited from class adams.gui.visualization.image.leftclick.AbstractSelectionRectangleBasedLeftClickProcessor

m_Locations, m_NumDigits, m_Prefix

Fields inherited from class adams.gui.visualization.image.leftclick.AbstractLeftClickProcessor

m_AltDown, m_CtrlDown, m_MetaDown, m_ShiftDown

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doProcessClick(ImagePanel panel, Point position, int modifiersEx)	Process the click that occurred in the image panel.
int	getHeight()	Returns the height of the bounding box.
int	getWidth()	Returns the width of the bounding box.
String	globalInfo()	Returns a string describing the object.
String	heightTipText()	Returns the tip text for this property.
void	setHeight(int value)	Sets the height of the bounding box.
void	setWidth(int value)	Sets the width of the bounding box.
String	widthTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.image.leftclick.AbstractSelectionRectangleBasedLeftClickProcessor

doImageChanged, findLastIndex, getDefaultNumDigits, getDefaultPrefix, getLocations, getNumDigits, getPrefix, numDigitsTipText, prefixTipText, reset, setNumDigits, setPrefix

Methods inherited from class adams.gui.visualization.image.leftclick.AbstractLeftClickProcessor

altDownTipText, check, clicked, ctrlDownTipText, getAltDown, getCtrlDown, getMetaDown, getShiftDown, imageChanged, metaDownTipText, processClick, setAltDown, setCtrlDown, setMetaDown, setShiftDown, shallowCopy, shallowCopy, shiftDownTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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_Width

protected int m_Width

the width.

m_Height

protected int m_Height

the height.

Constructor Detail

FixedBoundingBox

public FixedBoundingBox()

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 AbstractSelectionRectangleBasedLeftClickProcessor

setWidth

public void setWidth(int value)

Sets the width of the bounding box.

Parameters:

value - the width

getWidth

public int getWidth()

Returns the width of the bounding box.

Returns:

the width

widthTipText

public String widthTipText()

Returns the tip text for this property.

Returns:

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

setHeight

public void setHeight(int value)

Sets the height of the bounding box.

Parameters:

value - the height

getHeight

public int getHeight()

Returns the height of the bounding box.

Returns:

the height

heightTipText

public String heightTipText()

Returns the tip text for this property.

Returns:

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

doProcessClick

protected void doProcessClick(ImagePanel panel,
                              Point position,
                              int modifiersEx)

Process the click that occurred in the image panel.

Specified by:

doProcessClick in class AbstractLeftClickProcessor

Parameters:

panel - the origin

position - the position of the click

modifiersEx - the associated modifiers