Package com.luciad.view

Class TLcdLabelLocationEventSupport

java.lang.Object

com.luciad.view.TLcdLabelLocationEventSupport

public class TLcdLabelLocationEventSupport
extends Object

Support class for generating events related to label locations. It is provided to facilitate the implementation of ALcdLabelLocations

Since:

7.0

See Also:

• ALcdLabelLocations.addLabelLocationListener(com.luciad.view.ILcdLabelLocationListener)
• TLcdLabelLocationEvent
• ALcdLabelLocations.addLabelPaintedListener(ILcdLabelPaintedListener)
• TLcdLabelPaintedEvent

Constructor Summary

Constructors

Constructor	Description
TLcdLabelLocationEventSupport(ALcdLabelLocations aSource)	Creates a new instance of this support class, with the specified ALcdLabelLocations as source for the events it will fire.

Method Summary

Modifier and Type	Method	Description
void	addLabelLocationListener(ILcdLabelLocationListener aListener)	Adds the specified listener to the list of listeners that should be notified of changes to the label locations.
void	addLabelPaintedListener(ILcdLabelPaintedListener aListener)	Adds the specified listener to the list of listeners that should be notified of changes to the label locations.
void	fireCollectedChanges(ILcdView aView)	Notifies the registered listeners of the collected changes.
void	fireCollectedLabelPaintedChanges(ILcdView aView)	Notifies the registered listeners of the collected changes.
void	labelLocationChanged(Object aObject, int aLabelIndex, int aSubLabelIndex, ILcdView aView, int aFireEventMode)	Notify this support class of a change in the label locations.
void	labelPaintedChanged(Object aObject, int aLabelIndex, int aSubLabelIndex, ILcdView aView, boolean aIsPainted, boolean aPreviousPainted, int aFireEventMode)	Notify this support class of a change in the label locations painted status.
void	removeLabelLocationListener(ILcdLabelLocationListener aListener)	Removes the specified listener from the list of listeners.
void	removeLabelPaintedListener(ILcdLabelPaintedListener aListener)	Removes the specified listener from the list of listeners.

Methods inherited from class java.lang.Object

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

Constructor Details

TLcdLabelLocationEventSupport

public TLcdLabelLocationEventSupport(ALcdLabelLocations aSource)

Creates a new instance of this support class, with the specified ALcdLabelLocations as source for the events it will fire.

Parameters:

aSource - The ALcdLabelLocations that will be used as the source of the event this instance will fire. It must not be null.

See Also:

• TLcdLabelLocationEvent.getLabelLocations()

Method Details

labelLocationChanged

public void labelLocationChanged(Object aObject,
 int aLabelIndex,
 int aSubLabelIndex,
 ILcdView aView,
 int aFireEventMode)

Notify this support class of a change in the label locations.

Parameters:

aObject - The domain Object for which the label changed.

aLabelIndex - The label that changed.

aSubLabelIndex - The sublabel that changed.

aView - The view on which the label was painted.

aFireEventMode - Specifies if and when the registered listeners should be notified of the change. When this integer is equal to ILcdFireEventMode#FIRE_NOW, the listeners will be notified right away, when it is ILcdFireEventMode#FIRE_LATER the listeners will be notified later (more specifically, when fireCollectedChanges is called) and when it is ILcdFireEventMode#NO_EVENT the listeners will never be notified of the change.

See Also:

• About label- and sublabel-indices.

addLabelLocationListener

public void addLabelLocationListener(ILcdLabelLocationListener aListener)

Adds the specified listener to the list of listeners that should be notified of changes to the label locations.

Parameters:

aListener - The listener that should be notified of any future changes in the label locations

See Also:

• ALcdLabelLocations.addLabelLocationListener(ILcdLabelLocationListener)

removeLabelLocationListener

public void removeLabelLocationListener(ILcdLabelLocationListener aListener)

Removes the specified listener from the list of listeners. This means it will no longer be notified of any future changes in the label locations.

Parameters:

aListener - The listener that should no longer be notified of the changes in the label locations

See Also:

• ALcdLabelLocations.removeLabelLocationListener(ILcdLabelLocationListener)

fireCollectedChanges

public void fireCollectedChanges(ILcdView aView)

Notifies the registered listeners of the collected changes. These changes are the ones that were collected using the labelLocationChanged(Object, int, int, com.luciad.view.ILcdView, int) method.

Parameters:

aView - The ILcdView for which to fire the collected changes.

See Also:

• ALcdLabelLocations.putLabelLocation(java.lang.Object, int, int, com.luciad.view.ILcdView, com.luciad.view.TLcdLabelLocation, int)

addLabelPaintedListener

public void addLabelPaintedListener(ILcdLabelPaintedListener aListener)

Adds the specified listener to the list of listeners that should be notified of changes to the label locations.

Parameters:

aListener - The listener that should be notified of any future changes in the label locations

See Also:

• ALcdLabelLocations.addLabelPaintedListener(ILcdLabelPaintedListener)

removeLabelPaintedListener

public void removeLabelPaintedListener(ILcdLabelPaintedListener aListener)

Removes the specified listener from the list of listeners. This means it will no longer be notified of any future changes in the label locations.

Parameters:

aListener - The listener that should no longer be notified of the changes in the label locations

See Also:

• ALcdLabelLocations.removeLabelPaintedListener(ILcdLabelPaintedListener)

labelPaintedChanged

public void labelPaintedChanged(Object aObject,
 int aLabelIndex,
 int aSubLabelIndex,
 ILcdView aView,
 boolean aIsPainted,
 boolean aPreviousPainted,
 int aFireEventMode)

Notify this support class of a change in the label locations painted status. This label location changed will only throw an event when the painted status is effectively changed.

Parameters:

aObject - The domain Object for which the label changed.

aLabelIndex - The label that changed.

aSubLabelIndex - The sublabel that changed.

aView - The view on which the label was painted.

aIsPainted - True if the label is marked as painted, and false if it is unmarked.

aPreviousPainted - True if the label was marked as painted before the change.

aFireEventMode - Specifies if and when the registered listeners should be notified of the change. When this integer is equal to ILcdFireEventMode#FIRE_NOW, the listeners will be notified right away, when it is ILcdFireEventMode#FIRE_LATER the listeners will be notified later (more specifically, when fireCollectedLabelPaintedChanges is called) and when it is ILcdFireEventMode#NO_EVENT the listeners will never be notified of the change.

See Also:

• About label- and sublabel-indices.

fireCollectedLabelPaintedChanges

public void fireCollectedLabelPaintedChanges(ILcdView aView)

Notifies the registered listeners of the collected changes. These changes are the ones that were collected using the labelPaintedChanged(Object, int, int, com.luciad.view.ILcdView, boolean, boolean, int) method.

Parameters:

aView - The ILcdView for which to fire the collected changes.

See Also:

• ALcdLabelLocations.setPainted(Object, int, int, ILcdView, boolean, int)