Module com.github.weisj.jsvg

Package com.github.weisj.jsvg.nodes

Class Mask

java.lang.Object

com.github.weisj.jsvg.nodes.AbstractSVGNode

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

com.github.weisj.jsvg.nodes.container.CommonRenderableContainerNode

com.github.weisj.jsvg.nodes.Mask

All Implemented Interfaces:

Container<SVGNode>, HasClip, HasContext, HasContext.ByDelegate, HasFilter, HasFontContext, HasFontRenderContext, HasGeometryContext, HasGeometryContext.ByDelegate, HasPaintContext, Instantiator, Renderable, Transformable, SVGNode

@ElementCategories(Container)
@PermittedContent(categories={Animation,Descriptive,Shape,Structural,Gradient},
                  anyOf={Anchor.class,ClipPath.class,Filter.class,Image.class,Marker.class,Mask.class,Pattern.class,Style.class,Text.class,View.class})
public final class Mask
extends CommonRenderableContainerNode
implements Instantiator

Nested Class Summary

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.HasGeometryContext

HasGeometryContext.ByDelegate

Field Summary

Fields

Modifier and Type	Field	Description
private static boolean	DEBUG
private Length	height
private UnitType	maskContentUnits
private UnitType	maskUnits
private CachedSurfaceSupplier	surfaceSupplier
static java.lang.String	TAG
private Length	width
private Length	x
private Length	y

Constructor Summary

Constructors

Constructor	Description
Mask()

Method Summary

Modifier and Type	Method	Description
void	build(@NotNull AttributeNode attributeNode)
boolean	canInstantiate(@NotNull SVGNode node)
@NotNull java.awt.Paint	createMaskPaint(@NotNull Output output, @NotNull RenderContext context, @NotNull ElementBounds elementBounds)
boolean	requiresInstantiation()	Indicated whether the element can only be rendered through means of instantiation e.g.
@NotNull java.lang.String	tagName()

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

children, contextDelegate, doAdd, geometryContextDelegate, isVisible, render

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

acceptChild, addChild, isAcceptableType

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

addContent, 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.HasGeometryContext.ByDelegate

clipPath, filter, mask, transform, transformBox, transformOrigin

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

createContextAttributes

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

parseIsVisible, shouldEstablishChildContext

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

applyTransform, effectiveTransform, shouldTransform, transformShape

Field Detail

DEBUG

private static final boolean DEBUG

See Also:

Constant Field Values

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

surfaceSupplier

private final CachedSurfaceSupplier surfaceSupplier

x

private Length x

y

private Length y

width

private Length width

height

private Length height

maskContentUnits

private UnitType maskContentUnits

maskUnits

private UnitType maskUnits

Constructor Detail

Mask

public Mask()

Method Detail

tagName

@NotNull
public @NotNull java.lang.String tagName()

Specified by:

tagName in interface SVGNode

build

public void build(@NotNull
                  @NotNull AttributeNode attributeNode)

Specified by:

build in interface SVGNode

Overrides:

build in class CommonRenderableContainerNode

createMaskPaint

@NotNull
public @NotNull java.awt.Paint createMaskPaint(@NotNull
                                               @NotNull Output output,
                                               @NotNull
                                               @NotNull RenderContext context,
                                               @NotNull
                                               @NotNull ElementBounds elementBounds)

requiresInstantiation

public boolean requiresInstantiation()

Description copied from interface: Renderable

Indicated whether the element can only be rendered through means of instantiation e.g. being referenced in a use tag. Instantiation doesn't create a new element it only controls, when an element can be rendered.

Specified by:

requiresInstantiation in interface Renderable

Returns:

true if only rendered is instantiated.

canInstantiate

public boolean canInstantiate(@NotNull
                              @NotNull SVGNode node)

Specified by:

canInstantiate in interface Instantiator