Package jetbrains.buildServer.usageStatistics.presentation

Interface UsageStatisticsPresentationManager

  • @SystemProvided
public interface UsageStatisticsPresentationManager
    Manages the usage statistics UI representation.
    Since:
    6.5.2

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void applyPresentation​(java.lang.String id, java.lang.String displayName, java.lang.String groupName, UsageStatisticsFormatter formatter, java.lang.String valueTooltip)
      Registers a UI representation for specified usage statistic.
      void setGroupType​(java.lang.String groupName, java.lang.String groupTypeId, PositionAware groupPosition, com.intellij.openapi.util.UserDataHolder groupSettings)
      Sets a custom renderer for a specific usage statistics group.

    • Method Detail

      • applyPresentation

        void applyPresentation​(@NotNull
                       java.lang.String id,
                       @Nullable
                       java.lang.String displayName,
                       @Nullable
                       java.lang.String groupName,
                       @Nullable
                       UsageStatisticsFormatter formatter,
                       @Nullable
                       java.lang.String valueTooltip)
        Registers a UI representation for specified usage statistic.
        Parameters:
        id - Statistic identifier.
        displayName - The string to use in UI for displaying this statistic. If it is null the identifier is used.
        groupName - This parameter is used to group the statistics in UI. Statistics with equal group names are put in one group. Statistics with the null group name are put in group "Miscellaneous".
        formatter - This object determines how the values of this statistic will be shown in UI. If formatter is null, the default behavior is used: if the value is not null the String.valueOf(Object) method is used to show the value in UI, otherwise the string "N/A" is used.
        valueTooltip - tooltip for the statistic value

      • setGroupType

        void setGroupType​(@NotNull
                  java.lang.String groupName,
                  @NotNull
                  java.lang.String groupTypeId,
                  @NotNull
                  PositionAware groupPosition,
                  @Nullable
                  com.intellij.openapi.util.UserDataHolder groupSettings)
        Sets a custom renderer for a specific usage statistics group.
        Parameters:
        groupName - Name of the group.
        groupTypeId - Type id for the group.
        groupSettings - Group settings.