Package provided.owlMaps.components.infowindow

Interface IInfoWindowOptions

All Superinterfaces:
IOptionsKeys, java.io.Serializable
public interface IInfoWindowOptions
extends IOptionsKeys
Options for creating info windows.
Author:
swong

  • Field Summary

    Fields
    Modifier and Type Field Description
    static provided.mixedData.MixedDataKey<IAnchor> ANCHOR
    The entity used that anchors this info window.
    static provided.mixedData.MixedDataKey<java.lang.String> CONTENT
    Content to display in the InfoWindow.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> DISABLE_AUTOPAN
    Disable auto-pan on open.
    static provided.mixedData.MixedDataKey<java.lang.Integer> MAX_WIDTH
    Maximum width of the infowindow, regardless of content's width.
    static java.util.UUID OPTIONS_ID
    Unique identifier for this class of options.
    static provided.mixedData.MixedDataKey<java.awt.geom.Dimension2D> PIXEL_OFFSET
    The offset, in pixels, of the tip of the info window from the point on the map at whose geographical coordinates the info window is anchored.
    static provided.mixedData.MixedDataKey<ILatLng> POSITION
    The LatLng at which to display this InfoWindow.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> VISIBLE
    If true, the component will be visible upon creation.
    static provided.mixedData.MixedDataKey<java.lang.Double> ZINDEX
    All InfoWindows are displayed on the map in order of their zIndex, with higher values displaying in front of InfoWindows with lower values.

  • Method Summary

    Static Methods
    Modifier and Type Method Description
    static provided.mixedData.IMixedDataDictionary makeDefault()
    Make a dictionary of the default options for the component.
    static IOptionsFiller makeOptionsFiller​(ICefUtils cefUtils)
    *FOR INTERNAL USE ONLY!!* OWLMAPS DEVELOPER CODE SHOULD *NOT* USE THIS METHOD! Factory to create the IOptionsFiller that converts the component options into their corresponding Javascript Google Map component options.

  • Field Details

    • OPTIONS_ID

      static final java.util.UUID OPTIONS_ID
      Unique identifier for this class of options. Always refer to this field by name and not by its value to ensure compatibility when the codebase is updated as the value of the field may change!

    • ANCHOR

      static final provided.mixedData.MixedDataKey<IAnchor> ANCHOR
      The entity used that anchors this info window. Not part of the Google Maps Javascript API!

    • CONTENT

      static final provided.mixedData.MixedDataKey<java.lang.String> CONTENT
      Content to display in the InfoWindow. This can be an HTML element, a plain-text string, or a string containing HTML. The InfoWindow will be sized according to the content. To set an explicit size for the content, set content to be a HTML element with that size

    • DISABLE_AUTOPAN

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> DISABLE_AUTOPAN
      Disable auto-pan on open. By default, the info window will pan the map so that it is fully visible when it opens.

    • MAX_WIDTH

      static final provided.mixedData.MixedDataKey<java.lang.Integer> MAX_WIDTH
      Maximum width of the infowindow, regardless of content's width. This value is only considered if it is set before a call to open. To change the maximum width when changing content, call close, setOptions, and then open.

    • PIXEL_OFFSET

      static final provided.mixedData.MixedDataKey<java.awt.geom.Dimension2D> PIXEL_OFFSET
      The offset, in pixels, of the tip of the info window from the point on the map at whose geographical coordinates the info window is anchored. If an InfoWindow is opened with an anchor, the pixelOffset will be calculated from the anchor's anchorPoint property.

    • POSITION

      static final provided.mixedData.MixedDataKey<ILatLng> POSITION
      The LatLng at which to display this InfoWindow. If the InfoWindow is opened with an anchor, the anchor's position will be used instead.

    • ZINDEX

      static final provided.mixedData.MixedDataKey<java.lang.Double> ZINDEX
      All InfoWindows are displayed on the map in order of their zIndex, with higher values displaying in front of InfoWindows with lower values. By default, InfoWindows are displayed according to their latitude, with InfoWindows of lower latitudes appearing in front of InfoWindows at higher latitudes. InfoWindows are always displayed in front of markers.

    • VISIBLE

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> VISIBLE
      If true, the component will be visible upon creation. Defaults to false. Description of VISIBLE key is "map" b/c/ visibility tied to connection to map Not part of the Google Maps Javascript API!

  • Method Details

    • makeDefault

      static provided.mixedData.IMixedDataDictionary makeDefault()
      Make a dictionary of the default options for the component.
      Returns:
      A dictionary with any default options

    • makeOptionsFiller

      static IOptionsFiller makeOptionsFiller​(ICefUtils cefUtils)
      *FOR INTERNAL USE ONLY!!* OWLMAPS DEVELOPER CODE SHOULD *NOT* USE THIS METHOD! Factory to create the IOptionsFiller that converts the component options into their corresponding Javascript Google Map component options.
      Parameters:
      cefUtils - The IJsUtils created by the system
      Returns:
      An IOptionsFiller for this component's options.