com.luciad.view.lightspeed.style

LuciadLightspeedClass TLspParameterizedRasterIconStyle.Builder<B extends TLspParameterizedRasterIconStyle.Builder<B>>

java.lang.Object

com.luciad.view.lightspeed.style.ALspStyle.Builder<B>

com.luciad.view.lightspeed.style.TLspParameterizedRasterIconStyle.Builder<B>

Enclosing class:

TLspParameterizedRasterIconStyle

public static class TLspParameterizedRasterIconStyle.Builder<B extends TLspParameterizedRasterIconStyle.Builder<B>>
extends ALspStyle.Builder<B>

Builder for parameterized icon styles. The default icon style has a 1 pixel wide white halo color.

Use the icon(com.luciad.format.raster.ILcdParameterizedIcon) method to set a valid icon.

Since:

2013.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
B	all(ALspStyle aStyle) Sets all parameters on the builder based on the given style.
TLspParameterizedRasterIconStyle	build() Builds the style with the set parameters.
B	haloColor(Color aHaloColor) Sets the halo color of multi-valued raster icons.
B	haloThickness(float aHaloThickness) Sets the halo thickness of multi-valued raster icons in pixels.
B	icon(ILcdParameterizedIcon aIcon) Sets the icon to use for multi-valued rasters (if any).
B	spacing(int aIconSpacing) Sets the grid spacing of multi-valued raster icons (if any), expressed in pixels.
String	toString()

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

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

spacing

public B spacing(int aIconSpacing)

Sets the grid spacing of multi-valued raster icons (if any), expressed in pixels.

Parameters:

aIconSpacing - the icon spacing, or -1 if a default should be chosen

Returns:

this

See Also:

icon(com.luciad.format.raster.ILcdParameterizedIcon)

icon

public B icon(ILcdParameterizedIcon aIcon)

Sets the icon to use for multi-valued rasters (if any).
The specified icon will be painted at regular grid locations in the view.

Parameters:

aIcon - the icon to use, or null for a default icon

Returns:

this

See Also:

spacing(int), ILcdMultivaluedRaster

haloThickness

public B haloThickness(float aHaloThickness)

Sets the halo thickness of multi-valued raster icons in pixels. Set to zero if no halo should be visible.

By default, the halo thickness is 1.

Parameters:

aHaloThickness - the thickness in pixels

Returns:

this

See Also:

haloColor(java.awt.Color)

haloColor

public B haloColor(Color aHaloColor)

Sets the halo color of multi-valued raster icons. This property is only used if the halo thickness is larger than 0.

By default, the halo color is Color.white.

Parameters:

aHaloColor - the halo color

Returns:

this

Throws:

IllegalArgumentException - if aHaloColor==null

See Also:

haloThickness(float)

all

public B all(ALspStyle aStyle)

Description copied from class: ALspStyle.Builder

Sets all parameters on the builder based on the given style.

This is useful for example to create a new style that has almost all properties equal to another style.

Specified by:

all in class ALspStyle.Builder<B extends TLspParameterizedRasterIconStyle.Builder<B>>

Parameters:

aStyle - the style to copy

Returns:

this

build

public TLspParameterizedRasterIconStyle build()

Description copied from class: ALspStyle.Builder

Builds the style with the set parameters.

Specified by:

build in class ALspStyle.Builder<B extends TLspParameterizedRasterIconStyle.Builder<B>>

Returns:

the resulting style

toString

public String toString()

Overrides:

toString in class Object