org.axsl.areaR
Interface GeneralInlineArea

All Superinterfaces:

Area, AreaNode

All Known Subinterfaces:

BasicLinkArea, ExternalGraphicArea, ForeignObjectArea, InlineArea, LeaderArea, PageNumberArea, PageNumberCitationArea, TextArea

public interface GeneralInlineArea

extends Area

Super-interface for all inline areas.

Method Summary

int	baselineX() The absolute X position of the alignment point at which the cursor should be positioned before writing this item in the output.
int	baselineY() The absolute Y position of the alignment point at which the cursor should be positioned before writing this item in the output.
LineArea	getLineArea() Return the parent LineArea instance.
FontUse	getPrimaryFont() The primary font for this Area.
FontUse	getSecondaryFont(int codePoint) The secondary font for this Area.
int	letterSpacing() The letter-spacing for this Area.
int	traitFontSize() The font-size for this Area.
boolean	traitOverlineScore() The "overline-score" trait.
java.awt.Color	traitOverlineScoreColor() The "overline-score-color" trait.
boolean	traitThroughScore() The "through-score" trait.
java.awt.Color	traitThroughScoreColor() The "through-score-color" trait.
boolean	traitUnderlineScore() The "underline-score" trait.
java.awt.Color	traitUnderlineScoreColor() The "underline-score-color" trait.

Methods inherited from interface org.axsl.areaR.Area

brBPD, brIPD, brOriginX, brOriginY, brPoints, crBPD, crIPD, crOriginX, crOriginY, destinationName, generatedByExists, generatedByName, getColor, getProgressionDimension, linkDestination, linkType, prOriginX, prOriginY, rrBPD, rrIPD, rrOriginX, rrOriginY, traitBorderAfterColor, traitBorderAfterWidth, traitBorderBeforeColor, traitBorderBeforeWidth, traitBorderEndColor, traitBorderEndWidth, traitBorderStartColor, traitBorderStartWidth, traitOverflow, traitScaling

Methods inherited from interface org.axsl.areaR.AreaNode

ancestorLineAreaOut, getAreaName, getChildren, getFontConsumer, getParentOut, render, traitColor, traitFontStyle, traitFontWeight, traitId, traitInternalDestination

Method Detail

baselineX

public int baselineX()

The absolute X position of the alignment point at which the cursor should be positioned before writing this item in the output. Specifically, the alignment points for all text glyphs and other areas should lie on a line which 1) passes through the alignment point, and 2) is parallel to the before edge of the area being written.

Returns:

The absolute X position for the cursor.

baselineY

public int baselineY()

The absolute Y position of the alignment point at which the cursor should be positioned before writing this item in the output. Specifically, the alignment points for all text glyphs and other areas should lie on a line which 1) passes through the alignment point, and 2) is parallel to the before edge of the area being written.

Returns:

The absolute X position for the cursor.

letterSpacing

public int letterSpacing()

The letter-spacing for this Area.

Returns:

The letter-spacing, in millipoints.

getPrimaryFont

public FontUse getPrimaryFont()

The primary font for this Area.

Returns:

The primary font for this Area.

getSecondaryFont

public FontUse getSecondaryFont(int codePoint)

The secondary font for this Area.

Parameters:

codePoint - The Unicode code point which should be used to obtain a secondary font. This should ordinarily be the next character to be rendered that the primary font cannot render.

Returns:

The secondary font for this Area.

traitFontSize

public int traitFontSize()

The font-size for this Area.

Returns:

The font-size, in millipoints.

traitUnderlineScore

public boolean traitUnderlineScore()

The "underline-score" trait.

Returns:

True iff this item should be underlined.

traitOverlineScore

public boolean traitOverlineScore()

The "overline-score" trait.

Returns:

True iff this item should be overlined.

traitThroughScore

public boolean traitThroughScore()

The "through-score" trait.

Returns:

True iff this item should be through-scored (strikeout).

traitUnderlineScoreColor

public java.awt.Color traitUnderlineScoreColor()

The "underline-score-color" trait.

Returns:

The color of the underline-score.

traitOverlineScoreColor

public java.awt.Color traitOverlineScoreColor()

The "overline-score-color" trait.

Returns:

The color of the overline-score.

traitThroughScoreColor

public java.awt.Color traitThroughScoreColor()

The "through-score-color" trait.

Returns:

The color of the through-score.

getLineArea

public LineArea getLineArea()

Return the parent LineArea instance.

Returns:

The LineArea.