io.starter.formats.OOXML

Class TwoCellAnchor

java.lang.Object

io.starter.formats.OOXML.TwoCellAnchor

All Implemented Interfaces:

OOXMLElement, Serializable

public class TwoCellAnchor
extends Object
implements OOXMLElement

twoCellAnchor (Two Cell Anchor Shape Size) This element specifies a two cell anchor placeholder for a group, a shape, or a drawing element. It moves with cells and its extents are in EMU units. This is the root element for charts, images and shapes. parent: wsDr children: from, to, OBJECTCHOICES (sp, grpSp, graphicFrame, cxnSp, pic), clientData

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static short	EMU

Constructor Summary

Constructors

Constructor and Description
TwoCellAnchor(String editAs)
TwoCellAnchor(String editAs, io.starter.formats.OOXML.From f, io.starter.formats.OOXML.To t, ObjectChoice o)
TwoCellAnchor(TwoCellAnchor tce)

Method Summary

Modifier and Type	Method and Description
OOXMLElement	cloneElement()
static int[]	convertBoundsFromBIFF8(Boundsheet sheet, short[] bbounds) given bounds[8] in BIFF 8 coordinates and convert to OOXML units mostly this means adjusting ROWOFFSET 0 & 1 (bounds[5] & bounds[7] and COLOFFSET 0 & 1 (bounds[1] & bounds[5] to EMU units + adjust according to emperical calc garnered from observation
static short[]	convertBoundsToBIFF8(Boundsheet sheet, int[] bounds) convert bounds[8] from OOXML to BIFF8 Units basically must adjust COLOFFSETs and ROWOFFSETs to BIFF8 units
int[]	getBounds() return the (to, from) bounds of this object by concatenating the bounds for the to and the from bounds represent: COL, COLOFFSET, ROW, ROWOFFST, COL1, COLOFFSET1, ROW1, ROWOFFSET1
String	getChartRId() return the rid for the chart defined by this twocellanchor
String	getDescr() get cNvPr descr attribute
String	getEditAs() return the editAs editMovement attribute
String	getEmbed() return the id for the embedded picture or shape (i.e.
String	getEmbedFilename() return the Embedded Object's filename as saved on disk
String	getLink() return the id for the linked object (i.e.
String	getMacro() get macro attribute
String	getName() get cNvPr name attribute
String	getOOXML()
SpPr	getSppr() utility to return the shape properties element (picture element only) 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 twoCellAnchor element refers to a chart as opposed to a shape or image
boolean	hasImage() return if this twoCellAnchor element refers to an image rather than a chart or shape
boolean	hasShape() return if this twoCellAnchor element 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	setAsChart(int rid, String name, int[] bounds) set this twoCellAnchor as a chart element used for
void	setAsImage(int rid, String name, String descr, int spid, SpPr sp) set this twoCellAnchor as an image
void	setBounds(int[] bounds) set the (to, from) bounds of this object bounds represent: COL, COLOFFSET, ROW, ROWOFFST, COL1, COLOFFSET1, ROW1, ROWOFFSET1 NOTE: COL
void	setChartRId(String rId)
void	setDescr(String descr) set cNvPr descr attribute sometimes associated with shape name
void	setEditAs(String editAs) set the editAs editMovement attribute
void	setEmbed(String embed) set the embed for the embedded picture or shape (i.e.
void	setEmbedFilename(String embedFile) set the Embedded Object's filename as saved on disk
void	setLink(String link) set the link attribute for this blip (the id for the linked picture)
void	setMacro(String macro) set Macro attribute sometimes associated with shape name
void	setName(String name) set cNvPr name attribute
void	setURI(String uri) set the URI associated with this graphic data
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMU

public static final short EMU

See Also:

Constant Field Values

Constructor Detail

TwoCellAnchor

public TwoCellAnchor(String editAs)

TwoCellAnchor

public TwoCellAnchor(String editAs,
                     io.starter.formats.OOXML.From f,
                     io.starter.formats.OOXML.To t,
                     ObjectChoice o)

TwoCellAnchor

public TwoCellAnchor(TwoCellAnchor tce)

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

getBounds

public int[] getBounds()

return the (to, from) bounds of this object by concatenating the bounds for the to and the from bounds represent: COL, COLOFFSET, ROW, ROWOFFST, COL1, COLOFFSET1, ROW1, ROWOFFSET1

Returns:

bounds short[8] from [4] and to [4]

setBounds

public void setBounds(int[] bounds)

set the (to, from) bounds of this object bounds represent: COL, COLOFFSET, ROW, ROWOFFST, COL1, COLOFFSET1, ROW1, ROWOFFSET1 NOTE: COL

Parameters:

bounds - int[8] from [4] and to [4]

getName

public String getName()

get cNvPr name attribute

Returns:

toString

public String toString()

Overrides:

toString in class Object

hasImage

public boolean hasImage()

return if this twoCellAnchor element refers to an image rather than a chart or shape

Returns:

hasChart

public boolean hasChart()

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

Returns:

hasShape

public boolean hasShape()

return if this twoCellAnchor element refers to a shape, as opposed a chart or an image

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 descr attribute sometimes associated with shape name

Parameters:

descr -

getMacro

public String getMacro()

get macro attribute

Returns:

setMacro

public void setMacro(String macro)

set Macro attribute 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 -

getChartRId

public String getChartRId()

return the rid for the chart defined by this twocellanchor

Returns:

setChartRId

public void setChartRId(String rId)

getEmbed

public String getEmbed()

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

Returns:

setEmbed

public void setEmbed(String embed)

set the embed for the embedded picture or shape (i.e. resides within the file)

Parameters:

embed -

getEmbedFilename

public String getEmbedFilename()

return the Embedded Object's filename as saved on disk

Returns:

setEmbedFilename

public void setEmbedFilename(String embedFile)

set the Embedded Object's filename as saved on disk

Parameters:

embed -

getLink

public String getLink()

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

Returns:

setLink

public void setLink(String link)

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

Parameters:

embed -

getEditAs

public String getEditAs()

return the editAs editMovement attribute

Returns:

setEditAs

public void setEditAs(String editAs)

set the editAs editMovement attribute

getSppr

public SpPr getSppr()

utility to return the shape properties element (picture element only) should be depreciated when OOXML is completely distinct from BIFF8

Returns:

setAsChart

public void setAsChart(int rid,
                       String name,
                       int[] bounds)

set this twoCellAnchor as a chart element used for

Parameters:

rid -

name -

bounds -

setAsImage

public void setAsImage(int rid,
                       String name,
                       String descr,
                       int spid,
                       SpPr sp)

set this twoCellAnchor as an image

Parameters:

rid -

name -

id -

convertBoundsFromBIFF8

public static int[] convertBoundsFromBIFF8(Boundsheet sheet,
                                           short[] bbounds)

given bounds[8] in BIFF 8 coordinates and convert to OOXML units mostly this means adjusting ROWOFFSET 0 & 1 (bounds[5] & bounds[7] and COLOFFSET 0 & 1 (bounds[1] & bounds[5] to EMU units + adjust according to emperical calc garnered from observation

Parameters:

sheet -

bbounds - short[] bounds in BIFF8 units

Returns:

new bounds int[] bounds in OOXML units

convertBoundsToBIFF8

public static short[] convertBoundsToBIFF8(Boundsheet sheet,
                                           int[] bounds)

convert bounds[8] from OOXML to BIFF8 Units basically must adjust COLOFFSETs and ROWOFFSETs to BIFF8 units

Parameters:

sheet -

bounds - int[]

Returns:

bounds short[] (BIFF8 uses short[] + different units)