com.luciad.view.lightspeed

LuciadLightspeedClass TLspPaintingOrder

java.lang.Object

com.luciad.view.lightspeed.TLspPaintingOrder

All Implemented Interfaces:

ILspPaintingOrder, Comparator<ILspPaintingOrder.PaintStep>

public class TLspPaintingOrder
extends Object
implements ILspPaintingOrder

Default implementation of ILspPaintingOrder. This implementation sorts according to the following criteria (in this order):

• Paint state: regular before selected before editing;
• Paint representation: bodies before labels before editing handles;
• Layer order, bottom to top.

The paint representation and paint state are jointly handled by a delegate comparator, which can be overridden using setPaintRepresentationStateComparator(java.util.Comparator). This allows users to easily modify the order while still respecting the view's layer order. Note, however, that TLspPaintRepresentation and TLspPaintState have a sort order property, so that for instance the introduction of a custom paint representation will often not require implementing a custom ILspPaintingOrder.

Since:

2012.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.ILspPaintingOrder

ILspPaintingOrder.PaintStep

Constructor Summary

Constructors

Constructor and Description
TLspPaintingOrder(ILspView aView)

Method Summary

Modifier and Type	Method and Description
int	compare(ILspPaintingOrder.PaintStep o1, ILspPaintingOrder.PaintStep o2)
Comparator<TLspPaintRepresentationState>	getPaintRepresentationStateComparator() Returns the comparator that determines in which order the various visual representations of domain objects are drawn.
protected ILspView	getView() Returns the view for which this painting order was created.
void	setPaintRepresentationStateComparator(Comparator<TLspPaintRepresentationState> aPaintRepresentationStateComparator) Sets the comparator that determines in which order the various visual representations of domain objects are drawn.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

TLspPaintingOrder

public TLspPaintingOrder(ILspView aView)

Method Detail

compare

public int compare(ILspPaintingOrder.PaintStep o1,
                   ILspPaintingOrder.PaintStep o2)

Specified by:

compare in interface Comparator<ILspPaintingOrder.PaintStep>

getPaintRepresentationStateComparator

public Comparator<TLspPaintRepresentationState> getPaintRepresentationStateComparator()

Returns the comparator that determines in which order the various visual representations of domain objects are drawn.

Returns:

a Comparator for PaintRepresentations

See Also:

setPaintRepresentationStateComparator(java.util.Comparator)

setPaintRepresentationStateComparator

public void setPaintRepresentationStateComparator(Comparator<TLspPaintRepresentationState> aPaintRepresentationStateComparator)

Sets the comparator that determines in which order the various visual representations of domain objects are drawn. The comparator is used to order the set of all PaintRepresentationStates for which an ILspPainter has been registered.

Parameters:

aPaintRepresentationStateComparator - a Comparator for PaintRepresentations

getView

protected ILspView getView()

Returns the view for which this painting order was created.

Returns:

the ILspView associated with this painting order