io.guise.framework.component.AbstractFlyoverFrame Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
There is a newer version: 0.5.3
/*
 * Copyright © 2005-2008 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.guise.framework.component;

import java.math.BigDecimal;
import java.net.URI;
import java.util.EnumSet;
import java.util.Set;

import static io.guise.framework.Resources.*;
import static java.util.Collections.*;
import static java.util.Objects.*;

import com.globalmentor.java.Objects;

import io.guise.framework.geometry.CompassPoint;

/**
 * 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:
 * 
 * 
 * {@link CompassPoint#NORTHEAST_BY_NORTH}
 * {@link CompassPoint#NORTHEAST_BY_EAST}
 * {@link CompassPoint#SOUTHEAST_BY_EAST}
 * {@link CompassPoint#SOUTHEAST_BY_SOUTH}
 * {@link CompassPoint#SOUTHWEST_BY_SOUTH}
 * {@link CompassPoint#SOUTHWEST_BY_WEST}
 * {@link CompassPoint#NORTHWEST_BY_WEST}
 * {@link CompassPoint#NORTHWEST_BY_NORTH}
 * 
 * @author Garret Wilson
 */
public abstract class AbstractFlyoverFrame extends AbstractFrame implements FlyoverFrame {

	/**
	 * TODO del comment if no longer accurate For example, with a tether bearing of 250 and a tether resource key of "myTether", a resource key will be requested
	 * using "myTether.WSW", "myTether.SWbW", "myTether.SW", etc. until all relevant compass points are exhausted, after which a resource key of "myTether" will
	 * be requested.
	 */

	/** The base resource URI for the flyover tether image URI. */
	public static final URI TETHER_IMAGE_RESOURCE_URI = createURIResourceReference("theme.flyover.frame.tether.image");

	/** The bearing of the tether in relation to the frame. */
	private BigDecimal tetherBearing = CompassPoint.NORTHWEST_BY_WEST.getBearing();

	@Override
	public BigDecimal getTetherBearing() {
		return tetherBearing;
	}

	@Override
	public void setTetherBearing(BigDecimal newTetherBearing) {
		//TODO del Log.trace("setting flyover tether bearing to", newTetherBearing);
		requireNonNull(newTetherBearing, "Tether bearing cannot be null.");
		final Set tetherBearingCompassPoints = getTetherBearingCompassPoints(); //get the tether bearing compass points available
		if(!tetherBearingCompassPoints.isEmpty()) { //if some tether bearings are supported TOOD fix; right now, if there are no compass points then all bearings are supported
			CompassPoint compassPoint = CompassPoint.getCompassPoint(newTetherBearing); //get the compass point nearest the bearing
			if(!tetherBearingCompassPoints.contains(compassPoint)) { //if this is not a supported compass point, look for compass points lying near this point
				final int ordinal = compassPoint.ordinal(); //get the ordinal of the compass point nearest the bearing
				final CompassPoint[] compassPoints = CompassPoint.values(); //get the compass point values
				final int compassPointCount = compassPoints.length; //find out how many compass points there are
				final int maxDelta = compassPointCount / 2; //look half-way in each direction
				for(int delta = 1; delta < maxDelta; ++delta) { //cycle through the deltas
					final int previousOrdinal = ordinal - delta; //look to the left
					compassPoint = compassPoints[previousOrdinal >= 0 ? previousOrdinal : compassPointCount + previousOrdinal]; //get the previous compass point, wrapping around if necessary
					if(tetherBearingCompassPoints.contains(compassPoint)) { //if we support the previous compass point
						break; //use this value
					}
					final int nextOrdinal = ordinal + delta; //look to the right
					compassPoint = compassPoints[nextOrdinal < compassPointCount ? nextOrdinal : compassPointCount - nextOrdinal]; //get the next compass point, wrapping around if necessary
					if(tetherBearingCompassPoints.contains(compassPoint)) { //if we support the next compass point
						break; //use this value
					}
				}
				newTetherBearing = compassPoint.getBearing(); //at this point we will have found a supported compass point; use that compass point's bearing
			}
			//TODO del Log.trace("deciding to really use compass point", compassPoint);
		}
		if(!tetherBearing.equals(newTetherBearing)) { //if the value is really changing
			final BigDecimal oldTetherBearing = tetherBearing; //get the current value
			tetherBearing = CompassPoint.checkBearing(newTetherBearing); //update the value
			firePropertyChange(TETHER_BEARING_PROPERTY, oldTetherBearing, newTetherBearing);
		}
	}

	/** The compass points supported for tether bearing. */
	private Set tetherBearingCompassPoints;

	@Override
	public Set getTetherBearingCompassPoints() {
		return tetherBearingCompassPoints;
	}

	@Override
	public void setTetherBearingCompassPoints(final Set newTetherBearingCompassPoints) {
		if(tetherBearing != tetherBearingCompassPoints) { //if the value is really changing
			final Set oldTetherBearingCompassPoints = tetherBearingCompassPoints; //get the current value
			tetherBearingCompassPoints = requireNonNull(newTetherBearingCompassPoints, "Tether bearing compass points cannot be null."); //update the value
			firePropertyChange(TETHER_BEARING_PROPERTY, oldTetherBearingCompassPoints, newTetherBearingCompassPoints);
		}
	}

	/** The tether image URI, which may be a resource URI, or null if there is no tether image URI. */
	private URI tetherImage = TETHER_IMAGE_RESOURCE_URI;

	@Override
	public URI getTetherImage() {
		return tetherImage;
	}

	@Override
	public void setTetherImage(final URI newTetherImage) {
		if(!Objects.equals(tetherImage, newTetherImage)) { //if the value is really changing
			final URI oldTetherImage = tetherImage; //get the old value
			tetherImage = newTetherImage; //actually change the value
			firePropertyChange(TETHER_IMAGE_PROPERTY, oldTetherImage, newTetherImage); //indicate that the value changed
		}
	}

	/**
	 * Component constructor.
	 * @param component The single child component, or null if this frame should have no child component.
	 */
	public AbstractFlyoverFrame(final Component component) {
		super(component); //construct the parent class
		setModal(false); //default to being a nonmodal frame
		setMovable(false); //default to being nonmovable
		setResizable(false); //default to not allowing resizing
		setTitleVisible(false); //don't show a title
		tetherBearingCompassPoints = unmodifiableSet(EnumSet.of(
				//establish the default accepted tether bearings
				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));
	}

}