io.starter.formats.OOXML

Class SpPr

java.lang.Object

io.starter.formats.OOXML.SpPr

All Implemented Interfaces:

OOXMLElement, Serializable

public class SpPr
extends Object
implements OOXMLElement

spPr This OOXML/DrawingML element specifies the visual shape properties that can be applied to a shape. These properties include the shape fill, outline, geometry, effects, and 3D orientation. parents: cxnSp, pic, sp children: blipFill (Picture Fill) §5.1.10.14 custGeom (Custom Geometry) §5.1.11.8 effectDag (Effect Container) §5.1.10.25 effectLst (Effect Container) §5.1.10.26 extLst (Extension List) §5.1.2.1.15 gradFill (Gradient Fill) §5.1.10.33 grpFill (Group Fill) §5.1.10.35 ln (Outline) §5.1.2.1.24 noFill (No Fill) §5.1.10.44 pattFill (Pattern Fill) §5.1.10.47 prstGeom (Preset geometry) §5.1.11.18 scene3d (3D Scene Properties) §5.1.4.1.26 solidFill (Solid Fill) §5.1.10.54 sp3d (Apply 3D shape properties) §5.1.7.12 xfrm (2D Transform)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpPr(SpPr clone)
SpPr(String ns)
SpPr(String ns, String solidfill, int w, String lnClr) create a default shape property with a solid fill and a line
SpPr(io.starter.formats.OOXML.Xfrm x, GeomGroup geom, FillGroup fill, Ln l, EffectPropsGroup effect, String bwMode, String ns)

Method Summary

Modifier and Type	Method and Description
OOXMLElement	cloneElement()
int	getColor() return the fill color
String	getEmbed() return the id for the embedded picture (i.e.
FillGroup	getFill() returns the fill of this shape property set, if any
int	getLineColor() returns the color of the line of this shape property, or -1 if no line is present
int	getLineStyle() returns the line style of the line of this shape property, or -1 if no line is present
int	getLineWidth() returns the width of the line of this shape proeprty, or -1 if no line is present
String	getLink() return the id for the linked picture (i.e.
Ln	getLn() returns the ln element of this shape property set, if any
String	getOOXML()
boolean	hasLine() return true if this shape properties contains a line
static OOXMLElement	parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk) parse shape OOXML element spPr
void	removeLine() remove the line, if any, for this shape property
void	setEmbed(String embed) set the embed attribute for this blip (the id for the embedded picture)
void	setLine(int w, String clr) add a line for this shape property
void	setLink(String link) set the link attribute for this blip (the id for the linked picture)
void	setNS(String ns) set the namespace for spPr element

Methods inherited from class java.lang.Object

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

Constructor Detail

SpPr

public SpPr(String ns)

SpPr

public SpPr(io.starter.formats.OOXML.Xfrm x,
            GeomGroup geom,
            FillGroup fill,
            Ln l,
            EffectPropsGroup effect,
            String bwMode,
            String ns)

SpPr

public SpPr(SpPr clone)

SpPr

public SpPr(String ns,
            String solidfill,
            int w,
            String lnClr)

create a default shape property with a solid fill and a line

Parameters:

solidfill -

w -

lnClr -

Method Detail

setNS

public void setNS(String ns)

set the namespace for spPr element

Parameters:

ns -

parseOOXML

public static OOXMLElement parseOOXML(org.xmlpull.v1.XmlPullParser xpp,
                                      Stack<String> lastTag,
                                      WorkBookHandle bk)

parse shape OOXML element spPr

Parameters:

xpp - XmlPullParser

lastTag - element stack

Returns:

spPr object

getOOXML

public String getOOXML()

Specified by:

getOOXML in interface OOXMLElement

See Also:

OOXMLElement.getOOXML()

cloneElement

public OOXMLElement cloneElement()

Specified by:

cloneElement in interface OOXMLElement

See Also:

OOXMLElement.cloneElement()

getEmbed

public String getEmbed()

return the id for the embedded picture (i.e. resides within the file)

Returns:

getLink

public String getLink()

return the id for the linked picture (i.e. doesn't reside in the file)

Returns:

setEmbed

public void setEmbed(String embed)

set the embed attribute for this blip (the id for the embedded picture)

Parameters:

embed -

setLink

public void setLink(String link)

set the link attribute for this blip (the id for the linked picture)

Parameters:

embed -

getLn

public Ln getLn()

returns the ln element of this shape property set, if any

Returns:

setLine

public void setLine(int w,
                    String clr)

add a line for this shape property

Parameters:

w - line width

clr - html color string

getLineWidth

public int getLineWidth()

returns the width of the line of this shape proeprty, or -1 if no line is present

Returns:

getLineColor

public int getLineColor()

returns the color of the line of this shape property, or -1 if no line is present

Returns:

getLineStyle

public int getLineStyle()

returns the line style of the line of this shape property, or -1 if no line is present

Returns:

getColor

public int getColor()

return the fill color

Returns:

getFill

public FillGroup getFill()

returns the fill of this shape property set, if any

Returns:

removeLine

public void removeLine()

remove the line, if any, for this shape property

hasLine

public boolean hasLine()

return true if this shape properties contains a line