Package provided.owlMaps.general

Interface IIconOptions

All Superinterfaces:
IOptionsKeys, java.io.Serializable
public interface IIconOptions
extends IOptionsKeys
Options for creating icons
Author:
swong

  • Field Summary

    Fields
    Modifier and Type Field Description
    static provided.mixedData.MixedDataKey<java.awt.geom.Point2D> ANCHOR
    The position at which to anchor an image in correspondence to the location of the marker on the map.
    static provided.mixedData.MixedDataKey<java.awt.geom.Point2D> LABEL_ORIGIN
    The origin of the label relative to the top-left corner of the icon image, if a label is supplied by the marker.
    static java.util.UUID OPTIONS_ID
    Unique identifier for this class of options.
    static provided.mixedData.MixedDataKey<java.awt.geom.Point2D> ORIGIN
    The position of the image within a sprite, if any.
    static provided.mixedData.MixedDataKey<java.awt.geom.Dimension2D> SCALED_SIZE
    The size of the entire image after scaling, if any.
    static provided.mixedData.MixedDataKey<java.awt.geom.Dimension2D> SIZE
    The display size of the sprite or image.
    static provided.mixedData.MixedDataKey<java.lang.String> URL
    The URL of the image or sprite sheet.

  • 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<java.awt.geom.Point2D> ANCHOR
      The position at which to anchor an image in correspondence to the location of the marker on the map. By default, the anchor is located along the center point of the bottom of the image.

    • LABEL_ORIGIN

      static final provided.mixedData.MixedDataKey<java.awt.geom.Point2D> LABEL_ORIGIN
      The origin of the label relative to the top-left corner of the icon image, if a label is supplied by the marker. By default, the origin is located in the center point of the image.

    • ORIGIN

      static final provided.mixedData.MixedDataKey<java.awt.geom.Point2D> ORIGIN
      The position of the image within a sprite, if any. By default, the origin is located at the top left corner of the image (0, 0).

    • SCALED_SIZE

      static final provided.mixedData.MixedDataKey<java.awt.geom.Dimension2D> SCALED_SIZE
      The size of the entire image after scaling, if any. Use this property to stretch/shrink an image or a sprite.

    • SIZE

      static final provided.mixedData.MixedDataKey<java.awt.geom.Dimension2D> SIZE
      The display size of the sprite or image. When using sprites, you must specify the sprite size. If the size is not provided, it will be set when the image loads.

    • URL

      static final provided.mixedData.MixedDataKey<java.lang.String> URL
      The URL of the image or sprite sheet.

  • 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.