Apache POI - Common 5.3.0 · org.apache.poi.sl.usermodel.SimpleShape

Method Summary

Modifier and Type	Method and Description
public Hyperlink<S, P>	Returns: the hyperlink assigned to this shape createHyperlink() Creates a hyperlink and asigns it to this shape.
public Color	Returns: solid fill color of null if not set or fill color is not solid (pattern or gradient) getFillColor() Returns the solid color fill.
public FillStyle	getFillStyle()
public CustomGeometry	getGeometry()
public Hyperlink<S, P>	Returns: the hyperlink assigned to this shape or `null` if not found. getHyperlink() Returns the hyperlink assigned to this shape
public LineDecoration	getLineDecoration()
public Placeholder	Returns: the placeholder or null if none is assigned getPlaceholder()
public PlaceholderDetails	Returns: an accessor for placeholder details getPlaceholderDetails()
public Shadow<S, P>	getShadow()
public ShapeType	getShapeType()
public StrokeStyle	getStrokeStyle()
public boolean	Returns: `true` if the shape is a placeholder isPlaceholder() Checks if the shape is a placeholder.
public void	setFillColor(Color the solid color fill. The value of `null` unsets the solid fill attribute from the underlying implementation color) Specifies a solid color fill.
public void	setPlaceholder(Placeholder the placeholder or null to remove the reference to the placeholder placeholder) Specifies that the corresponding shape should be represented by the generating application as a placeholder.
public void	setShapeType(ShapeType type)
public void	setStrokeStyle(Object... the line attributes styles) Sets the line attributes.

Method Detail

createHyperlink	back to summary
public Hyperlink<S, P> createHyperlink() Creates a hyperlink and asigns it to this shape. If the shape has already a hyperlink assigned, return it instead Returns:Hyperlink<S, P> the hyperlink assigned to this shape Since POI 3.14-Beta1

createHyperlink

back to summary

public Hyperlink<S, P> createHyperlink()

Creates a hyperlink and asigns it to this shape. If the shape has already a hyperlink assigned, return it instead

Returns:Hyperlink<S, P>: the hyperlink assigned to this shape
Since: POI 3.14-Beta1

getFillColor	back to summary
public Color getFillColor() Returns the solid color fill. Returns:Color solid fill color of null if not set or fill color is not solid (pattern or gradient)

getFillColor

back to summary

public Color getFillColor()

Returns the solid color fill.

Returns:Color: solid fill color of null if not set or fill color is not solid (pattern or gradient)

getFillStyle	back to summary
public FillStyle getFillStyle()

getGeometry	back to summary
public CustomGeometry getGeometry()

getHyperlink back to summary

getHyperlink	back to summary
public Hyperlink<S, P> getHyperlink() Returns the hyperlink assigned to this shape Returns:Hyperlink<S, P> the hyperlink assigned to this shape or `null` if not found. Since POI 3.14-Beta1

public Hyperlink<S, P> getHyperlink()

Returns the hyperlink assigned to this shape

Returns:Hyperlink<S, P>: the hyperlink assigned to this shape or null if not found.
Since: POI 3.14-Beta1

getLineDecoration	back to summary
public LineDecoration getLineDecoration()

getPlaceholder	back to summary
public Placeholder getPlaceholder() Returns:Placeholder the placeholder or null if none is assigned See Also `setPlaceholder(Placeholder)`

getPlaceholderDetails	back to summary
public PlaceholderDetails getPlaceholderDetails() Returns:PlaceholderDetails an accessor for placeholder details Since POI 4.0.0

getShadow	back to summary
public Shadow<S, P> getShadow()

getShapeType	back to summary
public ShapeType getShapeType()

getStrokeStyle	back to summary
public StrokeStyle getStrokeStyle()

isPlaceholder back to summary

isPlaceholder	back to summary
public boolean isPlaceholder() Checks if the shape is a placeholder. (placeholders aren't normal shapes, they are visible only in the Edit Master mode) Returns:boolean `true` if the shape is a placeholder Since POI 4.0.0

public boolean isPlaceholder()

Checks if the shape is a placeholder. (placeholders aren't normal shapes, they are visible only in the Edit Master mode)

Returns:boolean: true if the shape is a placeholder
Since: POI 4.0.0

setFillColor back to summary

setFillColor	back to summary
public void setFillColor(Color color) Specifies a solid color fill. The shape is filled entirely with the specified color. Parameters color:Color the solid color fill. The value of `null` unsets the solid fill attribute from the underlying implementation

public void setFillColor(Color color)

Specifies a solid color fill. The shape is filled entirely with the specified color.

Parameters

color:Color: the solid color fill. The value of null unsets the solid fill attribute from the underlying implementation

setPlaceholder	back to summary
public void setPlaceholder(Placeholder placeholder) Specifies that the corresponding shape should be represented by the generating application as a placeholder. When a shape is considered a placeholder by the generating application it can have special properties to alert the user that they may enter content into the shape. Parameters placeholder:Placeholder the placeholder or null to remove the reference to the placeholder

setPlaceholder

back to summary

public void setPlaceholder(Placeholder placeholder)

Specifies that the corresponding shape should be represented by the generating application as a placeholder. When a shape is considered a placeholder by the generating application it can have special properties to alert the user that they may enter content into the shape.

Parameters

placeholder:Placeholder: the placeholder or null to remove the reference to the placeholder

setShapeType	back to summary
public void setShapeType(ShapeType type)

setStrokeStyle	back to summary
public void setStrokeStyle(Object... styles) Sets the line attributes. Possible attributes are Double (width), LineCap, LineDash, LineCompound, Color (implementations of PaintStyle aren't yet supported ...) If no styles are given, the line will be hidden Parameters styles:Object[] the line attributes

setStrokeStyle

back to summary

public void setStrokeStyle(Object... styles)

Sets the line attributes. Possible attributes are Double (width), LineCap, LineDash, LineCompound, Color (implementations of PaintStyle aren't yet supported ...) If no styles are given, the line will be hidden

Parameters

styles:Object[]: the line attributes

public Interface SimpleShape<S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>>

Method Summary

Method Detail