Package com.almworks.jira.structure.api.settings

Interface UISettings

All Known Implementing Classes:
UISettingsBean
public interface UISettings

Provides access to the user interface settings of the Structure Widget. These settings govern various aspects of Structure Widget configuration and behavior.

There's a global default settings collection and they can be tweaked per-user and possibly per-project. See StructureConfiguration.setUISettings(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.project.Project, com.almworks.jira.structure.api.settings.UISettings) for mode detail.

A null value is treated as "not set". In most cases when an instance of UISettings is retrieved from StructureConfiguration, all possible settings will have a value. "Not set" makes more sense when updating settings, where only the specified settings will be updated.

Author:
Igor Sereda
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getAutoCollapseStructurePanel()
    Returns true if Structure panel on the issue page should automatically collapse/minimize when the displayed issue is not present in the initially selected structure.
    AutoSwitchStrategy
    getAutoSwitchStrategy(StructurePage page)
    Returns auto-switch strategy for the specified page.
    Boolean
    getKeepStructureWhileNavigating()
    Returns true if the structure selection should be kept when the user clicks on an issue in the Structure widget.
    boolean
    isAnythingSet()
    Utility method that is used to check whether this instance does not have any settings set at all.

  • Method Details

    • getAutoSwitchStrategy

      @Nullable AutoSwitchStrategy getAutoSwitchStrategy(@NotNull StructurePage page)
      Returns auto-switch strategy for the specified page. Auto-switch strategy defines which structure to load at the initial page load.
      Parameters:
      page - structure page that is being loaded, currently only StructurePage.ISSUE_VIEW, StructurePage.PROJECT_TAB, StructurePage.COMPONENT_TAB and StructurePage.VERSION_TAB make sense.
      Returns:
      auto-switch strategy for the specified page, or null if not set

    • getAutoCollapseStructurePanel

      @Nullable Boolean getAutoCollapseStructurePanel()
      Returns true if Structure panel on the issue page should automatically collapse/minimize when the displayed issue is not present in the initially selected structure.
      Returns:
      true if structure panel auto-collapse is enabled, or null if the settings is unknown

    • getKeepStructureWhileNavigating

      @Nullable Boolean getKeepStructureWhileNavigating()

      Returns true if the structure selection should be kept when the user clicks on an issue in the Structure widget.

      This allows the user to go from one issue to another, looking at the Structure panel, and the structure displayed will remain the same. If the user opens an issue page by any other means, the structure will be selected according to other settings.

      The default value for this setting (in case null is returned) is true.

      Returns:
      true if the structure selection should be kept when opening an issue page through the Structure widget

    • isAnythingSet

      boolean isAnythingSet()
      Utility method that is used to check whether this instance does not have any settings set at all.
      Returns:
      true if at least one setting is defined