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.
StructureConfiguration
Modifier and Type | Method and 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.
|
@Nullable AutoSwitchStrategy getAutoSwitchStrategy(@NotNull StructurePage page)
page
- structure page that is being loaded, currently only StructurePage.ISSUE_VIEW
,
StructurePage.PROJECT_TAB
, StructurePage.COMPONENT_TAB
and StructurePage.VERSION_TAB
make sense.null
if not set@Nullable Boolean getAutoCollapseStructurePanel()
null
if the settings is unknown@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
.
boolean isAnythingSet()
Copyright © 2023 ALM Works. All Rights Reserved.