com.guiseframework.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:

• CompassPoint.NORTHEAST_BY_NORTH
• CompassPoint.NORTHEAST_BY_EAST
• CompassPoint.SOUTHEAST_BY_EAST
• CompassPoint.SOUTHEAST_BY_SOUTH
• CompassPoint.SOUTHWEST_BY_SOUTH
• CompassPoint.SOUTHWEST_BY_WEST
• CompassPoint.NORTHWEST_BY_WEST
• CompassPoint.NORTHWEST_BY_NORTH

Author:

Garret Wilson

Nested Class Summary

Nested classes/interfaces inherited from interface com.guiseframework.component.Frame

Frame.Mode, Frame.State

Field Summary

static java.lang.String	TETHER_BEARING_COMPASS_POINTS_PROPERTY The tether bearing compass points bound property.
static java.lang.String	TETHER_BEARING_PROPERTY The tether bearing bound property.
static java.lang.String	TETHER_IMAGE_PROPERTY The tether image bound property.

Fields inherited from interface com.guiseframework.component.Frame

CLOSE_ACTION_CONTROL_PROPERTY, MENU_PROPERTY, MODAL_PROPERTY, MOVABLE_PROPERTY, OPEN_EFFECT_PROPERTY, RELATED_COMPONENT_PROPERTY, RESIZABLE_PROPERTY, STATE_PROPERTY, TITLE_BACKGROUND_COLOR_PROPERTY, TITLE_VISIBLE_PROPERTY, TOOLBAR_PROPERTY

Fields inherited from interface com.guiseframework.component.ContentComponent

CONTENT_PROPERTY

Fields inherited from interface com.guiseframework.component.ModalComponent

MODE_PROPERTY

Fields inherited from interface com.guiseframework.component.InputFocusGroupComponent

INPUT_FOCUS_STRATEGY_PROPERTY, INPUT_FOCUSED_COMPONENT_PROPERTY

Method Summary

java.math.BigDecimal	getTetherBearing()
java.util.Set<CompassPoint>	getTetherBearingCompassPoints()
java.net.URI	getTetherImage()
void	setTetherBearing(java.math.BigDecimal newTetherBearing) Sets the bearing of the tether in relation to the frame.
void	setTetherBearingCompassPoints(java.util.Set<CompassPoint> newTetherBearingCompassPoints) Sets the compass points supported for tether bearing.
void	setTetherImage(java.net.URI newTetherImage) Sets the URI of the tether image.

Methods inherited from interface com.guiseframework.component.Frame

canClose, close, getCloseActionControl, getCloseActionPrototype, getMenu, getOpenEffect, getRelatedComponent, getState, getTitleBackgroundColor, getToolbar, isModal, isMovable, isResizable, isTitleVisible, open, open, open, setCloseActionControl, setMenu, setModal, setMovable, setOpenEffect, setRelatedComponent, setResizable, setTitleBackgroundColor, setTitleVisible, setToolbar

Methods inherited from interface com.guiseframework.component.ContentComponent

getContent, setContent

Methods inherited from interface com.guiseframework.component.CompositeComponent

addCompositeComponentListener, getChildComponents, hasChildComponents, removeCompositeComponentListener

Methods inherited from interface com.guiseframework.component.ModalComponent

getMode, setMode

Methods inherited from interface com.guiseframework.component.InputFocusGroupComponent

getInputFocusedComponent, getInputFocusStrategy, setInputFocusedComponent, setInputFocusStrategy

Field Detail

TETHER_BEARING_PROPERTY

static final java.lang.String TETHER_BEARING_PROPERTY

The tether bearing bound property.

TETHER_BEARING_COMPASS_POINTS_PROPERTY

static final java.lang.String TETHER_BEARING_COMPASS_POINTS_PROPERTY

The tether bearing compass points bound property.

TETHER_IMAGE_PROPERTY

static final java.lang.String TETHER_IMAGE_PROPERTY

The tether image bound property.

Method Detail

getTetherBearing

java.math.BigDecimal getTetherBearing()

Returns:

The bearing of the tether in relation to the frame.

setTetherBearing

void setTetherBearing(java.math.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:

java.lang.NullPointerException - if the given bearing is null.

java.lang.IllegalArgumentException - if the given bearing is greater than 360.

See Also:

TETHER_BEARING_PROPERTY

getTetherBearingCompassPoints

java.util.Set<CompassPoint> getTetherBearingCompassPoints()

Returns:

The bearing of the tether in relation to the frame.

setTetherBearingCompassPoints

void setTetherBearingCompassPoints(java.util.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:

java.lang.NullPointerException - if the given set is null.

See Also:

TETHER_BEARING_COMPASS_POINTS_PROPERTY

getTetherImage

java.net.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(java.net.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:

TETHER_IMAGE_PROPERTY