com.luciad.lucy.addons.map

LuciadLightspeedInterface TLcyMapEditUnitAddOn.PointFormatProvider

Enclosing class:

TLcyMapEditUnitAddOn

public static interface TLcyMapEditUnitAddOn.PointFormatProvider

Allows plugging in a custom pattern-based point format that can be used in ILcyLucyEnv.setDefaultLonLatPointFormat(Format). Refer to the add-on's configuration files for more information on how to enable the format in your GUI.

Since:

2021.1

Method Summary

Modifier and Type	Method and Description
java.text.Format	create(java.lang.String aPattern) Creates a new format using the given pattern.
java.lang.String	retrieveIdentifier() An identifier for the custom format.
java.lang.String	retrievePattern(java.text.Format aFormat) Retrieves the configuration pattern currently used by the given format.

Method Detail

retrieveIdentifier

java.lang.String retrieveIdentifier()

An identifier for the custom format. This is used as prefix in the configuration files and for workspace support.

Returns:

a unique identifier for the format, e.g. "MyCustomPointFormats"

create

java.text.Format create(java.lang.String aPattern)

Creates a new format using the given pattern. The pattern can determine the content, separators, precision, and more. For example, EBNF notation strings could be used. The pattern is specified in the configuration file.

Parameters:

aPattern - a format specific pattern that determines the configuration of the format

Returns:

a new format configured using the given pattern

Throws:

java.lang.IllegalArgumentException - if the pattern is invalid or unsupported

retrievePattern

java.lang.String retrievePattern(java.text.Format aFormat)

Retrieves the configuration pattern currently used by the given format. The pattern can determine the content, separators, precision, and more.

Parameters:

aFormat - the format to retrieve the pattern from

Returns:

the current pattern of the given format, or null if the format is not supported by this provider