org.zkoss.poi.xssf.model

Class ExternalLink

java.lang.Object

org.zkoss.poi.POIXMLDocumentPart

org.zkoss.poi.xssf.model.ExternalLink

public class ExternalLink
extends POIXMLDocumentPart

Table of styles shared across all sheets in a workbook.

Author:

Henri Chen (henrichen at zkoss dot org) - [book1.xlsx]Sheet1:Sheet3!xxx external reference

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIRST_CUSTOM_STYLE_ID The first style id available for use as a custom style

Fields inherited from class org.zkoss.poi.POIXMLDocumentPart

DEFAULT_XML_OPTIONS

Constructor Summary

Constructors

Constructor and Description
ExternalLink() Create a new, empty StylesTable
ExternalLink(PackagePart part, PackageRelationship rel)

Method Summary

Modifier and Type	Method and Description
protected void	commit() Save the content in the underlying package part.
java.lang.String	getBookName()
java.lang.String	getLinkIndex()
protected void	readFrom(java.io.InputStream is) Read this shared external links from an XML file.
void	setBookName(java.lang.String bookname)
void	setLinkIndex(java.lang.String index)
void	writeTo(java.io.OutputStream out) Write this external link out as XML.

Methods inherited from class org.zkoss.poi.POIXMLDocumentPart

addRelation, clearMemoryPackagePart, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationCounter, getRelationId, getRelations, getTargetPart, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, read, rebase, removeRelation, removeRelation, toString

Methods inherited from class java.lang.Object

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

Field Detail

FIRST_CUSTOM_STYLE_ID

public static final int FIRST_CUSTOM_STYLE_ID

The first style id available for use as a custom style

See Also:

Constant Field Values

Constructor Detail

ExternalLink

public ExternalLink()

Create a new, empty StylesTable

ExternalLink

public ExternalLink(PackagePart part,
                    PackageRelationship rel)
             throws java.io.IOException

Throws:

java.io.IOException

Method Detail

readFrom

protected void readFrom(java.io.InputStream is)
                 throws java.io.IOException

Read this shared external links from an XML file.

Parameters:

is - The input stream containing the XML document.

Throws:

java.io.IOException - if an error occurs while reading.

getBookName

public java.lang.String getBookName()

setBookName

public void setBookName(java.lang.String bookname)

getLinkIndex

public java.lang.String getLinkIndex()

setLinkIndex

public void setLinkIndex(java.lang.String index)

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Write this external link out as XML.

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - if an error occurs while writing.

commit

protected void commit()
               throws java.io.IOException

Description copied from class: POIXMLDocumentPart

Save the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified. Sub-classes should override and add logic to marshal the "model" into Ooxml4J. For example, the code saving a generic XML entry may look as follows:

 protected void commit() throws IOException {
   PackagePart part = getPackagePart();
   OutputStream out = part.getOutputStream();
   XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
   bean.save(out, DEFAULT_XML_OPTIONS);
   out.close();
 }
  

Overrides:

commit in class POIXMLDocumentPart

Throws:

java.io.IOException