FileDocCategorySizeDatePackage
GlyphJustificationInfo.javaAPI DocJava SE 5 API7426Fri Aug 26 14:56:50 BST 2005java.awt.font

GlyphJustificationInfo

public final class GlyphJustificationInfo extends Object
The GlyphJustificationInfo class represents information about the justification properties of a glyph. A glyph is the visual representation of one or more characters. Many different glyphs can be used to represent a single character or combination of characters. The four justification properties represented by GlyphJustificationInfo are weight, priority, absorb and limit.

Weight is the overall 'weight' of the glyph in the line. Generally it is proportional to the size of the font. Glyphs with larger weight are allocated a correspondingly larger amount of the change in space.

Priority determines the justification phase in which this glyph is used. All glyphs of the same priority are examined before glyphs of the next priority. If all the change in space can be allocated to these glyphs without exceeding their limits, then glyphs of the next priority are not examined. There are four priorities, kashida, whitespace, interchar, and none. KASHIDA is the first priority examined. NONE is the last priority examined.

Absorb determines whether a glyph absorbs all change in space. Within a given priority, some glyphs may absorb all the change in space. If any of these glyphs are present, no glyphs of later priority are examined.

Limit determines the maximum or minimum amount by which the glyph can change. Left and right sides of the glyph can have different limits.

Each GlyphJustificationInfo represents two sets of metrics, which are growing and shrinking. Growing metrics are used when the glyphs on a line are to be spread apart to fit a larger width. Shrinking metrics are used when the glyphs are to be moved together to fit a smaller width.

Fields Summary
public static final int
PRIORITY_KASHIDA
The highest justification priority.
public static final int
PRIORITY_WHITESPACE
The second highest justification priority.
public static final int
PRIORITY_INTERCHAR
The second lowest justification priority.
public static final int
PRIORITY_NONE
The lowest justification priority.
public final float
weight
The weight of this glyph.
public final int
growPriority
The priority level of this glyph as it is growing.
public final boolean
growAbsorb
If true, this glyph absorbs all extra space at this and lower priority levels when it grows.
public final float
growLeftLimit
The maximum amount by which the left side of this glyph can grow.
public final float
growRightLimit
The maximum amount by which the right side of this glyph can grow.
public final int
shrinkPriority
The priority level of this glyph as it is shrinking.
public final boolean
shrinkAbsorb
If true,this glyph absorbs all remaining shrinkage at this and lower priority levels as it shrinks.
public final float
shrinkLeftLimit
The maximum amount by which the left side of this glyph can shrink (a positive number).
public final float
shrinkRightLimit
The maximum amount by which the right side of this glyph can shrink (a positive number).
Constructors Summary
public GlyphJustificationInfo(float weight, boolean growAbsorb, int growPriority, float growLeftLimit, float growRightLimit, boolean shrinkAbsorb, int shrinkPriority, float shrinkLeftLimit, float shrinkRightLimit)
Constructs information about the justification properties of a glyph.

param
weight the weight of this glyph when allocating space. Must be non-negative.
param
growAbsorb if true this glyph absorbs all extra space at this priority and lower priority levels when it grows
param
growPriority the priority level of this glyph when it grows
param
growLeftLimit the maximum amount by which the left side of this glyph can grow. Must be non-negative.
param
growRightLimit the maximum amount by which the right side of this glyph can grow. Must be non-negative.
param
shrinkAbsorb if true, this glyph absorbs all remaining shrinkage at this and lower priority levels when it shrinks
param
shrinkPriority the priority level of this glyph when it shrinks
param
shrinkLeftLimit the maximum amount by which the left side of this glyph can shrink. Must be non-negative.
param
shrinkRightLimit the maximum amount by which the right side of this glyph can shrink. Must be non-negative.

        if (weight < 0) {
            throw new IllegalArgumentException("weight is negative");
        }

        if (!priorityIsValid(growPriority)) {
            throw new IllegalArgumentException("Invalid grow priority");
        }
        if (growLeftLimit < 0) {
            throw new IllegalArgumentException("growLeftLimit is negative");
        }
        if (growRightLimit < 0) {
            throw new IllegalArgumentException("growRightLimit is negative");
        }

        if (!priorityIsValid(shrinkPriority)) {
            throw new IllegalArgumentException("Invalid shrink priority");
        }
        if (shrinkLeftLimit < 0) {
            throw new IllegalArgumentException("shrinkLeftLimit is negative");
        }
        if (shrinkRightLimit < 0) {
            throw new IllegalArgumentException("shrinkRightLimit is negative");
        }

        this.weight = weight;
        this.growAbsorb = growAbsorb;
        this.growPriority = growPriority;
        this.growLeftLimit = growLeftLimit;
        this.growRightLimit = growRightLimit;
        this.shrinkAbsorb = shrinkAbsorb;
        this.shrinkPriority = shrinkPriority;
        this.shrinkLeftLimit = shrinkLeftLimit;
        this.shrinkRightLimit = shrinkRightLimit;
Methods Summary
private static booleanpriorityIsValid(int priority)


        return priority >= PRIORITY_KASHIDA && priority <= PRIORITY_NONE;