Package org.opennms.features.topology.api

Interface IconManager

    • Method Detail

      • findRepositoryByIconKey

        IconRepository findRepositoryByIconKey​(java.lang.String iconKey)
        Returns the first IconRepository which has the provided iconKey mapping defined.
        Parameters:
        iconKey - the iconKey to look up
        Returns:
        the first IconRepository which has the provided iconKey mapping defined, or null if no IconRepository exists with the provided iconKey

      • getSVGIconFiles

        java.util.List<java.lang.String> getSVGIconFiles()
        Returns the list of available svg-files, e.g. 'theme://svg/file.svg'.
        Returns:
        the list of available svg-files, e.g. 'theme://svg/file.svg'

      • getSVGIconId

        java.lang.String getSVGIconId​(java.lang.String iconKey)
        Returns the icon id assigned to the provided iconKey.
        Parameters:
        iconKey - the iconKey to look up
        Returns:
        the icon id assigned to the provided iconKey

      • getSVGIconId

        java.lang.String getSVGIconId​(Vertex vertex)
        Returns the icon id assigned to the provided Vertex.
        Parameters:
        vertex - the vertex to get the icon id for
        Returns:
        the icon id assigned to the provided Vertex

      • setIconMapping

        java.lang.String setIconMapping​(Vertex vertex,
                                java.lang.String newIconId)
        Sets a new icon mapping from the Vertex to the newIconId.
        Parameters:
        vertex - the vertex to map
        newIconId - the icon id to map the vertex to
        Returns:
        the icon key of the vertex if this IconManager was able to save the mapping, null otherwise

      • removeIconMapping

        boolean removeIconMapping​(Vertex vertex)
        Removes the icon mapping for the Vertex if defined.
        Parameters:
        vertex - the Vertex to remove the icon mapping for
        Returns:
        true if the mapping was removed, false if no icon mapping was found for the provided Vertex and therefore could not be removed