org.axsl.area

Interface LineContentFactory

All Known Subinterfaces:

AncestralNormalInlineArea, LineArea

public interface LineContentFactory

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

Method Summary

Modifier and Type	Method and Description
AncestralNormalInlineArea	makeBasicLinkArea(BasicLink basicLink, GraftingPoint graftingPoint) Creates a new Area for basic-link content.
AncestralNormalInlineArea	makeBidiOverrideArea(BidiOverride bidiOverride, GraftingPoint graftingPoint) Creates a new Area for bidi-override content.
NormalInlineArea	makeExternalGraphicArea(ExternalGraphic eg, int ipd, GraftingPoint graftingPoint) Creates a new Area for external-graphic content.
NormalInlineArea	makeForeignObjectArea(InstreamForeignObject ifo, int ipd, GraftingPoint graftingPoint) Creates a new Area for foreign-object content.
GlyphAreaSequence	makeGlyphAreaSequence(CharacterSequence characters, int startOffset, int sizeInChars, int ipd, boolean hasDiscretionaryHyphen, boolean hasFauxSmallCaps, boolean isLastItemOnLine, GraftingPoint graftingPoint) Create a new sequence of glyph-areas.
AncestralNormalInlineArea	makeIndexPageCitationListArea(IndexPageCitationList citationList, GraftingPoint graftingPoint) Creates a new Area for index-page-citation-list content.
AncestralNormalInlineArea	makeInlineArea(Inline inline, GraftingPoint graftingPoint) Creates a new Area for inline content.
InlineContainerArea	makeInlineContainerArea(InlineContainer inlineContainer, GraftingPoint graftingPoint) Creates a new Area for inline content.
AncestralNormalInlineArea	makeLeaderArea(Leader leader, int ipd, GraftingPoint graftingPoint) Creates a new Area for leader content.
AncestralNormalInlineArea	makePageNumberArea(PageNumber pageNumber, int ipd, GraftingPoint graftingPoint) Creates a new Area for page-number content.
AncestralNormalInlineArea	makePageNumberCitationArea(PageNumberCitation citation, int ipd, GraftingPoint graftingPoint) Creates a new Area for page-number-citation content.
AncestralNormalInlineArea	makePageNumberCitationLastArea(PageNumberCitationLast citation, int ipd, GraftingPoint graftingPoint) Creates a new Area for page-number-citation-last content.
NormalInlineArea	makeScalingValueCitationArea(ScalingValueCitation citation, int ipd, GraftingPoint graftingPoint) Creates a new Area for scaling-value-citation content.

Method Detail

makeBidiOverrideArea

AncestralNormalInlineArea makeBidiOverrideArea(BidiOverride bidiOverride,
                                               GraftingPoint graftingPoint)

Creates a new Area for bidi-override content.

Parameters:

bidiOverride - The generating BidiOverride.

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

makeGlyphAreaSequence

GlyphAreaSequence makeGlyphAreaSequence(CharacterSequence characters,
                                        int startOffset,
                                        int sizeInChars,
                                        int ipd,
                                        boolean hasDiscretionaryHyphen,
                                        boolean hasFauxSmallCaps,
                                        boolean isLastItemOnLine,
                                        GraftingPoint graftingPoint)

Create a new sequence of glyph-areas.

Parameters:

characters - The fo:character objects from which the glyph areas should be created.

startOffset - The index into CharacterPa.getAreaTreeText(FoContext) for characters of the first char element in that array that generates the glyph-areas in the new GlyphAreaSequence.

sizeInChars - The number of char elements in CharacterPa.getAreaTreeText(FoContext) for characters that generate the glyph-areas in the new GlyphAreaSequence.

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

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

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

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

graftingPoint - The controlling grafting point, if any.

Returns:

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

makeExternalGraphicArea

NormalInlineArea makeExternalGraphicArea(ExternalGraphic eg,
                                         int ipd,
                                         GraftingPoint graftingPoint)

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.

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

makeForeignObjectArea

NormalInlineArea makeForeignObjectArea(InstreamForeignObject ifo,
                                       int ipd,
                                       GraftingPoint graftingPoint)

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.

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

makeInlineArea

AncestralNormalInlineArea makeInlineArea(Inline inline,
                                         GraftingPoint graftingPoint)

Creates a new Area for inline content.

Parameters:

inline - The generating Inline.

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

makeInlineContainerArea

InlineContainerArea makeInlineContainerArea(InlineContainer inlineContainer,
                                            GraftingPoint graftingPoint)

Creates a new Area for inline content.

Parameters:

inlineContainer - The generating InlineContainer.

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

makeLeaderArea

AncestralNormalInlineArea makeLeaderArea(Leader leader,
                                         int ipd,
                                         GraftingPoint graftingPoint)
                                  throws AreaTreeException

Creates a new Area for leader content.

Parameters:

leader - The generating leader.

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

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

Throws:

AreaTreeException - If the minimum length is greater than the optimum length, or if the optimum length is greater than the maximum length.

makePageNumberArea

AncestralNormalInlineArea makePageNumberArea(PageNumber pageNumber,
                                             int ipd,
                                             GraftingPoint graftingPoint)

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.

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

makePageNumberCitationArea

AncestralNormalInlineArea makePageNumberCitationArea(PageNumberCitation citation,
                                                     int ipd,
                                                     GraftingPoint graftingPoint)

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.

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

makePageNumberCitationLastArea

AncestralNormalInlineArea makePageNumberCitationLastArea(PageNumberCitationLast citation,
                                                         int ipd,
                                                         GraftingPoint graftingPoint)

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

Parameters:

citation - The generating page-number-citation-last.

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

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

makeScalingValueCitationArea

NormalInlineArea makeScalingValueCitationArea(ScalingValueCitation citation,
                                              int ipd,
                                              GraftingPoint graftingPoint)

Creates a new Area for scaling-value-citation content.

Parameters:

citation - The generating scaling-value-citation.

ipd - The inline-progression-dimension used by the scaling-value-citation content.

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

makeBasicLinkArea

AncestralNormalInlineArea makeBasicLinkArea(BasicLink basicLink,
                                            GraftingPoint graftingPoint)

Creates a new Area for basic-link content.

Parameters:

basicLink - The generating basic-link.

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.

makeIndexPageCitationListArea

AncestralNormalInlineArea makeIndexPageCitationListArea(IndexPageCitationList citationList,
                                                        GraftingPoint graftingPoint)

Creates a new Area for index-page-citation-list content.

Parameters:

citationList - The generating index-page-citation-list.

graftingPoint - The controlling grafting point, if any.

Returns:

The new line content instance.