org.fxmisc.flowless

Class VirtualFlowHit<C extends Cell<?,?>>

java.lang.Object

org.fxmisc.flowless.VirtualFlowHit<C>

public abstract class VirtualFlowHit<C extends Cell<?,?>>
extends Object

Stores the result of a VirtualFlow.hit(double, double). Before calling any of the getters, one should determine what kind of hit this object is via isCellHit(), isBeforeCells(), and isAfterCells(). Otherwise, calling the wrong getter will throw an UnsupportedOperationException.

Types of VirtualFlowHit:

• Cell Hit: a hit occurs on a displayed cell's node. One can call getCell(), getCellIndex(), and getCellOffset().
• Hit Before Cells: a hit occurred before the displayed cells. One can call getOffsetBeforeCells().
• Hit After Cells: a hit occurred after the displayed cells. One can call getOffsetAfterCells().

Method Summary

Modifier and Type	Method and Description
abstract C	getCell()
abstract int	getCellIndex()
abstract Point2D	getCellOffset()
abstract Point2D	getOffsetAfterCells()
abstract Point2D	getOffsetBeforeCells()
abstract boolean	isAfterCells()
abstract boolean	isBeforeCells()
abstract boolean	isCellHit()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isCellHit

public abstract boolean isCellHit()

isBeforeCells

public abstract boolean isBeforeCells()

isAfterCells

public abstract boolean isAfterCells()

getCellIndex

public abstract int getCellIndex()

getCell

public abstract C getCell()

getCellOffset

public abstract Point2D getCellOffset()

getOffsetBeforeCells

public abstract Point2D getOffsetBeforeCells()

getOffsetAfterCells

public abstract Point2D getOffsetAfterCells()