com.yworks.yfiles.view.input

Class StripeHitTester

java.lang.Object

com.yworks.yfiles.view.input.StripeHitTester

public class StripeHitTester
extends Object

Support class that allows to iterate over hits on table elements or subregions of table elements.

Constructor Summary

Constructors

Constructor and Description
StripeHitTester(ITable table, TableRenderingOrder tableRenderingOrder) Create a new instance for a specific table instance that use the order specified by tableRenderingOrder to determine the order of the hit test results.

Method Summary

Modifier and Type	Method and Description
IEnumerable<StripeSubregion>	enumerateHits(IInputModeContext context, PointD location, INode node) Return a collection of hits at location.
TableRenderingOrder	getTableRenderingOrder() Return the hit test order that is currently used by this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

StripeHitTester

public StripeHitTester(ITable table,
                       TableRenderingOrder tableRenderingOrder)

Create a new instance for a specific table instance that use the order specified by tableRenderingOrder to determine the order of the hit test results.

Parameters:

table - The table to use

tableRenderingOrder - The hit test order. This determines the order in which stripes are returned by enumerateHits(IInputModeContext, PointD, INode)

Method Detail

enumerateHits

public final IEnumerable<StripeSubregion> enumerateHits(IInputModeContext context,
                                                        PointD location,
                                                        INode node)

Return a collection of hits at location.

This implementation returns the hits in the following order:

1. First all IRows or IColumns at the given location, in the order specified by the TableRenderingOrder property.
2. For each stripe type, the stripes are returned in bottom up order, i.e. children are returned before their parents.
3. For each stripe, the subregions are returned in the order StripeSubregionTypes.NEAR_BORDER, StripeSubregionTypes.FAR_BORDER, StripeSubregionTypes.LEADING_HEADER, StripeSubregionTypes.TRAILING_HEADER,StripeSubregionTypes.STRIPE, e.g. a header hit is always returned before a hit on the whole stripe.

Parameters:

context - The input mode context to use.

location - The location in absolute coordinates.

node - The node where the table instance is currently bound to.

Returns:

A collection of StripeSubregions at location

getTableRenderingOrder

public final TableRenderingOrder getTableRenderingOrder()

Return the hit test order that is currently used by this instance.

Returns:

The TableRenderingOrder.