com.solibri.smc.api.settings

Interface SettingGroup

public interface SettingGroup

SettingGroup defines a setting group for the application. 3rd party developers can implement this interface to be able to have their custom settings visible grouped in the UI.

Since:

9.10.8

Method Summary

Modifier and Type	Method and Description
default String	getName() The internationalized name of the setting group.
List<Class<? extends Setting<?>>>	getSettings() Returns the classes of the individual custom settings included in this group.
String	getUniqueId() The unique ID of the setting group.

Method Detail

getUniqueId

String getUniqueId()

The unique ID of the setting group. This needs to be globally unique.

Returns:

the ID of the setting group

Since:

9.10.8

getName

default String getName()

The internationalized name of the setting group. The default implementation returns value based on properties files value with key "NAME". Returns the ID of the setting group if no property is found.

Returns:

the name of the view

Since:

9.10.8

getSettings

List<Class<? extends Setting<?>>> getSettings()

Returns the classes of the individual custom settings included in this group. Note that this design makes it possible for one custom setting to be include in multiple groups. Including a custom setting in multiple groups does not create multiple instances of that setting and changing the value of that setting through one the groups from the UI or through the API directly would change it globally since the setting has only one instance of itself.

Returns:

the list of included settings