Package io.deephaven.web.client.api.widget

Class JsWidgetExportedObject

java.lang.Object

io.deephaven.web.client.api.widget.JsWidgetExportedObject

All Implemented Interfaces:

ServerObject

@TsInterface
@TsName(namespace="dh",
        name="WidgetExportedObject")
public class JsWidgetExportedObject
extends Object
implements ServerObject

Represents a server-side object that may not yet have been fetched by the client. When this object will no longer be used, if fetch() is not called on this object, then close() must be to ensure server-side resources are correctly freed.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.web.client.api.ServerObject

ServerObject.Union

Constructor Summary

Constructors

Constructor	Description
JsWidgetExportedObject(WorkerConnection connection, TypedTicket ticket)

Method Summary

Modifier and Type	Method	Description
void	close()	Releases the server-side resources associated with this object, regardless of whether other client-side objects exist that also use that object.
elemental2.promise.Promise<?>	fetch()	Returns a promise that will fetch the object represented by this reference.
WorkerConnection	getConnection()
@JsNullable String	getType()	Returns the type of this export, typically one of JsVariableType, but may also include plugin types.
elemental2.promise.Promise<JsWidgetExportedObject>	reexport()	Exports another copy of this reference, allowing it to be fetched separately.
TypedTicket	typedTicket()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JsWidgetExportedObject

public JsWidgetExportedObject(WorkerConnection connection,
 TypedTicket ticket)

Method Details

getConnection

public WorkerConnection getConnection()

Specified by:

getConnection in interface ServerObject

getType

@JsProperty
public @JsNullable String getType()

Returns the type of this export, typically one of JsVariableType, but may also include plugin types. If null, this object cannot be fetched, but can be passed to the server, such as via JsWidget.sendMessage(JsWidget.MessageUnion, JsArray).

Returns:

the string type of this server-side object, or null.

typedTicket

public TypedTicket typedTicket()

Specified by:

typedTicket in interface ServerObject

reexport

@JsMethod
public elemental2.promise.Promise<JsWidgetExportedObject> reexport()

Exports another copy of this reference, allowing it to be fetched separately. Results in rejection if the ticket was already closed (either by calling close() or closing the object returned from fetch()).

Returns:

a promise returning a reexported copy of this object, still referencing the same server-side object.

fetch

@JsMethod
public elemental2.promise.Promise<?> fetch()

Returns a promise that will fetch the object represented by this reference. Multiple calls to this will return the same instance.

Returns:

a promise that will resolve to a client side object that represents the reference on the server.

close

@JsMethod
public void close()

Releases the server-side resources associated with this object, regardless of whether other client-side objects exist that also use that object. Should not be called after fetch() has been invoked.