Package com.polarion.alm.ui.server.navigation

Class NavigationExtenderNode

java.lang.Object
com.polarion.alm.ui.server.navigation.NavigationExtenderNode
public abstract class NavigationExtenderNode extends Object
Since:
3.8.0

  • Constructor Details

    • NavigationExtenderNode

      public NavigationExtenderNode()

  • Method Details

    • getId

      @NotNull public abstract String getId()
      Returns the id of the NavigationExtenderNode.
      Returns:
      id of the node.

    • getLabel

      @NotNull public abstract String getLabel()
      Returns the localized label of the NavigationExtenderNode.
      Returns:
      label to be displayed in the navigation panel.

    • getIconUrl

      @Nullable public abstract String getIconUrl()
      Returns the URL of the node's icon.
      Returns:
      URL of the icon associated with the node

    • getPageUrl

      @Nullable public abstract String getPageUrl(IContextId contextId)
      Returns URL to be opened in the main IFRAME. If the URL is present, clicking the node will open it. If the URL is not present, clicking the node will open it and show it's children. If URL is from local site (the same hostname, subdomain, and port) the navigation will try to check for unsaved changes by calling 'areThereUnsavedChanges()' global JavaScript method on provided URL when user leaves it. If URL is from a different site, no check about unsaved changes will be performed. Each NavigationExtenderNode needs to have either pageUrl or child nodes. If it doesn't have any of those two, node won't be displayed. Polarion will append an attribute named "token" to the URL. In order to get the associated username from the token, use SecurityWebService.getUserFromToken(String) with the value of the attribute "token" as parameter.
      Parameters:
      contextId -
      Returns:
      associated URL to be opened in IFRAME in this context. null if there is no URL.

    • requiresToken

      public abstract boolean requiresToken()
      Returns true if page requires a token. If true, polarion will append an attribute named "token" to the URL. In order to get the associated username from the token, use SecurityWebService.getUserFromToken(String) with the value of the attribute "token" as parameter.
      Returns:
      true if token is required

    • getChildren

      @NotNull public abstract List<NavigationExtenderNode> getChildren()
      NavigationExtenderNode can have children nodes. This method returns its direct descendants. Each NavigationExtenderNode needs to have either pageUrl or child nodes. If it doesn't have any of those two, node won't be displayed.
      Returns:
      list of child nodes or an empty List.