com.luciad.symbology.common.view

Defense SymbologyClass TLcdEngagementBarStyle.Builder

java.lang.Object

com.luciad.symbology.common.view.TLcdEngagementBarStyle.Builder

Enclosing class:

TLcdEngagementBarStyle

public static class TLcdEngagementBarStyle.Builder
extends Object

Builder class for TLcdEngagementBarStyle.

Since:

2018.2

Method Summary

Modifier and Type	Method and Description
TLcdEngagementBarStyle	build()
TLcdEngagementBarStyle.Builder	font(Font aFont) Sets the Font width of the engagement bar.
TLcdEngagementBarStyle.Builder	fontColor(Color aColor) Sets the font Color of the engagement bar.
TLcdEngagementBarStyle.Builder	fontScalingEnabled(boolean aFontScalingEnabled) Sets wether or not font is scaled along with the size of the symbols.
TLcdEngagementBarStyle.Builder	forcedFillColor(Color aForcedFillColor) Sets the forced fill Color of the engagement bar.
TLcdEngagementBarStyle.Builder	frameColor(Color aFrameColor) Sets the frame Color of the engagement bar.
TLcdEngagementBarStyle.Builder	frameWidth(int aFrameWidth) Sets the frame width of the engagement bar.
TLcdEngagementBarStyle.Builder	targetDesignation(TLcdEngagementBarStyle.TargetDesignation aTargetDesignation) Sets the TLcdEngagementBarStyle.TargetDesignation of the engagement bar.
TLcdEngagementBarStyle.Builder	targetDesignationFillColor(TLcdEngagementBarStyle.TargetDesignation aTargetDesignation, Color aFillColor) Sets the fill Color to be used when the given TLcdEngagementBarStyle.TargetDesignation is set on the engagement bar.

Methods inherited from class java.lang.Object

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

Method Detail

frameWidth

public TLcdEngagementBarStyle.Builder frameWidth(int aFrameWidth)

Sets the frame width of the engagement bar.

Parameters:

aFrameWidth - The width of the engagement bar's frame, in pixels.

Returns:

this TLcdEngagementBarStyle.Builder.

Throws:

IllegalArgumentException - if aFrameWidth is smaller than 0.

frameColor

public TLcdEngagementBarStyle.Builder frameColor(Color aFrameColor)

Sets the frame Color of the engagement bar.

Parameters:

aFrameColor - The color of the engagement bar's frame.

Returns:

this TLcdEngagementBarStyle.Builder.

Throws:

NullPointerException - if aFrameColor is null.

forcedFillColor

public TLcdEngagementBarStyle.Builder forcedFillColor(Color aForcedFillColor)

Sets the forced fill Color of the engagement bar.

Parameters:

aForcedFillColor - a color which is used to override the default fill color. Settign this value to null will restore the default fill color.

Returns:

this TLcdEngagementBarStyle.Builder.

fontScalingEnabled

public TLcdEngagementBarStyle.Builder fontScalingEnabled(boolean aFontScalingEnabled)

Sets wether or not font is scaled along with the size of the symbols.

Parameters:

aFontScalingEnabled - the new font scaling value

Returns:

this TLcdEngagementBarStyle.Builder.

font

public TLcdEngagementBarStyle.Builder font(Font aFont)

Sets the Font width of the engagement bar.

Parameters:

aFont - The font of the engagement bar's content.

Returns:

this TLcdEngagementBarStyle.Builder.

Throws:

NullPointerException - if aFont is null.

fontColor

public TLcdEngagementBarStyle.Builder fontColor(Color aColor)

Sets the font Color of the engagement bar.

Parameters:

aColor - The font color of the engagement bar's content.

Returns:

this TLcdEngagementBarStyle.Builder.

Throws:

NullPointerException - if aColor is null.

targetDesignation

public TLcdEngagementBarStyle.Builder targetDesignation(TLcdEngagementBarStyle.TargetDesignation aTargetDesignation)

Sets the TLcdEngagementBarStyle.TargetDesignation of the engagement bar.

Parameters:

aTargetDesignation - the TLcdEngagementBarStyle.TargetDesignation to be set.

Returns:

this TLcdEngagementBarStyle.Builder.

targetDesignationFillColor

public TLcdEngagementBarStyle.Builder targetDesignationFillColor(TLcdEngagementBarStyle.TargetDesignation aTargetDesignation,
                                                                 Color aFillColor)

Sets the fill Color to be used when the given TLcdEngagementBarStyle.TargetDesignation is set on the engagement bar.

Parameters:

aTargetDesignation - the TLcdEngagementBarStyle.TargetDesignation for which the fill color will be applied.

aFillColor - the fill color used for the given TLcdEngagementBarStyle.TargetDesignation.

Returns:

this TLcdEngagementBarStyle.Builder.

Throws:

NullPointerException - if aFillColor or aTargetDesignation is null.

build

public TLcdEngagementBarStyle build()

Returns:

a new instance of TLcdEngagementBarStyle with its styling properties initialized to the values of this TLcdEngagementBarStyle.Builder's properties.