com.luciad.view.lightspeed.controller.ruler

LuciadLightspeedClass TLspRulerLabelStyler

java.lang.Object

com.luciad.view.lightspeed.style.styler.ALspStyler

com.luciad.view.lightspeed.style.styler.ALspLabelStyler

com.luciad.view.lightspeed.controller.ruler.TLspRulerLabelStyler

All Implemented Interfaces:

ILspCustomizableStyler, ILspStyler

public class TLspRulerLabelStyler
extends ALspLabelStyler
implements ILspCustomizableStyler

An default label styler for the TLspRulerController. When the domain object to style is an ALspRulerMeasurement, this styler will style a segment label for each line segment and a total distance label at the end of the entire polyline.

This class uses six customizable styles to style these labels:

• Three styles with identifier SEGMENT used for the individual segment labels, a TLspTextStyle, a TLspLabelBoxStyle and a TLspRulerSegmentLabelContentStyle.
• Three styles with identifier TOTAL used for the total distance label, a TLspTextStyle, a TLspLabelBoxStyle and a TLspRulerDistanceFormatStyle.

To adapt the styles, get them using getStyles(), and replace the style you want to change by another style. At least a TLspTextStyle and a ALspLabelTextProviderStyle must be present and active for (useful) labels to appear.

Since:

2012.0

See Also:

TLspRulerController.setLabelStyler(com.luciad.view.lightspeed.style.styler.ILspStyler)

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEGMENT A constant accepted by setStyles(String, com.luciad.view.lightspeed.style.ALspStyle...) to indicate that the provided styles should be used to style the individual segment labels.
static String	TOTAL A constant accepted by setStyles(String, com.luciad.view.lightspeed.style.ALspStyle...) to indicate that the provided styles should be used to style the label totalling the distance.

Constructor Summary

Constructors

Constructor and Description
TLspRulerLabelStyler() Creates a new TLspRulerLabelStyler with a default blue and white style for both segment and total labels.

Method Summary

Modifier and Type	Method and Description
Collection<TLspCustomizableStyle>	getStyles() Returns the styler's customizable styles.
void	style(Collection<?> aObjects, ALspLabelStyleCollector aStyleCollector, TLspContext aContext) Convenience method that takes an ALspLabelStyleCollector as argument instead of an ALspStyleCollector.
void	style(Collection<?> aObjects, ALspStyleCollector aStyleCollector, TLspContext aContext) Implementation of ILspStyler.style that either casts the ALspStyleCollector to ALspLabelStyleCollector if possible, or adapts it otherwise.

Methods inherited from class com.luciad.view.lightspeed.style.styler.ALspStyler

addStyleChangeListener, fireStyleChangeEvent, fireStyleChangeEvent, removeStyleChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.view.lightspeed.style.styler.ILspStyler

addStyleChangeListener, removeStyleChangeListener

Field Detail

SEGMENT

public static final String SEGMENT

A constant accepted by setStyles(String, com.luciad.view.lightspeed.style.ALspStyle...) to indicate that the provided styles should be used to style the individual segment labels.

See Also:

Constant Field Values

TOTAL

public static final String TOTAL

A constant accepted by setStyles(String, com.luciad.view.lightspeed.style.ALspStyle...) to indicate that the provided styles should be used to style the label totalling the distance.

See Also:

Constant Field Values

Constructor Detail

TLspRulerLabelStyler

public TLspRulerLabelStyler()

Creates a new TLspRulerLabelStyler with a default blue and white style for both segment and total labels. Both labels only contain the the distance formatted in meters.

Method Detail

style

public void style(Collection<?> aObjects,
                  ALspStyleCollector aStyleCollector,
                  TLspContext aContext)

Description copied from class: ALspLabelStyler

Implementation of ILspStyler.style that either casts the ALspStyleCollector to ALspLabelStyleCollector if possible, or adapts it otherwise. In the latter case, the labeling-specific calls (label, anchorLabel, algorithm, ...) are ignored. The ALspLabelStyleCollector is then passed to the style(Collection,ALspLabelStyleCollector,TLspContext) method.

Specified by:

style in interface ILspStyler

Overrides:

style in class ALspLabelStyler

Parameters:

aObjects - The objects to be styled.

aStyleCollector - A style collector to which all styling information should be passed, this collector is only valid within this method call, and can no longer be used afterwards.

aContext - Provides context information that may affect styling, such as view specific properties.

style

public void style(Collection<?> aObjects,
                  ALspLabelStyleCollector aStyleCollector,
                  TLspContext aContext)

Description copied from class: ALspLabelStyler

Convenience method that takes an ALspLabelStyleCollector as argument instead of an ALspStyleCollector. This method is called from ALspLabelStyler.style(Collection, ALspStyleCollector, TLspContext).

Specified by:

style in class ALspLabelStyler

Parameters:

aObjects - The set of domain objects to provide information for

aStyleCollector - The label style collector to submit the information to.

aContext - The context

See Also:

ALspLabelStyleCollector, ILspStyler

getStyles

public Collection<TLspCustomizableStyle> getStyles()

Description copied from interface: ILspCustomizableStyler

Returns the styler's customizable styles. When modifications are made to the styles, the styler will automatically inform its listeners about the change. The following changes can be made:

• Styles can be enabled or disabled. Only the enabled styles will be set in the style method.
• The ALspStyle in the TLspCustomizableStyle may be replaced

The collection is not ordered, but you can use the identifier of the TLspCustomizableStyle to recognize and order the styles.

Specified by:

getStyles in interface ILspCustomizableStyler

Returns:

An immutable collection containing all styles which will be set in the style method