io.starter.formats.OOXML

Class ObjectChoice

java.lang.Object

io.starter.formats.OOXML.ObjectChoice

All Implemented Interfaces:

OOXMLElement, Serializable

public class ObjectChoice
extends Object
implements OOXMLElement

One of: cxnSp, graphicFrame, grpSp, pic, sp

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectChoice()
ObjectChoice(CxnSp c, GraphicFrame g, GrpSp grp, Pic p, Sp s)
ObjectChoice(ObjectChoice oc)

Method Summary

Modifier and Type	Method and Description
OOXMLElement	cloneElement()
String	getChartRId() return the rid of the chart element, if exists
String	getDescr() get cNvPr descr attribute
String	getEmbed() return the rid for the embedded object (picture or picture shape) (i.e.
int	getId() return the cNvPr id for this element
String	getLink() return the id for the linked picture (i.e.
String	getMacro() get macro attribute (valid for cnxSp, sp and graphicFrame)
String	getName() get cNvPr name attribute
Object	getObject() return the actual object associated with this ObjectChoice
String	getOOXML()
SpPr	getSppr() utility to return the shape properties element for this picture should be depreciated when OOXML is completely distinct from BIFF8
String	getURI() get the URI associated with this graphic Data
boolean	hasChart() return if this Object Choice element refers to a chart as opposed to a shape or image
boolean	hasImage() return if this Object Choice refers to an image rather than a chart or shape
boolean	hasShape() return if this Object Choice refers to a shape, as opposed a chart or an image
static OOXMLElement	parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Stack<String> lastTag, WorkBookHandle bk)
void	setChartRId(String rId) set the rid for this chart (resides within the file)
void	setDescr(String descr) set cNvPr description attribute sometimes associated with shape name
void	setEmbed(String embed) set the rid for this object (picture or picture shape) (resides within the file)
void	setId(int id) set the cNvPr id for this element
void	setLink(String link) set the link attribute for this blip (the id for the linked picture)
void	setMacro(String macro) set Macro attribute (valid for cnxSp, sp and graphicFrame) sometimes associated with shape name
void	setName(String name) set cNvPr name attribute
void	setObject(Object o) set the object associated with this ObjectChoice
void	setURI(String uri) set the URI associated with this graphic data

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectChoice

public ObjectChoice()

ObjectChoice

public ObjectChoice(CxnSp c,
                    GraphicFrame g,
                    GrpSp grp,
                    Pic p,
                    Sp s)

ObjectChoice

public ObjectChoice(ObjectChoice oc)

Method Detail

parseOOXML

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

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()

hasImage

public boolean hasImage()

return if this Object Choice refers to an image rather than a chart or shape

Returns:

hasShape

public boolean hasShape()

return if this Object Choice refers to a shape, as opposed a chart or an image

Returns:

hasChart

public boolean hasChart()

return if this Object Choice element refers to a chart as opposed to a shape or image

Returns:

getName

public String getName()

get cNvPr name attribute

Returns:

setName

public void setName(String name)

set cNvPr name attribute

Parameters:

name -

getDescr

public String getDescr()

get cNvPr descr attribute

Returns:

setDescr

public void setDescr(String descr)

set cNvPr description attribute sometimes associated with shape name

Parameters:

descr -

getMacro

public String getMacro()

get macro attribute (valid for cnxSp, sp and graphicFrame)

Returns:

setMacro

public void setMacro(String macro)

set Macro attribute (valid for cnxSp, sp and graphicFrame) sometimes associated with shape name

Parameters:

descr -

getURI

public String getURI()

get the URI associated with this graphic Data

setURI

public void setURI(String uri)

set the URI associated with this graphic data

Parameters:

uri -

getEmbed

public String getEmbed()

return the rid for the embedded object (picture or picture shape) (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 rid for this object (picture or picture shape) (resides within the file)

Parameters:

embed -

setChartRId

public void setChartRId(String rId)

set the rid for this chart (resides within the file)

Parameters:

rId -

setLink

public void setLink(String link)

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

Parameters:

link -

getChartRId

public String getChartRId()

return the rid of the chart element, if exists

Returns:

setId

public void setId(int id)

set the cNvPr id for this element

Parameters:

id -

getId

public int getId()

return the cNvPr id for this element

Returns:

getSppr

public SpPr getSppr()

utility to return the shape properties element for this picture should be depreciated when OOXML is completely distinct from BIFF8

Returns:

getObject

public Object getObject()

return the actual object associated with this ObjectChoice

Returns:

setObject

public void setObject(Object o)

set the object associated with this ObjectChoice

Parameters:

o -