Package provided.owlMaps.cefUtils

Interface ICefObjectWrapper

All Superinterfaces:
ICefObjRef
All Known Subinterfaces:
IAnchorWrapped, ICircleWrapped, IEditableObject, IGroundOverlayWrapped, IInfoWindowWrapped, IMapDataFeatureWrapped, IMarkerLabelWrapped, IMarkerWrapped, IOwlMapWrapped, IPolygon, IPolygonWrapped, IPolyline, IPolylineWrapped, IRectangle, IRectangleWrapped, IVisibleMapObjectWrapped
public interface ICefObjectWrapper
extends ICefObjRef
*** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS INTERFACE DIRECTLY! ***
Interface that represents a wrapper around a ICefObject providing convenience methods to operate directly on that wrapped object. The use of a wrapper helps shield and decouple the underlying implementation from the developer code.
Author:
swong

  • Method Summary

    Modifier and Type Method Description
    default void addEvent​(java.lang.String eventName, java.lang.Runnable runnableCallback)
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
    Add an event to the wrapped object that utilizes a Runnable callback
    default <T> void addEvent​(java.lang.String eventName, java.util.function.Consumer<T> consumerCallback, java.lang.reflect.Type paramType)
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
    Add an event to the wrapped object that utilizes a Consumer callback
    default <T> T call​(java.lang.String methodName, java.lang.Class<? extends T> resultType, java.lang.Object... args)
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
    Call a method on the wrapped ICefObject that returns a values.
    default void callVoid​(java.lang.String methodName, java.lang.Object... args)
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
    Call a method on the wrapped ICefObject that has a void return.
    default java.util.UUID getCefId()
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
    Get the unique identifier that identifies this object on both the Java and JavaScript sides of the system.
    default <T> T getCefProperty​(java.lang.String name, java.lang.reflect.Type resultType)
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
    Get the value of a property of the wrapped JsObject.
    ICefObject getWrappedCefObject()
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
    Return a reference to the wrapped ICefObject
    default boolean setCefProperty​(java.lang.String name, java.lang.Object value)
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
    Set the value of a property to the given value.

  • Method Details

    • getWrappedCefObject

      ICefObject getWrappedCefObject()
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
      Return a reference to the wrapped ICefObject
      Returns:
      The wrapped CEF object

    • getCefId

      default java.util.UUID getCefId()
      Description copied from interface: ICefObjRef
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
      Get the unique identifier that identifies this object on both the Java and JavaScript sides of the system.
      Specified by:
      getCefId in interface ICefObjRef
      Returns:
      The ID value for this object

    • call

      default <T> T call​(java.lang.String methodName, java.lang.Class<? extends T> resultType, java.lang.Object... args)
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
      Call a method on the wrapped ICefObject that returns a values. Will return null if the method name does not exist or an error occurs during execution.
      Type Parameters:
      T - The expected return type of the returned value.
      Parameters:
      methodName - The name of the method to call.
      resultType - The type of the expected result
      args - Any arguments to give to the method call
      Returns:
      The return value of the method call.

    • callVoid

      default void callVoid​(java.lang.String methodName, java.lang.Object... args)
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
      Call a method on the wrapped ICefObject that has a void return. Will print an exception if the method name does not exist or an error occurs during execution.
      Parameters:
      methodName - The name of the method to call.
      args - Any arguments to give to the method call

    • getCefProperty

      default <T> T getCefProperty​(java.lang.String name, java.lang.reflect.Type resultType)
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
      Get the value of a property of the wrapped JsObject. Will return null if the property does not exist.
      Type Parameters:
      T - The expected type of the requested property value
      Parameters:
      name - The name of the property
      resultType - The type of the requested property
      Returns:
      The value of the property.

    • setCefProperty

      default boolean setCefProperty​(java.lang.String name, java.lang.Object value)
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
      Set the value of a property to the given value. The property is created if it doesn't already exist.
      Parameters:
      name - The name of the property
      value - The value for the property
      Returns:
      True if successful, False otherwise.

    • addEvent

      default void addEvent​(java.lang.String eventName, java.lang.Runnable runnableCallback)
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
      Add an event to the wrapped object that utilizes a Runnable callback
      Parameters:
      eventName - The name of the event type
      runnableCallback - The callback to associate with that event type

    • addEvent

      default <T> void addEvent​(java.lang.String eventName, java.util.function.Consumer<T> consumerCallback, java.lang.reflect.Type paramType)
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD DIRECTLY! ***
      Add an event to the wrapped object that utilizes a Consumer callback
      Type Parameters:
      T - The type of the input to the callback Consumer.
      Parameters:
      eventName - The name of the event type
      consumerCallback - The callback to associate with event type
      paramType - The type of the input parameter to the callback.