Package com.luciad.view.lightspeed.controller.ruler

Class TLspRulerSegmentLabelContentStyle

java.lang.Object

com.luciad.view.lightspeed.style.ALspStyle

com.luciad.view.lightspeed.painter.label.style.ALspLabelTextProviderStyle

com.luciad.view.lightspeed.controller.ruler.TLspRulerDistanceFormatStyle

com.luciad.view.lightspeed.controller.ruler.TLspRulerSegmentLabelContentStyle

All Implemented Interfaces:

ILcdCloneable, ILspStyler, Cloneable

public class TLspRulerSegmentLabelContentStyle
extends TLspRulerDistanceFormatStyle

An extension of TLspRulerDistanceFormatStyle that adds support for displaying the azimuth of a segment (if available). The segment is identified by an Integer passed as aSubLabelId along side an domain object that is an instance of ALspRulerMeasurement.

Since:

2012.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TLspRulerSegmentLabelContentStyle.Builder<B extends TLspRulerSegmentLabelContentStyle.Builder<B>>	Builder for the ruler segment label content style.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TLspRulerSegmentLabelContentStyle(TLspRulerSegmentLabelContentStyle.Builder aBuilder)

Method Summary

Modifier and Type	Method	Description
TLspRulerSegmentLabelContentStyle.Builder<?>	asBuilder()	Creates a new builder initialized with all the properties of this style.
boolean	equals(Object o)
Format	getAzimuthFormat()	Returns the used azimuth format.
String[]	getText(Object aDomainObject, Object aSubLabelID, TLspContext aContext)	Returns text (one or more strings) for the given domain object and sublabel ID.
int	hashCode()
boolean	isDisplayAzimuth()	Returns whether or not the azimuth is displayed in the segment labels.
static TLspRulerSegmentLabelContentStyle.Builder<?>	newBuilder()	Creates a new builder with the default values: Distance format: TLcdDistanceFormat with user unit metre. Azimuth format: a DecimalFormat with pattern "0.0°". Display azimuth: false.

Methods inherited from class com.luciad.view.lightspeed.controller.ruler.TLspRulerDistanceFormatStyle

getDistanceFormat

Methods inherited from class com.luciad.view.lightspeed.painter.label.style.ALspLabelTextProviderStyle

clone, isTransparent

Methods inherited from class com.luciad.view.lightspeed.style.ALspStyle

addStyleChangeListener, getZOrder, isCompatible, removeStyleChangeListener, style

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TLspRulerSegmentLabelContentStyle

protected TLspRulerSegmentLabelContentStyle(TLspRulerSegmentLabelContentStyle.Builder aBuilder)

Method Details

newBuilder

public static TLspRulerSegmentLabelContentStyle.Builder<?> newBuilder()

Creates a new builder with the default values:

• Distance format: TLcdDistanceFormat with user unit metre.
• Azimuth format: a DecimalFormat with pattern "0.0°".
• Display azimuth: false.

Returns:

the new builder.

asBuilder

public TLspRulerSegmentLabelContentStyle.Builder<?> asBuilder()

Creates a new builder initialized with all the properties of this style.

Overrides:

asBuilder in class TLspRulerDistanceFormatStyle

Returns:

the new builder.

getAzimuthFormat

public Format getAzimuthFormat()

Returns the used azimuth format.

Returns:

the current azimuth format.

isDisplayAzimuth

public boolean isDisplayAzimuth()

Returns whether or not the azimuth is displayed in the segment labels.

Returns:

true if azimuth are to be displayed, false otherwise.

getText

public String[] getText(Object aDomainObject,
 Object aSubLabelID,
 TLspContext aContext)

Description copied from class: ALspLabelTextProviderStyle

Returns text (one or more strings) for the given domain object and sublabel ID. When no label should be painted, this method should return null or an empty array.

By default, this method returns an array containing only the result of the toString() method of the given domain object.

When overriding this method, the implementation should make sure that the returned text is consistent for the given label. I.e. it should not return a different String every time it is called for a given label. Not doing so may lead to worse performance and incorrectly visualized labels.

Overrides:

getText in class TLspRulerDistanceFormatStyle

Parameters:

aDomainObject - a domain object.

aSubLabelID - a sublabel ID.

aContext - the context.

Returns:

text for the given identifier.

equals

public boolean equals(Object o)

Overrides:

equals in class TLspRulerDistanceFormatStyle

hashCode

public int hashCode()

Overrides:

hashCode in class TLspRulerDistanceFormatStyle