001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.display.canvas;
033
034 import java.awt.RenderingHints;
035 import org.opengis.geometry.DirectPosition;
036
037
038 /**
039 * Defines a common abstraction for implementations that manage the display. Canvas can be extended
040 * for cartesian display or any kind. A {@code Canvas} with an XY (Cartesian) display field should
041 * support the following properties:
042 * <p>
043 * <ul>
044 * <li>pixelWidth</li>
045 * <li>pixelHeight</li>
046 * <li>center</li>
047 * <li>width</li>
048 * <li>scale</li>
049 * <li>envelope</li>
050 * </ul>
051 *
052 * @author Open Geospatial Consortium
053 * @author Johann Sorel (Geomatys)
054 * @since GeoAPI 2.2
055 */
056 public interface Canvas {
057 /**
058 * Returns a copy of the current state of this {@code Canvas}. The object returned will
059 * implement {@link CanvasState} or one of its subinterfaces, depending on the type
060 * of canvas.
061 *
062 * @return A snapshot of current canvas state.
063 */
064 CanvasState getState();
065
066 /**
067 * Returns {@code true} if the given coordinate is visible on this {@code Canvas}.
068 *
069 * @param coordinate The coordinate to test for visibility.
070 * @return {@code true} if the given coordinate is visible on this canvas.
071 */
072 boolean isVisible(DirectPosition coordinate);
073
074 /**
075 * Returns the controller that allows the programmer to modify the
076 * {@code Canvas}'s properties.
077 *
078 * @return The controller for this canvas.
079 */
080 CanvasController getController();
081
082 /**
083 * Sets a rendering hint for implementation or platform specific rendering
084 * information.
085 *
086 * @param hintKey The key of the hint.
087 * @param hint The rendering hint.
088 */
089 void setRenderingHint(RenderingHints.Key hintKey, Object hint);
090
091 /**
092 * Returns the rendering hint associated with the hint name.
093 *
094 * @param hintKey The key of the hint.
095 * @return The rendering hint.
096 */
097 Object getRenderingHint(RenderingHints.Key hintKey);
098
099 /**
100 * Adds the given listener that will be notified when the state of this
101 * {@code Canvas} has changed.
102 *
103 * @param listener The listener to add.
104 */
105 void addCanvasListener(CanvasListener listener);
106
107 /**
108 * Removes the given listener.
109 *
110 * @param listener The listener to remove.
111 */
112 void removeCanvasListener(CanvasListener listener);
113 }