Package jetbrains.buildServer.web.openapi

Interface PagePlace

  • public interface PagePlace
    Identifies a place on the page that can be extended with plugins

    • Method Detail

      • getId

        @NotNull
PlaceId getId()
        Unique identifier of this page place
        Returns:
        page place identifier

      • addExtension

        void addExtension​(@NotNull
                  PageExtension pageExtension)
        Adds new extension to this place (to the tail of extensions)
        Parameters:
        pageExtension - page extension

      • addExtension

        void addExtension​(@NotNull
                  PageExtension pageExtension,
                  @Nullable
                  PositionConstraint positionConstraint)
        Adds new extension with position preference. By default extension position is based on the extensions registration order, but with help of constraints it is possible to explicitly place extension in relation to other extensions.
        Parameters:
        pageExtension - page extension
        positionConstraint - constraint which can be used to position extension near other extensions
        Since:
        5.1

      • addExtension

        @Deprecated
void addExtension​(@NotNull
                  PageExtension pageExtension,
                  int zeroBasedPosition)
        Deprecated.
        since 5.1
        Adds new extension to this place, to the specified position. Explicit position should be >= 0, negative value means position undefined. Extensions will be ordered to match requested position as much as possible.
        Parameters:
        pageExtension - page extension
        zeroBasedPosition - position for the extension, starting with 0; negative value means first available position

      • removeExtension

        boolean removeExtension​(@NotNull
                        PageExtension pageExtension)
        Removes extension from this place
        Parameters:
        pageExtension - extension to remove
        Returns:
        true if extension was removed

      • getAvailableExtensions

        @NotNull
java.util.List<PageExtension> getAvailableExtensions​(@NotNull
                                                     javax.servlet.http.HttpServletRequest request)
        Returns list of page extensions registered for this place and available for the specified request
        Parameters:
        request - HTTP request
        Returns:
        list of page extensions

      • getRegisteredExtensions

        @NotNull
java.util.List<PageExtension> getRegisteredExtensions()
        Returns all registered extensions
        Returns:
        all registered extensions