com.luciad.view.gxy.swing

LuciadLightspeedClass TLcdGXYScaleIndicator

java.lang.Object

com.luciad.view.swing.ALcdScaleIndicator

com.luciad.view.gxy.swing.TLcdGXYScaleIndicator

All Implemented Interfaces:

ILcdIcon, ILcdCloneable, Serializable, Cloneable

public class TLcdGXYScaleIndicator
extends ALcdScaleIndicator

An ALcdScaleIndicator implementation for ILcdGXYView instances.

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
    TLcdGXYScaleIndicator scaleIndicator = new TLcdGXYScaleIndicator(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 to the south-east corner of an overlay container of a GXY view.

    //Add the scale indicator in an overlay panel that is placed on top of the view
    //This ensures that the scale label is placed on top of the map
    viewOverlayPanel.add(scaleIndicator.getLabel(), TLcdOverlayLayout.Location.SOUTH_EAST);

Since:

2012.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
TLcdGXYScaleIndicator(ILcdGXYView aView) Creates a new TLcdGXYScaleIndicator for the specified ILcdGXYView

Method Summary

Modifier and Type	Method and Description
JLabel	getLabel() Returns a JLabel containing this scale indicator as an icon.
protected ILcdXYWorldReference	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

TLcdGXYScaleIndicator

public TLcdGXYScaleIndicator(ILcdGXYView aView)

Creates a new TLcdGXYScaleIndicator for the specified ILcdGXYView

Parameters:

aView - the specified view

Method Detail

getLabel

public JLabel getLabel()

Returns a JLabel containing this scale indicator as an icon.

The returned label will automatically update and repaint itself when needed, for example on view changes or when changing the settings of this scale indicator instance.

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

Returns:

a label containing this scale indicator as an icon.

Since:

2020.0

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 ILcdXYWorldReference 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