Package com.solibri.smc.api.settings

Interface SettingDialog

  • public interface SettingDialog
    SettingDialog defines a custom dialog for custom settings.
    Since:
    9.12.0

    • Method Detail

      • getUniqueId

        String getUniqueId()
        The unique ID of the setting dialog. This needs to be globally unique.
        Returns:
        the ID of the setting dialog
        Since:
        9.12.0

      • getName

        default String getName()
        The internationalized name of the setting dialog. The default implementation returns value based on properties files value with key "NAME". Returns the ID of the setting dialog if no property is found.
        Returns:
        the name of the setting dialog
        Since:
        9.12.0

      • getDescription

        default String getDescription()
        The internationalized description of the setting dialog. The default implementation returns value based on properties files value with key "DESCRIPTION". Returns the name of the setting dialog if no property is found.
        Returns:
        the description of the setting dialog
        Since:
        9.12.0

      • getIcon

        default Icon getIcon()
        Returns the icon for the setting dialog. The default implementation tries to find icon from file called icon.png and uses that if it is found from the same package as the view. If icon.png does not exist, the properties file for the view is searched for property called ICON and the relative path given in that property is used.
        Returns:
        the icon
        Since:
        9.12.0

      • getSettingGroups

        List<Class<? extends SettingGroup>> getSettingGroups()
        Returns a list of the setting groups that are included in this dialog.
        Returns:
        the list of the setting groups
        Since:
        9.12.0