org.axsl.foR
Interface FOLineNonText

All Superinterfaces:

LineContent, LineNonText

All Known Subinterfaces:

ExternalGraphic, InstreamForeignObject, Leader, PageNumber, PageNumberCitation

public interface FOLineNonText

extends LineNonText

Subinterface of LineNonText that provides additional services to XSL-FO systems.

Method Summary

FOLineNonText	getContextWrapper(FOContext context) Allows the FOContext to attach itself to a LineNonText item as it passes through the line-breaking system, if that context is necessary.
RetrieveMarker	getRetrieveMarker() Return the retrieve-marker associated with this item, if any.
FOLineNonText	getWrapped() If this instance wraps another (to provide context), return the wrapped instance.
int	inlineSizeMaximum(FOContext context, int lineLength) Context-aware version of LineNonText.inlineSizeMaximum(int).
int	inlineSizeMinimum(FOContext context, int lineLength) Context-aware version of LineNonText.inlineSizeMinimum(int).
int	inlineSizeOptimum(FOContext context, int lineLength) Context-aware version of LineNonText.inlineSizeOptimum(int).

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

inlineSizeMaximum, inlineSizeMinimum, inlineSizeOptimum

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

isLastItemInBlock

Method Detail

getContextWrapper

public FOLineNonText getContextWrapper(FOContext context)

Allows the FOContext to attach itself to a LineNonText item as it passes through the line-breaking system, if that context is necessary.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

Either "this" or context-aware equivalent of "this", depending upon whether the context is needed.

getWrapped

public FOLineNonText getWrapped()

If this instance wraps another (to provide context), return the wrapped instance.

Returns:

The wrapped instance, or "this" if it is not a wrapper.

getRetrieveMarker

public RetrieveMarker getRetrieveMarker()

Return the retrieve-marker associated with this item, if any.

Returns:

The retrieve-marker associated with this item, or null if there is none.

inlineSizeOptimum

public int inlineSizeOptimum(FOContext context,
                             int lineLength)

Context-aware version of LineNonText.inlineSizeOptimum(int).

Parameters:

context - An object that knows how to resolve FO Tree context issues.

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

public int inlineSizeMinimum(FOContext context,
                             int lineLength)

Context-aware version of LineNonText.inlineSizeMinimum(int).

Parameters:

context - An object that knows how to resolve FO Tree context issues.

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(org.axsl.foR.FOContext, int)

inlineSizeMaximum

public int inlineSizeMaximum(FOContext context,
                             int lineLength)

Context-aware version of LineNonText.inlineSizeMaximum(int).

Parameters:

context - An object that knows how to resolve FO Tree context issues.

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(org.axsl.foR.FOContext, int)