Interface RendererLibrary

  • All Known Implementing Classes:
    AbstractRendererLibrary

    public interface RendererLibrary
    Main interface for renderer implementations.

    A renderer library must:

    • Perform all the required initializations before any displayer can be drawn
    • Declare the displayer types & subtypes supported
    • Take care of the initialization of displayer instances
    • Method Detail

      • getUUID

        String getUUID()
        The unique universal identifier of the rederer
      • getName

        String getName()
        The renderer display name
      • isDefault

        boolean isDefault​(org.dashbuilder.displayer.DisplayerType type)
        Flag indicating if this renderer can act as the default one for the given displayer type.

        Default renderers are used when a displayer does not explicitly specifies one

      • getSupportedTypes

        List<org.dashbuilder.displayer.DisplayerType> getSupportedTypes()
        The list of supported types
      • getSupportedSubtypes

        List<org.dashbuilder.displayer.DisplayerSubType> getSupportedSubtypes​(org.dashbuilder.displayer.DisplayerType displayerType)
        The list of supported sub-types
      • lookupDisplayer

        Displayer lookupDisplayer​(org.dashbuilder.displayer.DisplayerSettings displayer)
        Initalize a displayer instance with the specified configuration.
      • draw

        void draw​(List<Displayer> displayerList)
        Draw a list of displayers
      • redraw

        void redraw​(List<Displayer> displayerList)
        Re-draw a list of displayers
      • isOffline

        default boolean isOffline()