Package com.luciad.layers.features

Class FeatureState

java.lang.Object

com.luciad.layers.features.FeatureState

All Implemented Interfaces:

AutoCloseable

public final class FeatureState
extends Object
implements AutoCloseable

Representation of the state of a feature.

By default the following states exist:

• selected
• hover

It is possible to register custom feature states using FeatureState#registerValue. You can use such custom feature states to style objects differently.

Field Summary

Fields

Modifier and Type	Field	Description
static FeatureState	Hover	A feature state representing an object that is under the cursor.
static FeatureState	Selected	A feature state representing an object that is selected.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	equals(Object other)
protected void	finalize()
String	getName()	Returns the name of this FeatureState.
static FeatureState	getValue(String name)	Returns the FeatureState with the given name.
static List<@NotNull FeatureState>	getValues()	Returns the registered feature states.
int	hashCode()
static FeatureState	registerValue(String name)	Registers a new FeatureState with the given name.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

Selected

public static FeatureState Selected

A feature state representing an object that is selected.

Hover

public static FeatureState Hover

A feature state representing an object that is under the cursor.

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

getValues

@NotNull
public static List<@NotNull FeatureState> getValues()

Returns the registered feature states.

This includes the selection states that are available by default.

Returns:

the registered feature states.

registerValue

@NotNull
public static FeatureState registerValue(@NotNull
 String name)
                                  throws IllegalArgumentException

Registers a new FeatureState with the given name.

It is not allows the register multiple FeatureStates with the same name. If not, an exception will be thrown.

Parameters:

name - the name for the feature state. Must be unique.

Throws:

IllegalArgumentException - if the value already exists.

getValue

@NotNull
public static FeatureState getValue(@NotNull
 String name)
                             throws IllegalArgumentException

Returns the FeatureState with the given name.

If no such FeatureState exists, an exception will be thrown.

Parameters:

name - the name of the FeatureState.

Returns:

the FeatureState with the given name.

Throws:

IllegalArgumentException - if there is no feature state for the given name.

getName

@NotNull
public String getName()

Returns the name of this FeatureState.

Returns:

the name of this FeatureState.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 Object other)

Overrides:

equals in class Object