org.axsl.text.line

Interface LineNonText

All Superinterfaces:

LineContent

All Known Subinterfaces:

ExternalGraphic, FoLineNonText, InstreamForeignObject, Leader, PageNumber, PageNumberCitation, PageNumberCitationLast, ScalingValueCitation

public interface LineNonText
extends LineContent

This interface should be used by classes wishing to present themselves to the line-breaking system as being a part of a line, but not containing text. The size of such items must be accounted for when computing a line-break.

Method Summary

Modifier and Type	Method and Description
int	inlineSizeMaximum(int lineLength) Tells the line-breaking system the maximum amount of the line that this non-text item should occupy.
int	inlineSizeMinimum(int lineLength) Tells the line-breaking system the minimum amount of the line that this non-text item should occupy.
int	inlineSizeOptimum(int lineLength) Tells the line-breaking system the optimum amount of the line that this non-text item should occupy.

Methods inherited from interface org.axsl.text.line.LineContent

isLastItemInBlock

Method Detail

inlineSizeOptimum

int inlineSizeOptimum(int lineLength)

Tells the line-breaking system the optimum amount of the line that this non-text item should occupy.

Parameters:

lineLength - The length of the line on which this non-text item will be placed. This gives the non-text item the opportunity to compute its size based on a percentage of the line length.

Returns:

The inline-progression-dimension, or size, of this item, in millipoints. For horizontal writing modes (such as those used in Western languages), this will be the width of the item. For vertical writing modes (such as those used in some Far Eastern languages), this will be the height of the item.

inlineSizeMinimum

int inlineSizeMinimum(int lineLength)

Tells the line-breaking system the minimum amount of the line that this non-text item should occupy.

Parameters:

lineLength - The length, in millipoints, of the line for which the minimum length is being computed. This can be used by the implementation to handle situations where the item should occupy a certain percentage of the line.

Returns:

The minimum size, in millipoints, that this item should occupy on the line.

See Also:

inlineSizeOptimum(int)

inlineSizeMaximum

int inlineSizeMaximum(int lineLength)

Tells the line-breaking system the maximum amount of the line that this non-text item should occupy.

Parameters:

lineLength - The length, in millipoints, of the line for which the maximum length is being computed. This can be used by the implementation to handle situations where the item should occupy a certain percentage of the line.

Returns:

The maximum size, in millipoints, that this item should occupy on the line.

See Also:

inlineSizeOptimum(int)