org.geotools.styling.Font Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-main Show documentation

The main module contains the GeoTools public interfaces that are used by other GeoTools modules (and GeoTools applications). Where possible we make use industry standard terms as provided by OGC and ISO standards. The formal GeoTools public api consists of gt-metadata, jts and the gt-main module. The main module contains the default implementations that are available provided to other GeoTools modules using our factory system. Factories are obtained from an appropriate FactoryFinder, giving applications a chance configure the factory used using the Factory Hints facilities. FilterFactory ff = CommonFactoryFinder.getFilterFactory(); Expression expr = ff.add( expression1, expression2 ); If you find yourself using implementation specific classes chances are you doing it wrong: Expression expr = new AddImpl( expression1, expressiom2 );

There is a newer version: 24.2-oss84-1

Show newest version

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2002-2008, Open Source Geospatial Foundation (OSGeo)
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 */
package org.geotools.styling;

import java.util.List;
import org.opengis.filter.expression.Expression;

/**
 * A system-independent object for holding SLD font information. This holds information on the text
 * font to use in text processing. Font-family, font-style, font-weight and font-size.
 *
 * @author Ian Turton, CCG
 * @version $Id$
 */
public interface Font extends org.opengis.style.Font {
    /** default font-size value * */
    static final int DEFAULT_FONTSIZE = 10;

    /**
     * SVG font-family parameters in preferred order.
     *
     * @return live list of font-family parameters in preferred order
     */
    List getFamily();

    /**
     * The "font-style" SVG parameter should be "normal", "italic", or "oblique".
     *
     * If null is returned the default value should be considered "normal".
     *
     * @return Expression or null
     */
    Expression getStyle();

    /** @param style The "font-style" SVG parameter (one of "normal", "italic", or "oblique" */
    void setStyle(Expression style);

    /**
     * The "font-weight" SVG parameter should be "normal" or "bold".
     *
     * 
If null the default should be considered as "normal"
     *
     * @return font-weight SVG parameter
     */
    Expression getWeight();

    /** @param weight The "font-weight" SVG parameter (one of "normal", "bold") */
    void setWeight(Expression weight);

    /**
     * Font size in pixels with a default of 10 pixels.
     *
     * 
Please note this is specified in pixels so you may need to take the resolution of your
     * output into account when providing a size.
     *
     * @return font size
     */
    Expression getSize();

    /** @param size the font size in pixels */
    void setSize(Expression size);

    /**
     * Enumeration of allow font-style values.
     *
     * 
This is a way to document the constants allowable for the setStyle method
     *
     * 
enum Style2 implements Literal { NORMAL("normal"), ITALIC("italic"), OBLIQUE("oblique");
     *
     * final String literal; final static int count=0; private Style2(String constant) { literal
     * = constant; } public Object accept(ExpressionVisitor visitor, Object extraData) { return
     * visitor.visit( this, extraData ); } public Object evaluate(Object object) { return literal; }
     * public  T evaluate(Object object, Class context) { // return
     * Converters.convert(literal, context); if( context.isInstance( literal) ){ return
     * context.cast(literal); } return null; } public Object getValue() { return literal; } }
     */
    interface Style {
        static final String NORMAL = "normal";
        static final String ITALIC = "italic";
        static final String OBLIQUE = "oblique";
    }

    /** Enumeration of allow font-weight values. */
    interface Weight {
        static final String NORMAL = "normal";
        static final String BOLD = "bold";
    }
}