com.luciad.view.lightspeed.javafx

LuciadLightspeedClass TLspFXScaleIndicator

java.lang.Object

com.luciad.view.swing.ALcdScaleIndicator

com.luciad.view.lightspeed.javafx.TLspFXScaleIndicator

All Implemented Interfaces:

ILcdIcon, ILcdChangeSource, ILcdCloneable, Serializable, Cloneable

public class TLspFXScaleIndicator
extends ALcdScaleIndicator
implements ILcdChangeSource

A JavaFX ALcdScaleIndicator implementation for ILspView.

The BAR representation of the scale indicator.

The FRACTION representation of the scale indicator.

By default the indicator will only change if you zoom, not if you pan. Call ALcdScaleIndicator.setScaleAtCenterOfMap(boolean) to change this behavior.

The following snippet shows how to create a scale indicator:

    //Create a scale indicator for the view
    TLspFXScaleIndicator scaleIndicator = new TLspFXScaleIndicator(view);
    //Optionally, change some settings on the scale indicator.
    //Check the javadoc for all available customization options
    scaleIndicator.setBarColor(Color.DARK_GRAY);
    scaleIndicator.setAlternateBarColor(Color.LIGHT_GRAY);

which is then added, together with the TLspFXView, to the south-east corner of an AnchorPane.

    //Add the view and the scale indicator to the same pane
    //This ensures that the scale label is placed on top of the map
    AnchorPane pane = new AnchorPane(view.getHostNode(), scaleIndicator.getNode());
    AnchorPane.setTopAnchor(view.getHostNode(), 0.0);
    AnchorPane.setBottomAnchor(view.getHostNode(), 0.0);
    AnchorPane.setLeftAnchor(view.getHostNode(), 0.0);
    AnchorPane.setRightAnchor(view.getHostNode(), 0.0);
    AnchorPane.setRightAnchor(scaleIndicator.getNode(), 10.0);
    AnchorPane.setBottomAnchor(scaleIndicator.getNode(), 10.0);
    //The AnchorPane now can be shown on a javafx.scene.Scene instance

Since:

2019.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.luciad.view.swing.ALcdScaleIndicator

ALcdScaleIndicator.Representation

Constructor Summary

Constructors

Constructor and Description
TLspFXScaleIndicator(ILspView aView) Creates a new instance of TLspFXScaleIndicator for the specified view.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ILcdChangeListener aListener) Registers the given listener so it will receive change events from this source.
javafx.scene.Node	getNode() Returns a Node containing this scale indicator as an icon.
void	removeChangeListener(ILcdChangeListener aListener) Removes the specified listener so it is no longer notified.
protected ILcdXYZWorldReference	retrieveMapReference() Returns the current world reference of the map, used to retrieve the world unit of measure.
protected double	retrieveScale() Returns the current view scale according to the ALcdScaleIndicator.isScaleAtCenterOfMap() value.

Methods inherited from class com.luciad.view.swing.ALcdScaleIndicator

addPropertyChangeListener, calculateScaleIndication, clone, firePropertyChangeEvent, getAlternateBarColor, getBarColor, getBarHeight, getBarSegmentCount, getBarWidth, getDistanceUnit, getFont, getFractionFormat, getHaloColor, getIconHeight, getIconWidth, getLabelColor, getScaleRepresentation, isScaleAtCenterOfMap, paintIcon, removePropertyChangeListener, setAlternateBarColor, setBarColor, setBarHeight, setBarSegmentCount, setBarWidth, setDistanceUnit, setFont, setFractionFormat, setHaloColor, setLabelColor, setScaleAtCenterOfMap, setScaleRepresentation, toggleScaleRepresentation

Methods inherited from class java.lang.Object

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

Constructor Detail

TLspFXScaleIndicator

public TLspFXScaleIndicator(ILspView aView)

Creates a new instance of TLspFXScaleIndicator for the specified view.

Parameters:

aView - the specified view

Method Detail

getNode

public javafx.scene.Node getNode()

Returns a Node containing this scale indicator as an icon.

The returned Node will automatically refresh itself when needed, for example on view changes or when changing the settings of this scale indicator instance.

Additionally, clicking on the scale indicator will trigger the ALcdScaleIndicator.toggleScaleRepresentation() method.

Returns:

a Node containing this scale indicator as an icon.

Since:

2020.0

addChangeListener

public void addChangeListener(ILcdChangeListener aListener)

Description copied from interface: ILcdChangeSource

Registers the given listener so it will receive change events from this source.

In case you need to register a listener which keeps a reference to an object with a shorter life-time than this change source, you can use a ALcdWeakChangeListener instance as change listener.

Specified by:

addChangeListener in interface ILcdChangeSource

Parameters:

aListener - The listener to be notified when a change has happened.

See Also:

ILcdChangeSource.removeChangeListener(ILcdChangeListener), ALcdWeakChangeListener

removeChangeListener

public void removeChangeListener(ILcdChangeListener aListener)

Description copied from interface: ILcdChangeSource

Removes the specified listener so it is no longer notified.

Specified by:

removeChangeListener in interface ILcdChangeSource

Parameters:

aListener - The listener to remove.

retrieveScale

protected double retrieveScale()

Description copied from class: ALcdScaleIndicator

Returns the current view scale according to the ALcdScaleIndicator.isScaleAtCenterOfMap() value.

Specified by:

retrieveScale in class ALcdScaleIndicator

Returns:

the current scale in toolkit pixels per meter.

retrieveMapReference

protected ILcdXYZWorldReference retrieveMapReference()

Description copied from class: ALcdScaleIndicator

Returns the current world reference of the map, used to retrieve the world unit of measure. Either ILcdXYWorldReference or ILcdXYZWorldReference.

This method will return null if the reference is unknown, in which case the world unit will be assumed to be 1 meter.

Overrides:

retrieveMapReference in class ALcdScaleIndicator

Returns:

the current world reference of the map, or null if it is unknown