de.intarsys.pdf.font.CharacterSelector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jpod Show documentation

This is a fork of http://sourceforge.net/projects/jpodlib/ as development seems to be frozen. We're providing some bug fixes along with deployments to maven.

There is a newer version: 2.0

Show newest version

/*
 * Copyright (c) 2007, intarsys consulting GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of intarsys nor the names of its contributors may be used
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package de.intarsys.pdf.font;

/**
 * A selector for a character within a font. Within PDF only CID's are
 * supported.
 * 
 * A character may be identified by different means (name, index, unicode..).
 */
public abstract class CharacterSelector {
    /**
     * The special selector for undefined glyphs.
     */
    public static final CharacterSelector Notdef = new CharacterSelectorCID(0);

    /**
     * The special CID value for undefined glyphs.
     */
    public static final int NotdefCID = 0;

    /**
     *
     */
    protected CharacterSelector() {
        super();
    }

    /**
     * The font number referenced by this selector.
     * 

     * In PDF this is always 0.
     *
     * @return The font number referenced by this selector.
     */
    public int getFontNumber() {
        return 0;
    }

    /**
     * The number of bytes this selector occupies.
     *
     * @return The number of bytes this selector occupies.
     */
    public abstract int getLength();

    /**
     * The integer equivalent of the selector.
     * 
     * A selector must not be larger than the platform integer size.
     *
     * @return The integer equivalent of the selector.
     */
    public abstract int getValue();
}