Package io.guise.framework.component

Interface FlyoverFrame

All Superinterfaces:
Component, CompositeComponent, ContentComponent, DepictedObject, Displayable, Frame, InfoModel, InputFocusableComponent, InputFocusGroupComponent, LabelModel, ModalComponent<Frame.Mode>, Model, PresentationModel, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable
All Known Implementing Classes:
AbstractFlyoverFrame, DefaultFlyoverFrame
public interface FlyoverFrame extends Frame
A frame for flyovers. A flyover frame by default is nonmodal, immovable, and not resizable. When loading the tether image from the resources, a resource key will be generated based upon the compass point of the tether bearing. For example, with a tether bearing of 250 and a tether resource key of "myTether", a resource key will be requested using "myTether.WSW", after which a resource key of "myTether" will be requested if that resource is not available.

This implementation defaults to accepting tether bearings of:

Author:
Garret Wilson

  • Field Details

    • TETHER_BEARING_PROPERTY

      static final String TETHER_BEARING_PROPERTY
      The tether bearing bound property.

    • TETHER_BEARING_COMPASS_POINTS_PROPERTY

      static final String TETHER_BEARING_COMPASS_POINTS_PROPERTY
      The tether bearing compass points bound property.

    • TETHER_IMAGE_PROPERTY

      static final String TETHER_IMAGE_PROPERTY
      The tether image bound property.

  • Method Details

    • getTetherBearing

      BigDecimal getTetherBearing()
      Returns:
      The bearing of the tether in relation to the frame.

    • setTetherBearing

      void setTetherBearing(BigDecimal newTetherBearing)
      Sets the bearing of the tether in relation to the frame. This is a bound property.
      Parameters:
      newTetherBearing - The new bearing of the tether in relation to the frame.
      Throws:
      NullPointerException - if the given bearing is null.
      IllegalArgumentException - if the given bearing is greater than 360.
      See Also:

    • getTetherBearingCompassPoints

      Set<CompassPoint> getTetherBearingCompassPoints()
      Returns:
      The bearing of the tether in relation to the frame.

    • setTetherBearingCompassPoints

      void setTetherBearingCompassPoints(Set<CompassPoint> newTetherBearingCompassPoints)
      Sets the compass points supported for tether bearing. This is a bound property.
      Parameters:
      newTetherBearingCompassPoints - The new set of compass points supported for tether bearing.
      Throws:
      NullPointerException - if the given set is null.
      See Also:

    • getTetherImage

      URI getTetherImage()
      Returns:
      The tether image URI, which may be a resource URI, or null if there is no tether image URI.

    • setTetherImage

      void setTetherImage(URI newTetherImage)
      Sets the URI of the tether image. This is a bound property of type URI.
      Parameters:
      newTetherImage - The new URI of the image, which may be a resource URI.
      See Also: