Modifier and Type	Class and Description
public static enum	PaintStyle.FlipMode
public static interface	PaintStyle.GradientPaint
public static enum	PaintStyle.PaintModifier The PaintStyle can be modified by secondary sources, e.g. the attributes in the preset shapes.
public static interface	PaintStyle.SolidPaint
public static enum	PaintStyle.TextureAlignment
public static interface	PaintStyle.TexturePaint

org.apache.poi.sl.usermodel back to summary

public final Enum PaintStyle.FlipMode

Class Inheritance

java.lang.Object
java.lang.Enum
org.apache.poi.sl.usermodel.PaintStyle.FlipMode

Field Summary

Modifier and Type	Field and Description
public static final PaintStyle.FlipMode	NONE not flipped/mirrored
public static final PaintStyle.FlipMode	X flipped/mirrored/duplicated along the x axis
public static final PaintStyle.FlipMode	XY flipped/mirrored/duplicated along the x and y axis
public static final PaintStyle.FlipMode	Y flipped/mirrored/duplicated along the y axis

Constructor Summary

Access	Constructor and Description
private	FlipMode()

Method Summary

Modifier and Type	Method and Description
public static PaintStyle.FlipMode	valueOf(String name)
public static PaintStyle.FlipMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

NONE	back to summary
public static final PaintStyle.FlipMode NONE not flipped/mirrored

X	back to summary
public static final PaintStyle.FlipMode X flipped/mirrored/duplicated along the x axis

XY	back to summary
public static final PaintStyle.FlipMode XY flipped/mirrored/duplicated along the x and y axis

Y	back to summary
public static final PaintStyle.FlipMode Y flipped/mirrored/duplicated along the y axis

Constructor Detail

FlipMode	back to summary
private FlipMode()

Method Detail

valueOf	back to summary
public static PaintStyle.FlipMode valueOf(String name)

values	back to summary
public static PaintStyle.FlipMode[] values()

org.apache.poi.sl.usermodel back to summary

public Interface PaintStyle.GradientPaint

extends PaintStyle

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	PaintStyle.GradientPaint.GradientType

Method Summary

Modifier and Type	Method and Description
public default Insets2D	getFillToInsets()
public double	Returns: the angle of the gradient getGradientAngle()
public ColorStyle[]	getGradientColors()
public float[]	getGradientFractions()
public PaintStyle.GradientPaint.GradientType	getGradientType()
public boolean	isRotatedWithShape()

Method Detail

getFillToInsets	back to summary
public default Insets2D getFillToInsets()

getGradientAngle	back to summary
public double getGradientAngle() Returns:double the angle of the gradient

getGradientColors	back to summary
public ColorStyle[] getGradientColors()

getGradientFractions	back to summary
public float[] getGradientFractions()

getGradientType	back to summary
public PaintStyle.GradientPaint.GradientType getGradientType()

isRotatedWithShape	back to summary
public boolean isRotatedWithShape()

org.apache.poi.sl.usermodel back to summary

public final Enum PaintStyle.GradientPaint.GradientType

Class Inheritance

extends Enum<PaintStyle.GradientPaint.GradientType>

java.lang.Object
java.lang.Enum
org.apache.poi.sl.usermodel.PaintStyle.GradientPaint.GradientType

Field Summary

Modifier and Type	Field and Description
public static final PaintStyle.GradientPaint.GradientType	circular
public static final PaintStyle.GradientPaint.GradientType	linear
public static final PaintStyle.GradientPaint.GradientType	rectangular
public static final PaintStyle.GradientPaint.GradientType	shape

Constructor Summary

Access	Constructor and Description
private	GradientType()

Method Summary

Modifier and Type	Method and Description
public static PaintStyle.GradientPaint.GradientType	valueOf(String name)
public static PaintStyle.GradientPaint.GradientType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

circular	back to summary
public static final PaintStyle.GradientPaint.GradientType circular

linear	back to summary
public static final PaintStyle.GradientPaint.GradientType linear

rectangular	back to summary
public static final PaintStyle.GradientPaint.GradientType rectangular

shape	back to summary
public static final PaintStyle.GradientPaint.GradientType shape

Constructor Detail

GradientType	back to summary
private GradientType()

Method Detail

valueOf	back to summary
public static PaintStyle.GradientPaint.GradientType valueOf(String name)

values	back to summary
public static PaintStyle.GradientPaint.GradientType[] values()

org.apache.poi.sl.usermodel back to summary

public final Enum PaintStyle.PaintModifier

Class Inheritance

extends Enum<PaintStyle.PaintModifier>

java.lang.Object
java.lang.Enum
org.apache.poi.sl.usermodel.PaintStyle.PaintModifier

The PaintStyle can be modified by secondary sources, e.g. the attributes in the preset shapes. These modifications need to be taken into account when the final color is determined.

Field Summary

Modifier and Type	Field and Description
public static final PaintStyle.PaintModifier	DARKEN darken the paint/filling
public static final PaintStyle.PaintModifier	DARKEN_LESS darken (...
public static final PaintStyle.PaintModifier	LIGHTEN lighten the paint/filling
public static final PaintStyle.PaintModifier	LIGHTEN_LESS lighten (...
public static final PaintStyle.PaintModifier	NONE don't use any paint/fill
public static final PaintStyle.PaintModifier	NORM use the paint/filling as-is

Constructor Summary

Access	Constructor and Description
private	PaintModifier()

Method Summary

Modifier and Type	Method and Description
public static PaintStyle.PaintModifier	valueOf(String name)
public static PaintStyle.PaintModifier[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DARKEN	back to summary
public static final PaintStyle.PaintModifier DARKEN darken the paint/filling

DARKEN_LESS	back to summary
public static final PaintStyle.PaintModifier DARKEN_LESS darken (... a bit less) the paint/filling

LIGHTEN	back to summary
public static final PaintStyle.PaintModifier LIGHTEN lighten the paint/filling

LIGHTEN_LESS	back to summary
public static final PaintStyle.PaintModifier LIGHTEN_LESS lighten (... a bit less) the paint/filling

NONE	back to summary
public static final PaintStyle.PaintModifier NONE don't use any paint/fill

NORM	back to summary
public static final PaintStyle.PaintModifier NORM use the paint/filling as-is

Constructor Detail

PaintModifier	back to summary
private PaintModifier()

Method Detail

valueOf	back to summary
public static PaintStyle.PaintModifier valueOf(String name)

values	back to summary
public static PaintStyle.PaintModifier[] values()

org.apache.poi.sl.usermodel back to summary

public Interface PaintStyle.SolidPaint

Known Direct Implementers: org.apache.poi.sl.draw.DrawPaint.SimpleSolidPaint

Method Summary

Modifier and Type	Method and Description
public ColorStyle	getSolidColor()

Method Detail

getSolidColor	back to summary
public ColorStyle getSolidColor()

org.apache.poi.sl.usermodel back to summary

public final Enum PaintStyle.TextureAlignment

Class Inheritance

extends Enum<PaintStyle.TextureAlignment>

java.lang.Object
java.lang.Enum
org.apache.poi.sl.usermodel.PaintStyle.TextureAlignment

Field Summary

Modifier and Type	Field and Description
public static final PaintStyle.TextureAlignment	BOTTOM
public static final PaintStyle.TextureAlignment	BOTTOM_LEFT
public static final PaintStyle.TextureAlignment	BOTTOM_RIGHT
public static final PaintStyle.TextureAlignment	CENTER
public static final PaintStyle.TextureAlignment	LEFT
private final String	ooxmlId
public static final PaintStyle.TextureAlignment	RIGHT
public static final PaintStyle.TextureAlignment	TOP
public static final PaintStyle.TextureAlignment	TOP_LEFT
public static final PaintStyle.TextureAlignment	TOP_RIGHT

Constructor Summary

Access	Constructor and Description
private	TextureAlignment(String ooxmlId)

Method Summary

Modifier and Type	Method and Description
public static PaintStyle.TextureAlignment	fromOoxmlId(String ooxmlId)
public static PaintStyle.TextureAlignment	valueOf(String name)
public static PaintStyle.TextureAlignment[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BOTTOM	back to summary
public static final PaintStyle.TextureAlignment BOTTOM

BOTTOM_LEFT	back to summary
public static final PaintStyle.TextureAlignment BOTTOM_LEFT

BOTTOM_RIGHT	back to summary
public static final PaintStyle.TextureAlignment BOTTOM_RIGHT

CENTER	back to summary
public static final PaintStyle.TextureAlignment CENTER

LEFT	back to summary
public static final PaintStyle.TextureAlignment LEFT

ooxmlId	back to summary
private final String ooxmlId

RIGHT	back to summary
public static final PaintStyle.TextureAlignment RIGHT

TOP	back to summary
public static final PaintStyle.TextureAlignment TOP

TOP_LEFT	back to summary
public static final PaintStyle.TextureAlignment TOP_LEFT

TOP_RIGHT	back to summary
public static final PaintStyle.TextureAlignment TOP_RIGHT

Constructor Detail

TextureAlignment	back to summary
private TextureAlignment(String ooxmlId)

Method Detail

fromOoxmlId	back to summary
public static PaintStyle.TextureAlignment fromOoxmlId(String ooxmlId)

valueOf	back to summary
public static PaintStyle.TextureAlignment valueOf(String name)

values	back to summary
public static PaintStyle.TextureAlignment[] values()

org.apache.poi.sl.usermodel back to summary

public Interface PaintStyle.TexturePaint

extends PaintStyle

Method Summary

Modifier and Type	Method and Description
public default PaintStyle.TextureAlignment	getAlignment()
public int	Returns: the alpha mask in percents [0..100000] getAlpha()
public String	Returns: the content type of the image data getContentType()
public default List<ColorStyle>	getDuoTone() For pattern images, the duo tone defines the black/white pixel color replacement
public default PaintStyle.FlipMode	Returns: the flip/mirroring/duplication mode getFlipMode()
public InputStream	Returns: the raw image stream getImageData()
public default Insets2D	Returns: the cropping insets of the source image getInsets() Specifies the portion of the blip or image that is used for the fill.
public default Point2D	Returns: the offset of the tiles in points or `null` if there's no offset getOffset()
public default Dimension2D	Returns: the dimensions of the tiles in percent of the shape dimensions or `null` if no scaling is applied getScale()
public Shape<S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>>	Returns: the shape this texture paint is applied to getShape()
public default Insets2D	Returns: the stretching in the destination image getStretch() The stretch specifies the edges of a fill rectangle.
public default boolean	Returns: `true`, if the rotation of the shape is also applied to the texture paint isRotatedWithShape()

Method Detail

getAlignment	back to summary
public default PaintStyle.TextureAlignment getAlignment()

getAlpha	back to summary
public int getAlpha() Returns:int the alpha mask in percents [0..100000]

getContentType	back to summary
public String getContentType() Returns:String the content type of the image data

getDuoTone	back to summary
public default List<ColorStyle> getDuoTone() For pattern images, the duo tone defines the black/white pixel color replacement

getFlipMode	back to summary
public default PaintStyle.FlipMode getFlipMode() Returns:PaintStyle.FlipMode the flip/mirroring/duplication mode

getImageData	back to summary
public InputStream getImageData() Returns:InputStream the raw image stream

getInsets

back to summary

public default Insets2D getInsets()

Specifies the portion of the blip or image that is used for the fill.

Each edge of the image is defined by a percentage offset from the edge of the bounding box. A positive percentage specifies an inset and a negative percentage specifies an outset.

The percentage are ints based on 100000, so 100% = 100000.

So, for example, a left offset of 25% specifies that the left edge of the image is located to the right of the bounding box's left edge by 25% of the bounding box's width.

Returns:Insets2D: the cropping insets of the source image

getOffset	back to summary
public default Point2D getOffset() Returns:Point2D the offset of the tiles in points or `null` if there's no offset

getScale	back to summary
public default Dimension2D getScale() Returns:Dimension2D the dimensions of the tiles in percent of the shape dimensions or `null` if no scaling is applied

getShape	back to summary
public Shape<S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> getShape() Returns:Shape<S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> the shape this texture paint is applied to

getStretch

back to summary

public default Insets2D getStretch()

The stretch specifies the edges of a fill rectangle.

Each edge of the fill rectangle is defined by a percentage offset from the corresponding edge of the picture's bounding box. A positive percentage specifies an inset and a negative percentage specifies an outset.

The percentage are ints based on 100000, so 100% = 100000.

Returns:Insets2D: the stretching in the destination image

isRotatedWithShape	back to summary
public default boolean isRotatedWithShape() Returns:boolean `true`, if the rotation of the shape is also applied to the texture paint