org.openstreetmap.josm.gui.util

Class HighlightHelper

java.lang.Object

org.openstreetmap.josm.gui.util.HighlightHelper

public class HighlightHelper
extends java.lang.Object

This class stores the set of highlighted primitives and allows easy and fast change of highlighting.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<OsmPrimitive>	highlightedPrimitives

Constructor Summary

Constructors

Constructor and Description
HighlightHelper()

Method Summary

Modifier and Type	Method and Description
void	clear() Clear highlighting of all remembered primitives
static void	clearAllHighlighted() Slow method to remove highlights from all primitives
void	findAllHighlighted() Slow method to import all currently highlighted primitives into this instance
boolean	highlight(java.util.Collection<? extends OsmPrimitive> prims) Highlight and remember given primitives
boolean	highlight(java.util.Collection<? extends OsmPrimitive> prims, boolean only) Highlight and remember given primitives
boolean	highlightOnly(java.util.Collection<? extends OsmPrimitive> prims) Highlight and remember given primitives, forgetting previously highlighted by this instance
boolean	highlightOnly(OsmPrimitive p) Highlight and remember given primitive, forgetting previously highlighted by this instance
boolean	setHighlight(OsmPrimitive p, boolean flag) Highlight and remember given primitive
private boolean	setHighlight(OsmPrimitive p, boolean flag, java.util.Set<Relation> seenRelations)

Methods inherited from class java.lang.Object

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

Field Detail

highlightedPrimitives

private final java.util.Set<OsmPrimitive> highlightedPrimitives

Constructor Detail

HighlightHelper

public HighlightHelper()

Method Detail

highlight

public boolean highlight(java.util.Collection<? extends OsmPrimitive> prims)

Highlight and remember given primitives

Parameters:

prims - - primitives to highlight/unhighlight

Returns:

true if a repaint is needed

highlight

public boolean highlight(java.util.Collection<? extends OsmPrimitive> prims,
                         boolean only)

Highlight and remember given primitives

Parameters:

prims - - primitives to highlight/unhighlight

only - - remove previous highlighting

Returns:

true if a repaint is needed

highlightOnly

public boolean highlightOnly(java.util.Collection<? extends OsmPrimitive> prims)

Highlight and remember given primitives, forgetting previously highlighted by this instance

Parameters:

prims - - primitives to highlight/unhighlight

Returns:

true if a repaint is needed

highlightOnly

public boolean highlightOnly(OsmPrimitive p)

Highlight and remember given primitive, forgetting previously highlighted by this instance

Parameters:

p - - primitives to highlight/unhighlight

Returns:

true if a repaint is needed

setHighlight

public boolean setHighlight(OsmPrimitive p,
                            boolean flag)

Highlight and remember given primitive

Parameters:

p - - primitive to highlight/unhighlight

flag - - true to highlight

Returns:

true if a repaint is needed

setHighlight

private boolean setHighlight(OsmPrimitive p,
                             boolean flag,
                             java.util.Set<Relation> seenRelations)

clear

public void clear()

Clear highlighting of all remembered primitives

findAllHighlighted

public void findAllHighlighted()

Slow method to import all currently highlighted primitives into this instance

clearAllHighlighted

public static void clearAllHighlighted()

Slow method to remove highlights from all primitives