Class Callout.ShowOptions

  • Enclosing class:
    Callout

    public static final class Callout.ShowOptions
    extends Object
    Encapsulates a set of parameters that control how a callout is shown and dismissed. The parameters are:
    • animateCallout - if this is true, the callout appears to grow out of its anchor point when it's shown and shrink back into its anchor point when it's dismissed
    • recenterMap - if this is true, the MapView is recentered on the callout location when the callout is shown
    • animateRecenter - if this and recenterMap are both true, animation of the MapView is used when recentering the MapView when the callout is shown
    The default value of each of these parameters is false.
    Since:
    100.0.0
    • Constructor Detail

      • ShowOptions

        public ShowOptions()
        Constructor that allows all the parameters to take their default values.
        Since:
        100.0.0
      • ShowOptions

        public ShowOptions​(boolean animateCallout,
                           boolean recenterMap,
                           boolean animateRecenter)
        Constructor that specifies values for each of the parameters.
        Parameters:
        animateCallout - true to make the callout appear to grow out of its anchor point when it's shown and shrink back into its anchor point when it's dismissed
        recenterMap - true to recenter the MapView on the callout location when the callout is shown
        animateRecenter - true to specify animation of the recentering of the MapView when the callout is shown
        Since:
        100.0.0
    • Method Detail

      • isAnimateCallout

        public boolean isAnimateCallout()
        Gets the value of the animateCallout parameter.
        Returns:
        true if animation of the callout is set
        Since:
        100.0.0
      • isAnimateRecenter

        public boolean isAnimateRecenter()
        Gets the value of the animateRecenter parameter.
        Returns:
        true if animation of the recentering of the MapView is set
        Since:
        100.0.0
      • isRecenterMap

        public boolean isRecenterMap()
        Gets the value of the recenterMap parameter.
        Returns:
        true if recentering of the MapView is set
        Since:
        100.0.0
      • setAnimateCallout

        public void setAnimateCallout​(boolean animateCallout)
        Sets the value of the animateCallout parameter.
        Parameters:
        animateCallout - true to make the callout appear to grow out of its anchor point when it's shown and shrink back into its anchor point when it's dismissed; the default value is false
        Since:
        100.0.0
      • setAnimateRecenter

        public void setAnimateRecenter​(boolean animateRecenter)
        Sets the value of the animateRecenter parameter.
        Parameters:
        animateRecenter - true to specify animation of the recentering of the MapView when the callout is shown; the default value is false
        Since:
        100.0.0
      • setRecenterMap

        public void setRecenterMap​(boolean recenterMap)
        Sets the value of the recenterMap parameter.
        Parameters:
        recenterMap - true to recenter the MapView on the callout location when the callout is shown; the default value is false
        Since:
        100.0.0