com.luciad.lucy.map

LuciadLightspeedInterface ILcyLayerStyleProvider

All Known Implementing Classes:

TLcyCompositeLayerStyleProvider

public interface ILcyLayerStyleProvider

Provides operations to retrieve and copy a layer's style.

To register a style provider, add it as a service to the Lucy backend. A layer's style should be contained in a ILcyLayerStyle and can be used to describe its visibility, painter settings, ...

Layer styles can be used to copy the style of the layer within layers of the same format.

Method Summary

Modifier and Type	Method and Description
void	applyStyle(ILcyLayerStyle aLayerStyle, ILcdLayer aLayerSFCT) Applies the given style to the given layer.
boolean	canApplyStyle(ILcyLayerStyle aLayerStyle, ILcdLayer aLayerSFCT) Returns true if the provider can apply the given style to the given layer.
boolean	canGetStyle(ILcdLayer aLayer) Returns true if the provider can return the given layer's style.
ILcyLayerStyle	getStyle(ILcdLayer aLayer) Returns the layer style of the given layer.

Method Detail

getStyle

ILcyLayerStyle getStyle(ILcdLayer aLayer)

Returns the layer style of the given layer. As a result, modifying this style after it has been retrieved updates the layer style.

When this ILcyLayerStyleProvider is unable to retrieve the layer's style, null should be returned.

Parameters:

aLayer - The layer to get the style from.

Returns:

The style.

canGetStyle

boolean canGetStyle(ILcdLayer aLayer)

Returns true if the provider can return the given layer's style.

Parameters:

aLayer - the layer to get the style from

Returns:

true if the provider can return the given layer's style, false otherwise.

See Also:

getStyle(com.luciad.view.ILcdLayer)

applyStyle

void applyStyle(ILcyLayerStyle aLayerStyle,
                ILcdLayer aLayerSFCT)

Applies the given style to the given layer. As a result, the layer is modified to match the given style. Modifying the style object after it has been applied has no effect.

Parameters:

aLayerStyle - The style to apply.

aLayerSFCT - The layer to update.

canApplyStyle

boolean canApplyStyle(ILcyLayerStyle aLayerStyle,
                      ILcdLayer aLayerSFCT)

Returns true if the provider can apply the given style to the given layer.

Parameters:

aLayerStyle - The style to apply.

aLayerSFCT - The layer to update.

Returns:

true if the provider can apply the given style to the given layer, false otherwise

See Also:

applyStyle(ILcyLayerStyle, com.luciad.view.ILcdLayer)