Module com.github.weisj.jsvg

Package com.github.weisj.jsvg.nodes.text

Class TextContainer

java.lang.Object

com.github.weisj.jsvg.nodes.AbstractSVGNode

com.github.weisj.jsvg.nodes.container.BaseContainerNode<TextSegment>

com.github.weisj.jsvg.nodes.text.TextContainer

All Implemented Interfaces:

Container<TextSegment>, HasContext, HasContext.ByDelegate, HasFontContext, HasFontRenderContext, HasPaintContext, HasShape, HasVectorEffects, Renderable, SVGNode, TextSegment, TextSegment.RenderableSegment

Direct Known Subclasses:

LinearTextContainer, TextPath

abstract class TextContainer
extends BaseContainerNode<TextSegment>
implements TextSegment.RenderableSegment, HasShape, HasContext.ByDelegate, HasVectorEffects, Renderable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	TextContainer.IntermediateTextMetrics

Nested classes/interfaces inherited from interface com.github.weisj.jsvg.nodes.prototype.HasContext

HasContext.ByDelegate

Nested classes/interfaces inherited from interface com.github.weisj.jsvg.nodes.prototype.HasShape

HasShape.Box

Nested classes/interfaces inherited from interface com.github.weisj.jsvg.nodes.text.TextSegment

TextSegment.RenderableSegment

Nested classes/interfaces inherited from interface com.github.weisj.jsvg.nodes.text.TextSegment.RenderableSegment

TextSegment.RenderableSegment.UseTextLengthForCalculation

Field Summary

Fields

Modifier and Type	Field	Description
private HasContext	context
protected AttributeFontSpec	fontSpec
private boolean	isVisible
protected LengthAdjust	lengthAdjust
private java.util.List<@NotNull TextSegment>	segments
protected Length	textLength
private java.util.Set<VectorEffect>	vectorEffects

Constructor Summary

Constructors

Constructor	Description
TextContainer()

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptChild(@Nullable java.lang.String id, @NotNull SVGNode node)	Determine whether the container accepts this SVGNode as a child.
private void	accumulateRenderableSegmentMetrics(@NotNull TextSegment.RenderableSegment segment, @NotNull TextContainer.IntermediateTextMetrics metrics, @NotNull RenderContext currentContext)
private void	accumulateSegmentMetrics(@NotNull TextContainer.IntermediateTextMetrics metrics, @NotNull StringTextSegment segment, @NotNull SVGFont font, float letterSpacing, int index)
void	addContent(char[] content)
void	appendTextShape(@NotNull GlyphCursor cursor, @NotNull MutableGlyphRun glyphRun, @NotNull RenderContext context)
void	build(@NotNull AttributeNode attributeNode)
java.util.List<? extends @NotNull TextSegment>	children()	Return all children of this container.
protected abstract void	cleanUpLocalCursor(@NotNull GlyphCursor current, @NotNull GlyphCursor local)
@NotNull TextMetrics	computeTextMetrics(@NotNull RenderContext context, @NotNull TextSegment.RenderableSegment.UseTextLengthForCalculation flag)
@NotNull HasContext	contextDelegate()
protected abstract GlyphCursor	createLocalCursor(@NotNull RenderContext context, @NotNull GlyphCursor current)
protected void	doAdd(@NotNull SVGNode node)
(package private) void	forEachSegment(@NotNull RenderContext context, @NotNull java.util.function.BiConsumer<StringTextSegment,RenderContext> onStringTextSegment, @NotNull java.util.function.BiConsumer<TextSegment.RenderableSegment,RenderContext> onRenderableSegment)
(package private) abstract @NotNull java.awt.Shape	glyphShape(@NotNull RenderContext context)
boolean	hasFixedLength()
boolean	isVisible(@NotNull RenderContext context)
private @NotNull GlyphAdvancement	localGlyphAdvancement(@NotNull RenderContext context, @NotNull GlyphCursor cursor)
void	prepareSegmentForRendering(@NotNull GlyphCursor cursor, @NotNull RenderContext context, @NotNull TextOutput textOutput)
protected void	renderSegment(@NotNull GlyphCursor cursor, @NotNull RenderContext context, @NotNull Output output)
void	renderSegmentWithoutLayout(@NotNull GlyphCursor cursor, @NotNull RenderContext context, @NotNull Output output)
(package private) @NotNull java.util.List<@NotNull TextSegment>	segments()
private double	textAnchorOffset(@NotNull TextAnchor textAnchor, @NotNull GlyphCursor glyphCursor)
@NotNull java.awt.geom.Rectangle2D	untransformedElementBounds(@NotNull RenderContext context, HasShape.Box box)
@NotNull java.awt.Shape	untransformedElementShape(@NotNull RenderContext context, HasShape.Box box)
@NotNull java.util.Set<VectorEffect>	vectorEffects()

Methods inherited from class com.github.weisj.jsvg.nodes.container.BaseContainerNode

addChild, isAcceptableType

Methods inherited from class com.github.weisj.jsvg.nodes.AbstractSVGNode

id, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.weisj.jsvg.nodes.prototype.Container

childrenOfType

Methods inherited from interface com.github.weisj.jsvg.nodes.prototype.HasContext.ByDelegate

fontRenderContext, fontSpec, paintContext

Methods inherited from interface com.github.weisj.jsvg.nodes.prototype.HasShape

elementBounds, elementShape

Methods inherited from interface com.github.weisj.jsvg.nodes.prototype.Renderable

parseIsVisible, render, requiresInstantiation, shouldEstablishChildContext

Methods inherited from interface com.github.weisj.jsvg.nodes.SVGNode

id, tagName

Methods inherited from interface com.github.weisj.jsvg.nodes.text.TextSegment

isValid

Field Detail

segments

private final java.util.List<@NotNull TextSegment> segments

fontSpec

protected AttributeFontSpec fontSpec

lengthAdjust

protected LengthAdjust lengthAdjust

textLength

protected Length textLength

isVisible

private boolean isVisible

context

private HasContext context

vectorEffects

private java.util.Set<VectorEffect> vectorEffects

Constructor Detail

TextContainer

TextContainer()

Method Detail

build

@MustBeInvokedByOverriders
public void build(@NotNull
                  @NotNull AttributeNode attributeNode)

Specified by:

build in interface SVGNode

Overrides:

build in class AbstractSVGNode

vectorEffects

@NotNull
public @NotNull java.util.Set<VectorEffect> vectorEffects()

Specified by:

vectorEffects in interface HasVectorEffects

contextDelegate

@NotNull
public @NotNull HasContext contextDelegate()

Specified by:

contextDelegate in interface HasContext.ByDelegate

segments

@NotNull
@NotNull java.util.List<@NotNull TextSegment> segments()

acceptChild

protected boolean acceptChild(@Nullable
                              @Nullable java.lang.String id,
                              @NotNull
                              @NotNull SVGNode node)

Description copied from class: BaseContainerNode

Determine whether the container accepts this SVGNode as a child. By default, this will always report true but subclasses may choose to reject certain types of nodes.

Overrides:

acceptChild in class BaseContainerNode<TextSegment>

Parameters:

id - the id of the node

node - the node itself

Returns:

whether the node can be inserted as a child.

doAdd

protected void doAdd(@NotNull
                     @NotNull SVGNode node)

Specified by:

doAdd in class BaseContainerNode<TextSegment>

addContent

public final void addContent(char[] content)

Specified by:

addContent in interface SVGNode

Overrides:

addContent in class AbstractSVGNode

children

public java.util.List<? extends @NotNull TextSegment> children()

Description copied from interface: Container

Return all children of this container. Note that the return type of this function internationally contains a wild card to make it a compilation error trying to modify it.

Specified by:

children in interface Container<TextSegment>

Returns:

the list of children.

glyphShape

@NotNull
abstract @NotNull java.awt.Shape glyphShape(@NotNull
                                            @NotNull RenderContext context)

untransformedElementShape

@NotNull
public final @NotNull java.awt.Shape untransformedElementShape(@NotNull
                                                               @NotNull RenderContext context,
                                                               HasShape.Box box)

Specified by:

untransformedElementShape in interface HasShape

createLocalCursor

protected abstract GlyphCursor createLocalCursor(@NotNull
                                                 @NotNull RenderContext context,
                                                 @NotNull
                                                 @NotNull GlyphCursor current)

cleanUpLocalCursor

protected abstract void cleanUpLocalCursor(@NotNull
                                           @NotNull GlyphCursor current,
                                           @NotNull
                                           @NotNull GlyphCursor local)

renderSegment

protected final void renderSegment(@NotNull
                                   @NotNull GlyphCursor cursor,
                                   @NotNull
                                   @NotNull RenderContext context,
                                   @NotNull
                                   @NotNull Output output)

textAnchorOffset

private double textAnchorOffset(@NotNull
                                @NotNull TextAnchor textAnchor,
                                @NotNull
                                @NotNull GlyphCursor glyphCursor)

forEachSegment

void forEachSegment(@NotNull
                    @NotNull RenderContext context,
                    @NotNull
                    @NotNull java.util.function.BiConsumer<StringTextSegment,RenderContext> onStringTextSegment,
                    @NotNull
                    @NotNull java.util.function.BiConsumer<TextSegment.RenderableSegment,RenderContext> onRenderableSegment)

computeTextMetrics

@NotNull
public @NotNull TextMetrics computeTextMetrics(@NotNull
                                               @NotNull RenderContext context,
                                               @NotNull
                                               @NotNull TextSegment.RenderableSegment.UseTextLengthForCalculation flag)

Specified by:

computeTextMetrics in interface TextSegment.RenderableSegment

accumulateRenderableSegmentMetrics

private void accumulateRenderableSegmentMetrics(@NotNull
                                                @NotNull TextSegment.RenderableSegment segment,
                                                @NotNull
                                                @NotNull TextContainer.IntermediateTextMetrics metrics,
                                                @NotNull
                                                @NotNull RenderContext currentContext)

accumulateSegmentMetrics

private void accumulateSegmentMetrics(@NotNull
                                      @NotNull TextContainer.IntermediateTextMetrics metrics,
                                      @NotNull
                                      @NotNull StringTextSegment segment,
                                      @NotNull
                                      @NotNull SVGFont font,
                                      float letterSpacing,
                                      int index)

hasFixedLength

public boolean hasFixedLength()

Specified by:

hasFixedLength in interface TextSegment.RenderableSegment

renderSegmentWithoutLayout

public void renderSegmentWithoutLayout(@NotNull
                                       @NotNull GlyphCursor cursor,
                                       @NotNull
                                       @NotNull RenderContext context,
                                       @NotNull
                                       @NotNull Output output)

Specified by:

renderSegmentWithoutLayout in interface TextSegment.RenderableSegment

prepareSegmentForRendering

public void prepareSegmentForRendering(@NotNull
                                       @NotNull GlyphCursor cursor,
                                       @NotNull
                                       @NotNull RenderContext context,
                                       @NotNull
                                       @NotNull TextOutput textOutput)

Specified by:

prepareSegmentForRendering in interface TextSegment.RenderableSegment

appendTextShape

public void appendTextShape(@NotNull
                            @NotNull GlyphCursor cursor,
                            @NotNull
                            @NotNull MutableGlyphRun glyphRun,
                            @NotNull
                            @NotNull RenderContext context)

Specified by:

appendTextShape in interface TextSegment.RenderableSegment

localGlyphAdvancement

@NotNull
private @NotNull GlyphAdvancement localGlyphAdvancement(@NotNull
                                                        @NotNull RenderContext context,
                                                        @NotNull
                                                        @NotNull GlyphCursor cursor)

untransformedElementBounds

@NotNull
public @NotNull java.awt.geom.Rectangle2D untransformedElementBounds(@NotNull
                                                                     @NotNull RenderContext context,
                                                                     HasShape.Box box)

Specified by:

untransformedElementBounds in interface HasShape

isVisible

public boolean isVisible(@NotNull
                         @NotNull RenderContext context)

Specified by:

isVisible in interface Renderable