com.guiseframework.component
Class AbstractFlyoverFrame

java.lang.Object
  com.globalmentor.beans.BoundPropertyObject
      com.guiseframework.event.GuiseBoundPropertyObject
          com.guiseframework.model.ui.AbstractPresentationModel
              com.guiseframework.component.AbstractComponent
                  com.guiseframework.component.AbstractCompositeComponent
                      com.guiseframework.component.AbstractMultipleCompositeComponent
                          com.guiseframework.component.AbstractArrayCompositeComponent
                              com.guiseframework.component.AbstractEnumCompositeComponent<AbstractFrame.FrameComponent>
                                  com.guiseframework.component.AbstractFrame
                                      com.guiseframework.component.AbstractFlyoverFrame

All Implemented Interfaces:

com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, Component, CompositeComponent, ContentComponent, FlyoverFrame, Frame, InputFocusableComponent, InputFocusGroupComponent, ModalComponent<Frame.Mode>, Displayable, InfoModel, LabelModel, Model, PresentationModel, DepictedObject

Direct Known Subclasses:

DefaultFlyoverFrame

public abstract class AbstractFlyoverFrame
extends AbstractFrame
implements FlyoverFrame

Abstract implementation of 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 class com.guiseframework.component.AbstractFrame

AbstractFrame.DefaultPrototypeProvider, AbstractFrame.FrameComponent

Nested classes/interfaces inherited from class com.guiseframework.component.AbstractComponent

AbstractComponent.AbstractFlyoverFrameStrategy<S extends Component>, AbstractComponent.AbstractFlyoverStrategy<S extends Component>, AbstractComponent.DefaultFlyoverStrategy<S extends Component>

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

Frame.Mode, Frame.State

Field Summary

static java.net.URI

TETHER_IMAGE_RESOURCE_URI The base resource URI for the flyover tether image URI.

Fields inherited from class com.globalmentor.beans.BoundPropertyObject

NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS

Fields inherited from interface com.guiseframework.component.FlyoverFrame

TETHER_BEARING_COMPASS_POINTS_PROPERTY, TETHER_BEARING_PROPERTY, TETHER_IMAGE_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

Constructor Summary

AbstractFlyoverFrame(Component component)
Component constructor.

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 class com.guiseframework.component.AbstractFrame

canClose, close, closeImpl, getCloseActionControl, getCloseActionPrototype, getContent, getInputFocusedComponent, getInputFocusStrategy, getMenu, getMode, getOpenEffect, getPrototypeProvisionStrategy, getRelatedComponent, getState, getTitleBackgroundColor, getToolbar, isModal, isMovable, isResizable, isTitleVisible, open, open, open, provideDefaultPrototypes, setCloseActionControl, setContent, setInputFocusedComponent, setInputFocusStrategy, setMenu, setModal, setMode, setMovable, setOpenEffect, setRelatedComponent, setResizable, setState, setTitleBackgroundColor, setTitleVisible, setToolbar, updateDefaultPrototypeProvisions, validate

Methods inherited from class com.guiseframework.component.AbstractEnumCompositeComponent

getComponent, setComponent

Methods inherited from class com.guiseframework.component.AbstractArrayCompositeComponent

getChildComponents, getChildList, getComponent, hasChildComponents, setComponent

Methods inherited from class com.guiseframework.component.AbstractMultipleCompositeComponent

addComponent, removeComponent

Methods inherited from class com.guiseframework.component.AbstractCompositeComponent

addCompositeComponentListener, childComponentValidPropertyChanged, determineChildrenValid, determineValid, dispatchInputEvent, dispatchInputEvent, fireChildComponentAdded, fireChildComponentAdded, fireChildComponentRemoved, fireChildComponentRemoved, initializeChildComponent, loadPreferences, removeCompositeComponentListener, resetTheme, savePreferences, uninitializeChildComponent, updateTheme, validateChildren

Methods inherited from class com.guiseframework.component.AbstractComponent

addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, applyTheme, applyTheme, depict, equals, exportTransfer, fireInputEvent, fireNotified, fireNotified, getAncestor, getCommandListeners, getComponentByID, getComponentByName, getComponentOrientation, getConstraints, getDepictID, getDepictor, getDescription, getDescriptionContentType, getDirtyComponents, getDirtyComponents, getEventListenerManager, getFlyoverStrategy, getGlyphURI, getInfo, getInfoContentType, getInfoModel, getInputStrategy, getKeyListeners, getLabel, getLabelContentType, getMouseListeners, getName, getNotification, getNotifications, getNotifications, getOrientation, getParent, getPreferenceProperties, getRootComponent, getTheme, hasAncestor, hasCommandListeners, hashCode, hasKeyListeners, hasMouseListeners, importTransfer, initialize, isDragEnabled, isDropEnabled, isFlyoverEnabled, isPreferenceProperty, isThemeApplied, isValid, notify, processEvent, removeCommandListener, removeExportStrategy, removeImportStrategy, removeKeyListener, removeMouseListener, removeNotificationListener, removePreferenceProperty, setConstraints, setDepicted, setDescription, setDescriptionContentType, setDragEnabled, setDropEnabled, setFlyoverEnabled, setFlyoverStrategy, setGlyphURI, setInfo, setInfoContentType, setInputStrategy, setLabel, setLabelContentType, setName, setNotification, setOrientation, setParent, setThemeApplied, setValid, toString, update, updateValid

Methods inherited from class com.guiseframework.model.ui.AbstractPresentationModel

BorderLineFarColor, BorderLineFarExtent, BorderLineFarStyle, BorderLineNearColor, BorderLineNearExtent, BorderLineNearStyle, BorderPageFarColor, BorderPageFarExtent, BorderPageFarStyle, BorderPageNearColor, BorderPageNearExtent, BorderPageNearStyle, getBackgroundColor, getBorderColor, getBorderExtent, getBorderStyle, getCornerArcSize, getCornerLineFarPageFarArcSize, getCornerLineFarPageNearArcSize, getCornerLineNearPageFarArcSize, getCornerLineNearPageNearArcSize, getCursor, getExtent, getFontFamilies, getFontSize, getFontStyle, getFontWeight, getLabelFontFamilies, getLabelFontSize, getLabelFontStyle, getLabelFontWeight, getLabelTextColor, getLineExtent, getMarginExtent, getMarginLineFarExtent, getMarginLineNearExtent, getMarginPageFarExtent, getMarginPageNearExtent, getOpacity, getPaddingExtent, getPaddingLineFarExtent, getPaddingLineNearExtent, getPaddingPageFarExtent, getPaddingPageNearExtent, getPageExtent, getStyleID, getTextColor, isDisplayed, isTooltipEnabled, isVisible, setBackgroundColor, setBorderColor, setBorderColor, setBorderExtent, setBorderExtent, setBorderLineFarColor, setBorderLineFarExtent, setBorderLineFarStyle, setBorderLineNearColor, setBorderLineNearExtent, setBorderLineNearStyle, setBorderPageFarColor, setBorderPageFarExtent, setBorderPageFarStyle, setBorderPageNearColor, setBorderPageNearExtent, setBorderPageNearStyle, setBorderStyle, setBorderStyle, setCornerArcSize, setCornerArcSize, setCornerLineFarPageFarArcSize, setCornerLineFarPageNearArcSize, setCornerLineNearPageFarArcSize, setCornerLineNearPageNearArcSize, setCursor, setDisplayed, setExtent, setFontFamilies, setFontSize, setFontStyle, setFontWeight, setLabelFontFamilies, setLabelFontSize, setLabelFontStyle, setLabelFontWeight, setLabelTextColor, setLineExtent, setMarginExtent, setMarginExtent, setMarginLineFarExtent, setMarginLineNearExtent, setMarginPageFarExtent, setMarginPageNearExtent, setOpacity, setPaddingExtent, setPaddingExtent, setPaddingLineFarExtent, setPaddingLineNearExtent, setPaddingPageFarExtent, setPaddingPageNearExtent, setPageExtent, setStyleID, setTextColor, setTooltipEnabled, setVisible

Methods inherited from class com.guiseframework.event.GuiseBoundPropertyObject

getSession

Methods inherited from class com.globalmentor.beans.BoundPropertyObject

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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_IMAGE_RESOURCE_URI

public static final java.net.URI TETHER_IMAGE_RESOURCE_URI

The base resource URI for the flyover tether image URI.

Constructor Detail

AbstractFlyoverFrame

public AbstractFlyoverFrame(Component component)

Component constructor.

Parameters:

component - The single child component, or null if this frame should have no child component.

Method Detail

getTetherBearing

public java.math.BigDecimal getTetherBearing()

Specified by:

getTetherBearing in interface FlyoverFrame

Returns:

The bearing of the tether in relation to the frame.

setTetherBearing

public void setTetherBearing(java.math.BigDecimal newTetherBearing)

Sets the bearing of the tether in relation to the frame. This implementation changes the bearing to that of the nearest supported tether bearing compass point. This is a bound property.

Specified by:

setTetherBearing in interface FlyoverFrame

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:

FlyoverFrame.TETHER_BEARING_PROPERTY

getTetherBearingCompassPoints

public java.util.Set<CompassPoint> getTetherBearingCompassPoints()

Specified by:

getTetherBearingCompassPoints in interface FlyoverFrame

Returns:

The bearing of the tether in relation to the frame.

setTetherBearingCompassPoints

public void setTetherBearingCompassPoints(java.util.Set<CompassPoint> newTetherBearingCompassPoints)

Sets the compass points supported for tether bearing. This is a bound property.

Specified by:

setTetherBearingCompassPoints in interface FlyoverFrame

Parameters:

newTetherBearingCompassPoints - The new set of compass points supported for tether bearing.

Throws:

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

See Also:

FlyoverFrame.TETHER_BEARING_COMPASS_POINTS_PROPERTY

getTetherImage

public java.net.URI getTetherImage()

Specified by:

getTetherImage in interface FlyoverFrame

Returns:

The tether image URI, which may be a resource URI, or null if there is no tether image URI.

setTetherImage

public void setTetherImage(java.net.URI newTetherImage)

Sets the URI of the tether image. This is a bound property of type URI.

Specified by:

setTetherImage in interface FlyoverFrame

Parameters:

newTetherImage - The new URI of the image, which may be a resource URI.

See Also:

FlyoverFrame.TETHER_IMAGE_PROPERTY