Class KmlNetworkLink


  • public final class KmlNetworkLink
    extends KmlNode
    A KML network link references other KML resources, locally or on the network.

    A KML network link can have a refresh interval defined to enable regular refresh of data. Alternatively, KML network links support a view refresh mode, which fetches network links based on the visible extent.

    Since:
    100.4.0
    • Method Detail

      • getListItemType

        public KmlContainer.ListItemType getListItemType()
        Get the network link's list item type, which defines how child nodes behave when setting visibility.
        Returns:
        the network link's list item type
        Since:
        100.4.0
      • getChildNodes

        public List<KmlNode> getChildNodes()
        Gets the KML network link's child nodes. If this network link node is refreshed the list will be invalidated and this method should be called again to get the new list.
        Returns:
        an unmodifiable list of child nodes
        Since:
        100.4.0
      • isOpen

        public boolean isOpen()
        Gets a value indicating that the network link node should be shown expanded in a tree view.
        Returns:
        true if the node is open, false otherwise
        Since:
        100.4.0
      • setOpen

        public void setOpen​(boolean open)
        Sets whether the network link node should be shown expanded/collapsed in a tree view.
        Parameters:
        open - true to set the node open, false otherwise
        Since:
        100.4.0
      • isPartiallyVisible

        public boolean isPartiallyVisible()
        Gets a value indicating that the network link node has mixed visibility.

        A KmlNode is considered partially visible if some of its child KmlNodes are visible and some are not. Otherwise, it returns false if all child KmlNodes are either visible or invisible.

        Returns:
        true if the network link node is partially visible, false otherwise
        Since:
        100.4.0
      • canFlyToNode

        public boolean canFlyToNode()
        Gets a value indicating that the app should zoom to the viewpoint defined on the associated NetworkLinkControl or the network link's top-level <kml> node upon refresh of the link.

        It is the developer's responsibility to implement this behavior if desired; Runtime will not automatically fly to the node on network link refresh.

        The property is defined in the flyToView tag in the KML network link.

        Returns:
        true if the network link will fly to the link view after loading, false otherwise.
        Since:
        100.4.0
      • hasRefreshVisibility

        public boolean hasRefreshVisibility()
        Gets a value indicating that Runtime should attempt to maintain the visibility selection of child nodes in the network link after refresh.

        If true, Runtime will attempt to maintain any visibility selection for the network link's child nodes after refresh. This is the default behavior when refreshVisibility is set to 0 or unset in the source KML file.

        Returns:
        true if the KML network link will refresh child visibility after loading, false otherwise
        Since:
        100.4.0
      • getUri

        public String getUri()
        Gets the KML network link data path.
        Returns:
        the KML network link data path
        Since:
        100.4.0