Package com.luciad.symbology.common.view

Class TLcdEngagementBarStyle

java.lang.Object

com.luciad.symbology.common.view.TLcdEngagementBarStyle

All Implemented Interfaces:

ILcdCloneable, Serializable, Cloneable

public final class TLcdEngagementBarStyle
extends Object
implements Serializable, ILcdCloneable

Styling options for the Engagement Bar graphic amplifier.

A new instance of this class can be built using a TLcdEngagementBarStyle.Builder which can be created using the newBuilder() method.

You can also create a modified copy of an existing instance.

Since:

2018.2

See Also:

• ILcdAPP6ACoded.sEngagementBar
• ILcdMS2525bCoded.sEngagementBar
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TLcdEngagementBarStyle.Builder	Builder class for TLcdEngagementBarStyle.
static enum	TLcdEngagementBarStyle.TargetDesignation	All possible target designation values.

Method Summary

Modifier and Type	Method	Description
TLcdEngagementBarStyle.Builder	asBuilder()
Object	clone()	Makes Object.clone() public.
boolean	equals(Object aO)
Font	getFont()
Color	getFontColor()
Optional<Color>	getForcedFillColor()
Color	getFrameColor()
int	getFrameWidth()
Optional<TLcdEngagementBarStyle.TargetDesignation>	getTargetDesignation()
Color	getTargetDesignationFillColor(TLcdEngagementBarStyle.TargetDesignation aTargetDesignation)
int	hashCode()
boolean	isFontScalingEnabled()
static TLcdEngagementBarStyle.Builder	newBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static TLcdEngagementBarStyle.Builder newBuilder()

Returns:

a new instance of TLcdEngagementBarStyle.Builder with all properties initialized to their default values.

getFrameWidth

public int getFrameWidth()

Returns:

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

Defaults to 3.

getFrameColor

public Color getFrameColor()

Returns:

The color of the engagement bar's frame.

Defaults to Color.BLACK.

getForcedFillColor

public Optional<Color> getForcedFillColor()

Returns:

An Optional containing a color which is used to override the default fill color, or an empty optional if the default fill color is used.

Default to Optional.empty().

The default fill color is either based on this style's targetDesignation, if it is present. Otherwise the styled symbol's affiliation color will be used.

isFontScalingEnabled

public boolean isFontScalingEnabled()

Returns:

boolean indicating whether font is scaled along with the size of the symbols as defined in the symbols style.

Defaults to true

See Also:

• TLcdMilitarySymbolStyle.getSizeSymbol()

getFont

public Font getFont()

Returns:

The font of the engagement bar's content.

Defaults to Dialog, BOLD, 12 pts.

getFontColor

public Color getFontColor()

Returns:

The font color of the engagement bar's content.

Defaults to Color.BLACK

getTargetDesignation

public Optional<TLcdEngagementBarStyle.TargetDesignation> getTargetDesignation()

Returns:

An Optional containing this engagement bar's TLcdEngagementBarStyle.TargetDesignation, or an empty optional if this engagement bar does not denote a TLcdEngagementBarStyle.TargetDesignation.

Default to Optional.empty()

getTargetDesignationFillColor

public Color getTargetDesignationFillColor(TLcdEngagementBarStyle.TargetDesignation aTargetDesignation)

Returns:

The fill color used for the given TLcdEngagementBarStyle.TargetDesignation

Defaults:

• TLcdEngagementBarStyle.TargetDesignation.TARGET: Color.RED
• TLcdEngagementBarStyle.TargetDesignation.NON_TARGET: Color.WHITE
• TLcdEngagementBarStyle.TargetDesignation.EXPIRED: new Color(255, 120, 0) // orange

equals

public boolean equals(Object aO)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

asBuilder

public TLcdEngagementBarStyle.Builder asBuilder()

Returns:

a TLcdEngagementBarStyle.Builder initialized with this TLcdEngagementBarStyle's property values.

clone

public Object clone()

Description copied from interface: ILcdCloneable

Makes Object.clone() public.

When for example extending from java.lang.Object, it can be implemented like this:

 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
 

Specified by:

clone in interface ILcdCloneable

Overrides:

clone in class Object

See Also:

• Object.clone()