org.axsl.areaW
Interface LineContentFactory

All Known Subinterfaces:

InlineArea, LeaderArea, LineArea

public interface LineContentFactory

Super-interface for all interfaces that need to be able to create child inline content.

Method Summary

ExternalGraphicArea	makeExternalGraphicArea(ExternalGraphic eg, int ipd, RetrieveMarker retrieveMarker) Creates a new Area for external-graphic content.
ForeignObjectArea	makeForeignObjectArea(InstreamForeignObject ifo, int ipd, RetrieveMarker retrieveMarker) Creates a new Area for foreign-object content.
LeaderArea	makeLeaderArea(Leader leader, int ipd, RetrieveMarker retrieveMarker) Creates a new Area for leader content.
PageNumberArea	makePageNumberArea(PageNumber pageNumber, int ipd, RetrieveMarker retrieveMarker) Creates a new Area for page-number content.
PageNumberCitationArea	makePageNumberCitationArea(PageNumberCitation citation, int ipd, RetrieveMarker retrieveMarker) Creates a new Area for page-number-citation content.
TextArea	makeTextArea(FOText foText, int ipd, int startOffset, int sizeInChars, boolean hasDiscretionaryHyphen, boolean hasFauxSmallCaps, boolean isLastItemOnLine, RetrieveMarker retrieveMarker) Create a new text area.

Method Detail

makeForeignObjectArea

public ForeignObjectArea makeForeignObjectArea(InstreamForeignObject ifo,
                                               int ipd,
                                               RetrieveMarker retrieveMarker)

Creates a new Area for foreign-object content.

Parameters:

ifo - The generating instream-foreign-object.

ipd - The inline-progression-dimension used by the foreign-object content.

retrieveMarker - The controlling retrieve-marker, if any.

Returns:

The new line content instance.

makeExternalGraphicArea

public ExternalGraphicArea makeExternalGraphicArea(ExternalGraphic eg,
                                                   int ipd,
                                                   RetrieveMarker retrieveMarker)

Creates a new Area for external-graphic content.

Parameters:

eg - The generating external-graphic.

ipd - The inline-progression-dimension used by the external-graphic content.

retrieveMarker - The controlling retrieve-marker, if any.

Returns:

The new line content instance.

makeLeaderArea

public LeaderArea makeLeaderArea(Leader leader,
                                 int ipd,
                                 RetrieveMarker retrieveMarker)

Creates a new Area for leader content.

Parameters:

leader - The generating leader.

ipd - The inline-progression-dimension used by the leader content.

retrieveMarker - The controlling retrieve-marker, if any.

Returns:

The new line content instance.

makePageNumberArea

public PageNumberArea makePageNumberArea(PageNumber pageNumber,
                                         int ipd,
                                         RetrieveMarker retrieveMarker)

Creates a new Area for page-number content.

Parameters:

pageNumber - The generating page-number.

ipd - The inline-progression-dimension used by the page-number content.

retrieveMarker - The controlling retrieve-marker, if any.

Returns:

The new line content instance.

makePageNumberCitationArea

public PageNumberCitationArea makePageNumberCitationArea(PageNumberCitation citation,
                                                         int ipd,
                                                         RetrieveMarker retrieveMarker)

Creates a new Area for page-number-citation content.

Parameters:

citation - The generating page-number-citation.

ipd - The inline-progression-dimension used by the page-number-citation content.

retrieveMarker - The controlling retrieve-marker, if any.

Returns:

The new line content instance.

makeTextArea

public TextArea makeTextArea(FOText foText,
                             int ipd,
                             int startOffset,
                             int sizeInChars,
                             boolean hasDiscretionaryHyphen,
                             boolean hasFauxSmallCaps,
                             boolean isLastItemOnLine,
                             RetrieveMarker retrieveMarker)

Create a new text area.

Parameters:

foText - The FOText from which this text area should be created.

ipd - The inline-progression-dimension, in millipoints, which the new TextArea consumes on the line.

startOffset - The index to the first character in foText that will be part of the new FOText instance.

sizeInChars - The number of characters in foText that should be included in the new FOText instance.

hasDiscretionaryHyphen - True iff the new FOText should place a discretionary hyphen at the end of the text.

hasFauxSmallCaps - True iff the new FOText item content should be handled as faux small caps.

isLastItemOnLine - True iff the new FOText will be the last item on the line.

retrieveMarker - The controlling retrieve-marker, if any.

Returns:

The new TextArea instance, or null if there is no content.