Package com.luciad.layers.styles

Class PinStyle

java.lang.Object

com.luciad.layers.styles.PinStyle

All Implemented Interfaces:

AutoCloseable

public final class PinStyle
extends Object
implements AutoCloseable

This class contains styling properties that can be used to configure pins for labels, see FeatureCanvas.LabelDrawCommand#pinStyle.

You can create instances of this class using PinStyle#newBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PinStyle.Builder	A builder class for creating pin styles that can be set up to labels, see FeatureCanvas.LabelDrawCommand#pinStyle.
static enum	PinStyle.EndPosition	Possible positions for the end of the pin.

Method Summary

Modifier and Type	Method	Description
PinStyle.Builder	asBuilder()	Returns a PinStyle builder that has all properties of this PinStyle.
void	close()
protected void	finalize()
PinStyle.EndPosition	getEndPosition()	Returns the location where the pin line connects to the label.
LineStyle	getLineStyle()	Returns the line style used to paint the pin.
double	getVisibilityThreshold()	Returns the number of pixels that determine the visibility of a pin line.
static PinStyle.Builder	newBuilder()	Returns a new builder for creating a PinStyle.

Methods inherited from class java.lang.Object

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

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

newBuilder

@NotNull
public static PinStyle.Builder newBuilder()

Returns a new builder for creating a PinStyle.

Returns:

a new builder for creating a PinStyle.

getEndPosition

@NotNull
public PinStyle.EndPosition getEndPosition()

Returns the location where the pin line connects to the label.

Returns:

the location where the pin line connects to the label.

getVisibilityThreshold

public double getVisibilityThreshold()

Returns the number of pixels that determine the visibility of a pin line.

If the pin line length is smaller than this value, it will be discarded.

Returns:

the number of pixels that determine the visibility of a pin line.

getLineStyle

@NotNull
public LineStyle getLineStyle()

Returns the line style used to paint the pin.

Returns:

the line style used to paint the pin

asBuilder

@NotNull
public PinStyle.Builder asBuilder()

Returns a PinStyle builder that has all properties of this PinStyle.

Returns:

a PinStyle builder that has all properties of this PinStyle.