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.primitive;
033    
034    import org.opengis.display.container.GraphicsContainer;
035    
036    
037    /**
038     * Defines the root abstraction of a graphic object taxonomy. This base interface
039     * specifies the methods common to a lightweight set of graphic objects.
040     *
041     * @author Open Geospatial Consortium
042     * @author Johann Sorel (Geomatys)
043     * @since  GeoAPI 2.2
044     */
045    public interface Graphic {
046        /**
047         * Returns {@code true} if this graphic is visible.
048         *
049         * @return {@code true} if this graphic is visible.
050         */
051        boolean isVisible();
052    
053        /**
054         * Sets whatever this graphic should be visible.
055         *
056         * @param visible {@code true} if this graphic should be visible.
057         */
058        void setVisible(boolean visible);
059    
060        /**
061         * Invoked by the {@linkplain GraphicsContainer container} when this graphic is no longer needed.
062         * Implementations may use this method to release resources, if needed. Implementations
063         * may also implement this method to return an object to an object pool. It is an error
064         * to reference a {@code Graphic} in any way after its dispose method has been called.
065         */
066        void dispose();
067    }