KmlNetworkLink | DME Component Libraries for Java 2024 r3

java.lang.Object
- agi.foundation.graphics.KmlFeature
- - agi.foundation.graphics.KmlNetworkLink

All Implemented Interfaces:: IDisposable, AutoCloseable

public final class KmlNetworkLink
extends KmlFeature
implements IDisposable

A KML network link.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`dispose(boolean disposing)`
`protected void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`String`	`getCookie()` Gets the cookie string associated with this network link.
`String`	`getExpires()` Gets the string specifying the date/time this network should expire and be refreshed.
`String`	`getLinkSnippet()` Gets the link snippet associated with this network link.
`String`	`getMessage()` Gets the message string associated with this network link.
`Duration`	`getMinimumRefreshPeriod()` Gets the duration that is the minimum allowed time between refreshes of this network link.
`Duration`	`getRefreshInterval()` Gets the interval duration at which this network link will refresh, when `RefreshMode` (`get`) is set to `KmlNetworkLinkRefreshMode.OnInterval`.
`KmlNetworkLinkRefreshMode`	`getRefreshMode()` Gets the refresh mode of the network link.
`URI`	`getUri()` Gets the `URI` of the network link.
`double`	`getViewBoundScale()` Gets the value that scales the bounding box defining the view associated with this network link.
`KmlNetworkLinkViewRefreshMode`	`getViewRefreshMode()` Gets the view refresh mode of the network link.
`Duration`	`getViewRefreshTime()` Gets the duration after camera view movement stops that this network link will refresh, when `ViewRefreshMode` (`get`) is set to `KmlNetworkLinkViewRefreshMode.OnStop`.
`void`	`refresh()` Refreshes the network link.
`void`	`setRefreshInterval(Duration value)` Sets the interval duration at which this network link will refresh, when `RefreshMode` (`get`) is set to `KmlNetworkLinkRefreshMode.OnInterval`.
`void`	`setRefreshMode(KmlNetworkLinkRefreshMode value)` Sets the refresh mode of the network link.
`void`	`setViewBoundScale(double value)` Sets the value that scales the bounding box defining the view associated with this network link.
`void`	`setViewRefreshMode(KmlNetworkLinkViewRefreshMode value)` Sets the view refresh mode of the network link.
`void`	`setViewRefreshTime(Duration value)` Sets the duration after camera view movement stops that this network link will refresh, when `ViewRefreshMode` (`get`) is set to `KmlNetworkLinkViewRefreshMode.OnStop`.

Methods inherited from class agi.foundation.graphics.KmlFeature
dispose, flyTo, getBoundingSphere, getContent, getDescription, getDisplay, getIsLoaded, getName, getSnippet, setDisplay

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface agi.foundation.compatibility.IDisposable
close, dispose

- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: java.lang.Object
    
    Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
    The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
    The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
    The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
    After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
    The finalize method is never invoked more than once by a Java virtual machine for any given object.
    Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
    
    Overrides:
    
    finalize in class KmlFeature
    
    Throws:
    
    Throwable - the Exception raised by this method
    
    See Also:
    
    WeakReference, PhantomReference
  - dispose
```
protected void dispose(boolean disposing)
```
    Overrides:
    
    dispose in class KmlFeature
  - getUri
```
public final URI getUri()
```
    Gets the URI of the network link.
  - getRefreshMode
```
public final KmlNetworkLinkRefreshMode getRefreshMode()
```
    Gets the refresh mode of the network link. The refresh mode specifies a time-based refresh policy for this link.
  - setRefreshMode
```
public final void setRefreshMode(KmlNetworkLinkRefreshMode value)
```
    Sets the refresh mode of the network link. The refresh mode specifies a time-based refresh policy for this link.
  - getRefreshInterval
```
public final Duration getRefreshInterval()
```
    Gets the interval duration at which this network link will refresh, when RefreshMode (get) is set to KmlNetworkLinkRefreshMode.OnInterval.
  - setRefreshInterval
```
public final void setRefreshInterval(Duration value)
```
    Sets the interval duration at which this network link will refresh, when RefreshMode (get) is set to KmlNetworkLinkRefreshMode.OnInterval.
  - getViewRefreshMode
```
public final KmlNetworkLinkViewRefreshMode getViewRefreshMode()
```
    Gets the view refresh mode of the network link. The view refresh mode specifies the refresh policy for the when the camera's view changes.
  - setViewRefreshMode
```
public final void setViewRefreshMode(KmlNetworkLinkViewRefreshMode value)
```
    Sets the view refresh mode of the network link. The view refresh mode specifies the refresh policy for the when the camera's view changes.
  - getViewRefreshTime
```
public final Duration getViewRefreshTime()
```
    Gets the duration after camera view movement stops that this network link will refresh, when ViewRefreshMode (get) is set to KmlNetworkLinkViewRefreshMode.OnStop.
  - setViewRefreshTime
```
public final void setViewRefreshTime(Duration value)
```
    Sets the duration after camera view movement stops that this network link will refresh, when ViewRefreshMode (get) is set to KmlNetworkLinkViewRefreshMode.OnStop.
  - getViewBoundScale
```
public final double getViewBoundScale()
```
    Gets the value that scales the bounding box defining the view associated with this network link. A value less than 1.0 specifies to use less than the full view (screen). A value greater than 1.0 specifies to refresh an area that extends beyond the edges of the current view.
  - setViewBoundScale
```
public final void setViewBoundScale(double value)
```
    Sets the value that scales the bounding box defining the view associated with this network link. A value less than 1.0 specifies to use less than the full view (screen). A value greater than 1.0 specifies to refresh an area that extends beyond the edges of the current view.
  - getMinimumRefreshPeriod
```
public final Duration getMinimumRefreshPeriod()
```
    Gets the duration that is the minimum allowed time between refreshes of this network link.
  - getCookie
```
public final String getCookie()
```
    Gets the cookie string associated with this network link.
  - getMessage
```
public final String getMessage()
```
    Gets the message string associated with this network link.
  - getLinkSnippet
```
public final String getLinkSnippet()
```
    Gets the link snippet associated with this network link.
  - getExpires
```
public final String getExpires()
```
    Gets the string specifying the date/time this network should expire and be refreshed.
  - refresh
```
public final void refresh()
```
    Refreshes the network link.

Class KmlNetworkLink

Method Summary

Methods inherited from class agi.foundation.graphics.KmlFeature

Methods inherited from class java.lang.Object

Methods inherited from interface agi.foundation.compatibility.IDisposable

Method Detail

finalize

dispose

getUri

getRefreshMode

setRefreshMode

getRefreshInterval

setRefreshInterval

getViewRefreshMode

setViewRefreshMode

getViewRefreshTime

setViewRefreshTime

getViewBoundScale

setViewBoundScale

getMinimumRefreshPeriod

getCookie

getMessage

getLinkSnippet

getExpires

refresh