BarHitDetector (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.visualization.core.plot.AbstractHitDetector<H,P>
      - adams.gui.visualization.core.plot.AbstractDistanceBasedHitDetector<List<XYSequencePoint>,String>
        
        adams.gui.visualization.sequence.AbstractXYSequencePointHitDetector
        
        adams.gui.visualization.sequence.BarHitDetector

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ContainerHitDetector<List<XYSequencePoint>,String,XYSequenceContainer>, HitDetector<List<XYSequencePoint>,String>, Serializable
```
public class BarHitDetector
extends AbstractXYSequencePointHitDetector
```
Detects selections of sequence points in the sequence panel.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected int m_Width
the width of the bar in pixel.
- Fields inherited from class adams.gui.visualization.sequence.AbstractXYSequencePointHitDetector
  m_Owner
- Fields inherited from class adams.gui.visualization.core.plot.AbstractDistanceBasedHitDetector
  m_MinimumPixelDifference
- Fields inherited from class adams.gui.visualization.core.plot.AbstractHitDetector
  m_Debug, m_Enabled
- 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
`BarHitDetector()`	Initializes the hit detector (constructor only for GOE) with no owner.
`BarHitDetector(XYSequencePaintlet owner)`	Initializes the hit detector.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getWidth()`	Returns the width of the bar.
`String`	`globalInfo()`	Returns a string describing the object.
`protected List<XYSequencePoint>`	`isHit(MouseEvent e)`	Checks for a hit.
`void`	`setWidth(int value)`	Sets the width of the bar.

Methods inherited from class adams.gui.visualization.sequence.AbstractXYSequencePointHitDetector
cleanUp, containers, getOwner, processHit, setOwner

Methods inherited from class adams.gui.visualization.core.plot.AbstractDistanceBasedHitDetector
defineOptions, distance, getDefaultMinimumPixelDifference, getMinimumPixelDifference, minimumPixelDifferenceDetectorTipText, setMinimumPixelDifference

Methods inherited from class adams.gui.visualization.core.plot.AbstractHitDetector
detect, getDebug, isEnabled, locate, setDebug, setEnabled

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.gui.visualization.core.plot.HitDetector
detect, getDebug, isEnabled, locate, setDebug, setEnabled

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_Width
```
protected int m_Width
```
    the width of the bar in pixel.
- Constructor Detail
  - BarHitDetector
```
public BarHitDetector()
```
    Initializes the hit detector (constructor only for GOE) with no owner.
  - BarHitDetector
```
public BarHitDetector(XYSequencePaintlet owner)
```
    Initializes the hit detector.
    
    Parameters:
    
    owner - the paintlet that uses this detector
- 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
  - setWidth
```
public void setWidth(int value)
```
    Sets the width of the bar.
    
    Parameters:
    
    value - width in pixel
  - getWidth
```
public int getWidth()
```
    Returns the width of the bar.
    
    Returns:
    
    width in pixel
  - isHit
```
protected List<XYSequencePoint> isHit(MouseEvent e)
```
    Checks for a hit.
    
    Specified by:
    
    isHit in class AbstractXYSequencePointHitDetector
    
    Parameters:
    
    e - the MouseEvent (for coordinates)
    
    Returns:
    
    the associated object with the hit, otherwise null