/*

 * Copyright (c) 1998, 2005, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code 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 General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/*

 * (C) Copyright IBM Corp. 1998-2003 All Rights Reserved

 *

 */

package sun.font;

import java.awt.Graphics2D;

import java.awt.Rectangle;

import java.awt.Shape;

import java.awt.font.GlyphJustificationInfo;

import java.awt.font.FontRenderContext;

import java.awt.font.LineMetrics;

import java.awt.geom.AffineTransform;

import java.awt.geom.Rectangle2D;

public interface TextLineComponent {

    public CoreMetrics getCoreMetrics();

    public void draw(Graphics2D g2d, float x, float y);

    public Rectangle2D getCharVisualBounds(int index);

    public Rectangle2D getVisualBounds();

    public float getAdvance();

    public Shape getOutline(float x, float y);

    public int getNumCharacters();

    public float getCharX(int index);

    public float getCharY(int index);

    public float getCharAdvance(int index);

    public boolean caretAtOffsetIsValid(int index);

    // measures characters in context, in logical order

    public int getLineBreakIndex(int start, float width);

    // measures characters in context, in logical order

    public float getAdvanceBetween(int start, int limit);

    public Rectangle2D getLogicalBounds();

    public Rectangle2D getItalicBounds();

    public AffineTransform getBaselineTransform();

    // return true if this wraps a glyphvector with no baseline rotation and

    // has no styles requiring complex pixel bounds calculations.

    public boolean isSimple();

    // return the pixel bounds if we wrap a glyphvector, else throw an

    // internal error

    public Rectangle getPixelBounds(FontRenderContext frc, float x, float y);

    /**

     * Force subset characters to run left-to-right.

     */

    public static final int LEFT_TO_RIGHT = 0;

    /**

     * Force subset characters to run right-to-left.

     */

    public static final int RIGHT_TO_LEFT = 1;

    /**

     * Leave subset character direction and ordering unchanged.

     */

    public static final int UNCHANGED = 2;

    /**

     * Return a TextLineComponent for the characters in the range

     * start, limit.  The range is relative to this TextLineComponent

     * (ie, the first character is at 0).

     * @param dir one of the constants LEFT_TO_RIGHT, RIGHT_TO_LEFT, or UNCHANGED

     */

    public TextLineComponent getSubset(int start, int limit, int dir);

    /**

     * Return the number of justification records this uses.

     */

    public int getNumJustificationInfos();

    /**

     * Return GlyphJustificationInfo objects for the characters between

     * charStart and charLimit, starting at offset infoStart.  Infos

     * will be in visual order.  All positions between infoStart and

     * getNumJustificationInfos will be set.  If a position corresponds

     * to a character outside the provided range, it is set to null.

     */

    public void getJustificationInfos(GlyphJustificationInfo[] infos, int infoStart, int charStart, int charLimit);

    /**

     * Apply deltas to the data in this component, starting at offset

     * deltaStart, and return the new component.  There are two floats

     * for each justification info, for a total of 2 * getNumJustificationInfos.

     * The first delta is the left adjustment, the second is the right

     * adjustment.

     * <p>

     * If flags[0] is true on entry, rejustification is allowed.  If

     * the new component requires rejustification (ligatures were

     * formed or split), flags[0] will be set on exit.

     */

    public TextLineComponent applyJustificationDeltas(float[] deltas, int deltaStart, boolean[] flags);

}