Package com.luciad.view.lightspeed.label.location

Class TLspLabelLocations

java.lang.Object

com.luciad.view.lightspeed.label.location.ALspLabelLocations

com.luciad.view.lightspeed.label.location.TLspLabelLocations

public class TLspLabelLocations
extends ALspLabelLocations

Default implementation of ALspLabelLocations.

Since:

2012.0

Nested Class Summary

Nested classes/interfaces inherited from class com.luciad.view.lightspeed.label.location.ALspLabelLocations

ALspLabelLocations.LocationInfo

Constructor Summary

Constructors

Constructor	Description
TLspLabelLocations()

Method Summary

Modifier and Type	Method	Description
void	addLabelLocationListener(ILspLabelLocationChangeListener aListener)	Adds the specified listener to this information store.
ALspLabelLocations.LocationInfo	getLabelLocation(ILspView aView, TLspLabelID aLabel)	Returns the location and visibility for the requested label.
Iterable<ALspLabelLocations.LocationInfo>	getLabelLocations(ILspView aView, ILspLayer aLayer, TLspPaintRepresentation aPaintRepresentation, boolean aVisibleOnly)	Retrieves the current set of label locations and visibilities.
void	removeLabelLocationListener(ILspLabelLocationChangeListener aListener)	Removes the specified listener.
void	setLabelLocations(List<TLspLabelID> aLabels, List<ALspLabelLocation> aLocations, List<Boolean> aVisibilities, ILspView aView)	Stores the given location information so it can be retrieved later on.
void	updateLabelLocations(List<TLspLabelID> aLabels, List<ALspLabelLocation> aLocations, List<Boolean> aVisibilities, ILspView aView)	Stores the given location information so it can be retrieved later on.

Methods inherited from class java.lang.Object

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

Constructor Details

TLspLabelLocations

public TLspLabelLocations()

Method Details

addLabelLocationListener

public void addLabelLocationListener(ILspLabelLocationChangeListener aListener)

Description copied from class: ALspLabelLocations

Adds the specified listener to this information store. This listener will be notified of changes in the label information.

Specified by:

addLabelLocationListener in class ALspLabelLocations

Parameters:

aListener - The listener that should be informed when there are changes in the label information.

See Also:

• ALspLabelLocations.updateLabelLocations(java.util.List<com.luciad.view.lightspeed.painter.label.TLspLabelID>, java.util.List<com.luciad.view.lightspeed.label.location.ALspLabelLocation>, java.util.List<java.lang.Boolean>, com.luciad.view.lightspeed.ILspView)

removeLabelLocationListener

public void removeLabelLocationListener(ILspLabelLocationChangeListener aListener)

Description copied from class: ALspLabelLocations

Removes the specified listener. This listener will no longer be notified of changes in the label information.

Specified by:

removeLabelLocationListener in class ALspLabelLocations

Parameters:

aListener - The listener to remove.

setLabelLocations

public void setLabelLocations(List<TLspLabelID> aLabels,
 List<ALspLabelLocation> aLocations,
 List<Boolean> aVisibilities,
 ILspView aView)

Description copied from class: ALspLabelLocations

Stores the given location information so it can be retrieved later on.

Note that this call sets all labels that are not explicitly specified to invisible.

This method also allows to remove the information: just let the ALspLabelLocation be null.

Specified by:

setLabelLocations in class ALspLabelLocations

Parameters:

aLabels - An array of objects identifying a label to which this information applies.

aLocations - An array of locations. No references to the locations are kept within the implementations of this class. This allows the client of this class to reuse the same locations. If this location is null, any label information already present in this instance about the given representation is removed from this class.

aVisibilities - An array of booleans indicating visibility of the labels.

aView - The view for which the location applies.

See Also:

• ALspLabelLocations.updateLabelLocations(java.util.List<com.luciad.view.lightspeed.painter.label.TLspLabelID>, java.util.List<com.luciad.view.lightspeed.label.location.ALspLabelLocation>, java.util.List<java.lang.Boolean>, com.luciad.view.lightspeed.ILspView)

updateLabelLocations

public void updateLabelLocations(List<TLspLabelID> aLabels,
 List<ALspLabelLocation> aLocations,
 List<Boolean> aVisibilities,
 ILspView aView)

Description copied from class: ALspLabelLocations

Stores the given location information so it can be retrieved later on.

This call only changes the location and visibility of the specified labels, and leaves the other labels untouched.

This method also allows to remove the information: just let the ALspLabelLocation be null.

Specified by:

updateLabelLocations in class ALspLabelLocations

Parameters:

aLabels - An array of objects identifying a label to which this information applies.

aLocations - An array of locations. No references to the locations are kept within the implementations of this class. This allows the client of this class to reuse the same locations. If this location is null, any label information already present in this instance about the given representation is removed from this class.

aVisibilities - The identifiers for the labels that should be visible.

aView - The view for which the location applies.

See Also:

• ALspLabelLocations.setLabelLocations(java.util.List<com.luciad.view.lightspeed.painter.label.TLspLabelID>, java.util.List<com.luciad.view.lightspeed.label.location.ALspLabelLocation>, java.util.List<java.lang.Boolean>, com.luciad.view.lightspeed.ILspView)

getLabelLocation

public ALspLabelLocations.LocationInfo getLabelLocation(ILspView aView,
 TLspLabelID aLabel)

Description copied from class: ALspLabelLocations

Returns the location and visibility for the requested label.

This method never return null, but the location inside can be null.

Specified by:

getLabelLocation in class ALspLabelLocations

Parameters:

aView - The view

aLabel - The label

Returns:

The location info, never null

getLabelLocations

public Iterable<ALspLabelLocations.LocationInfo> getLabelLocations(ILspView aView,
 ILspLayer aLayer,
 TLspPaintRepresentation aPaintRepresentation,
 boolean aVisibleOnly)

Description copied from class: ALspLabelLocations

Retrieves the current set of label locations and visibilities.

Specified by:

getLabelLocations in class ALspLabelLocations

Parameters:

aView - The view to retrieve the information for, never null

aLayer - The layer to retrieve the information for, can be null if all layers relevant

aPaintRepresentation - The paint representation to retrieve the information, can be null if the layer is also null

aVisibleOnly - Indicates whether all information is necessary, or only that of visible labels

Returns:

A set of labels with their location and visibility.