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.style;
033
034 import org.opengis.annotation.Extension;
035 import org.opengis.filter.expression.Expression;
036 import org.opengis.annotation.XmlElement;
037
038
039 /**
040 * Indicates how text will be drawn.
041 *
042 * @version <A HREF="http://www.opengeospatial.org/standards/symbol">Symbology Encoding Implementation Specification 1.1.0</A>
043 * @author Open Geospatial Consortium
044 * @author Johann Sorel (Geomatys)
045 * @author Chris Dillard (SYS Technologies)
046 * @since GeoAPI 2.2
047 */
048 @XmlElement("TextSymbolizer")
049 public interface TextSymbolizer extends Symbolizer {
050
051 /**
052 * Returns the expression that will be evaluated to determine what text is
053 * displayed.
054 * If a Label element is not provided in a TextSymbolizer, then no text shall be rendered.
055 *
056 * @return Expression
057 */
058 @XmlElement("Label")
059 Expression getLabel();
060
061 /**
062 * Returns the Font to apply on the text.
063 * @return Font
064 */
065 @XmlElement("Font")
066 Font getFont();
067
068 /**
069 * Returns the object that indicates how the text should be placed with
070 * respect to the feature geometry. This object will either be an instance
071 * of {@link LinePlacement} or {@link PointPlacement}.
072 * @return {@link LinePlacement} or {@link PointPlacement}.
073 */
074 @XmlElement("LabelPlacement")
075 LabelPlacement getLabelPlacement();
076
077 /**
078 * Returns the object that indicates if a Halo will be drawn around the
079 * text. If null, a halo will not be drawn.
080 * @return Halo
081 */
082 @XmlElement("Halo")
083 Halo getHalo();
084
085 /**
086 * Returns the object that indicates how the text will be filled.
087 * @return Fill
088 */
089 @XmlElement("Fill")
090 Fill getFill();
091
092 /**
093 * calls the visit method of a StyleVisitor
094 *
095 * @param visitor the style visitor
096 */
097 @Extension
098 Object accept(StyleVisitor visitor, Object extraData);
099
100 }