public class XmlContext
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
static int |
LatestFormat
Specifies the latest file format revision number.
|
| Constructor and Description |
|---|
XmlContext(Workbook workbook,
int version)
Initializes a new instance of the
XmlContext class. |
| Modifier and Type | Method and Description |
|---|---|
org.w3c.dom.Element |
addChildElement(java.lang.String elementName,
org.w3c.dom.Node parentNode)
Adds a new child node with the specified name to the specified parent node.
|
org.w3c.dom.Element |
addChildElement(java.lang.String elementName,
org.w3c.dom.Node parentNode,
java.lang.String innerText)
Adds a new child node with the specified name and value to the specified parent node.
|
static org.w3c.dom.Element |
element(org.w3c.dom.Document parent,
java.lang.String name) |
static org.w3c.dom.Element |
element(org.w3c.dom.Element parent,
java.lang.String name) |
static java.util.List<org.w3c.dom.Element> |
elements(org.w3c.dom.Element parent,
java.lang.String name) |
int |
getVersion()
Gets the format revision number for the file being currently serialized.
|
static boolean |
isEmpty(org.w3c.dom.Element element) |
Worksheet |
loadWorksheet(org.w3c.dom.Element worksheetElement)
Reads a worksheet from the specified XML element.
|
boolean |
readBool(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a boolean value with the specified name.
|
boolean |
readBool(java.lang.String elementName,
org.w3c.dom.Element parentElement,
boolean defaultValue)
Reads a boolean value with the specified name.
|
java.lang.Boolean |
readBoolAttribute(java.lang.String name,
org.w3c.dom.Element element) |
Brush |
readBrush(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a
Brush object with the specified name. |
Brush |
readBrush(java.lang.String elementName,
org.w3c.dom.Element parentElement,
Brush defaultValue)
Reads a
Brush object with the specified name. |
long |
readByte(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a byte value with the specified name.
|
char |
readChar(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a char value with the specified name.
|
java.awt.Color |
readColor(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a Color value from the element with the specified name.
|
java.awt.Color[] |
readColorArray(java.lang.String elementName,
java.lang.String subElementName,
org.w3c.dom.Element parentElement)
Reads a color array with the specified name.
|
java.lang.Object |
readColumnTag(Column column,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads the tag for the specified column.
|
java.math.BigDecimal |
readDecimal(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a decimal value with the specified name.
|
double |
readDouble(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a double value with the specified name.
|
java.lang.Integer |
readEnum(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads an enumeration object from the element with the specified name.
|
float |
readFloat(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a float value with the specified name.
|
float |
readFloat(java.lang.String elementName,
org.w3c.dom.Element parentElement,
float defaultValue)
Reads a float value with the specified name.
|
float[] |
readFloatArray(java.lang.String elementName,
java.lang.String subElementName,
org.w3c.dom.Element parentElement)
Reads a float array with the specified name.
|
java.awt.Image |
readImage(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads an Image object with the specified name.
|
int |
readInt(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads an integer value with the specified name.
|
int |
readInt(java.lang.String elementName,
org.w3c.dom.Element parentElement,
int defaultValue)
Reads an integer value with the specified name.
|
long |
readLong(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a long value with the specified name.
|
Measure |
readMeasure(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a
Measure value from the element with the specified name. |
java.lang.Object |
readObject(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads an object with the specified name.
|
java.awt.geom.Point2D |
readPointF(org.w3c.dom.Element element)
Reads a
Point2D object from the specified element. |
java.awt.geom.Point2D |
readPointF(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a
Point2D object with the specified name. |
java.awt.Rectangle |
readRectangle(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a Rectangle value from the element with the specified name.
|
java.lang.Object |
readRowTag(Row row,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads the tag for the specified row.
|
byte |
readSByte(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a 8-bit signed integer value with the specified name.
|
short |
readShort(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a short value with the specified name.
|
short |
readShort(java.lang.String elementName,
org.w3c.dom.Element parentElement,
short defaultValue)
Reads a short value with the specified name.
|
java.lang.String |
readString(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads a string value with the specified name.
|
java.lang.String |
readString(java.lang.String elementName,
org.w3c.dom.Element parentElement,
java.lang.String defaultValue)
Reads a string value with the specified name.
|
java.lang.String |
readStringAttribute(java.lang.String name,
org.w3c.dom.Element element) |
java.lang.Object |
readTag(Worksheet worksheet,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Reads the tag for the specified worksheet.
|
void |
saveWorksheet(Worksheet worksheet,
org.w3c.dom.Element worksheetElement)
Saves the specified worksheet to the specified XML element.
|
org.w3c.dom.Element |
writeBool(boolean boolValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes a boolean value with the specified name.
|
org.w3c.dom.Element |
writeBrush(Brush brush,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes a reference to the specified brush.
|
org.w3c.dom.Element |
writeByte(long byteValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Write a byte value with the specified name.
|
org.w3c.dom.Element |
writeChar(char charValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Write a char value with the specified name.
|
org.w3c.dom.Element |
writeColor(java.awt.Color color,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes the specified Color object as an XML element with the specified name and the specified parent.
|
org.w3c.dom.Element |
writeColorArray(java.awt.Color[] array,
java.lang.String elementName,
java.lang.String subElementName,
org.w3c.dom.Element parentElement)
Writes the specified array.
|
org.w3c.dom.Element |
writeColumnTag(Column column,
java.lang.Object tag,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes the specified tag of the specified column.
|
org.w3c.dom.Element |
writeDashStyle(DashStyle value,
java.lang.String elementName,
org.w3c.dom.Element parentElement) |
org.w3c.dom.Element |
writeDecimal(java.math.BigDecimal decimalValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Write a decimal value with the specified name.
|
org.w3c.dom.Element |
writeDouble(double doubleValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes a double value with the specified name.
|
org.w3c.dom.Element |
writeEnum(java.lang.Enum<?> value,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes the specified Enumeration as an XML element with the specified name and the specified parent.
|
org.w3c.dom.Element |
writeFloat(float floatValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes a float value with the specified name.
|
org.w3c.dom.Element |
writeFloatArray(float[] array,
java.lang.String elementName,
java.lang.String subElementName,
org.w3c.dom.Element parentElement)
Writes the specified array.
|
void |
writeFloatAttribute(float value,
java.lang.String name,
org.w3c.dom.Element element)
Writes a float value with the specified name.
|
org.w3c.dom.Element |
writeImage(java.awt.Image image,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes a reference to the specified image.
|
org.w3c.dom.Element |
writeInt(int intValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes an integer value with the specified name.
|
org.w3c.dom.Element |
writeLong(long longValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes a long value with the specified name.
|
org.w3c.dom.Element |
writeMeasure(Measure measure,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes the specified
Measure object as an XML element with the
specified name and the specified parent. |
org.w3c.dom.Element |
writeObject(java.lang.Object objectValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes the specified object under the specified name.
|
org.w3c.dom.Element |
writePointF(float x,
float y,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes the specified
Point2D under the specified name. |
org.w3c.dom.Element |
writePointF(java.awt.geom.Point2D point,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes a
Point2D with the specified name. |
org.w3c.dom.Element |
writeRectangle(java.awt.Rectangle rect,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes the specified Rectangle object as an XML element with the specified name and the specified parent.
|
org.w3c.dom.Element |
writeRowTag(Row row,
java.lang.Object tag,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes the specified tag of the specified row.
|
org.w3c.dom.Element |
writeSByte(byte byteValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Write a 8-bit signed integer value with the specified name.
|
org.w3c.dom.Element |
writeShort(short shortValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes a short value with the specified name.
|
org.w3c.dom.Element |
writeString(java.lang.String value,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes a string value with the specified name.
|
org.w3c.dom.Element |
writeTag(Worksheet worksheet,
java.lang.Object tag,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes the specified tag of the specified worksheet.
|
org.w3c.dom.Element |
writeUInt(long uintValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes an unsigned integer value with the specified name.
|
org.w3c.dom.Element |
writeULong(long ulongValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes an unsigned long value with the specified name.
|
org.w3c.dom.Element |
writeUShort(short ushortValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Writes an unsigned short value with the specified name.
|
public static int LatestFormat
public XmlContext(Workbook workbook, int version)
XmlContext class.workbook - The Workbook that will be serialized or deserialized.document - The associated XML document.version - The file version.public void saveWorksheet(Worksheet worksheet, org.w3c.dom.Element worksheetElement)
public Worksheet loadWorksheet(org.w3c.dom.Element worksheetElement)
public static org.w3c.dom.Element element(org.w3c.dom.Element parent,
java.lang.String name)
public static org.w3c.dom.Element element(org.w3c.dom.Document parent,
java.lang.String name)
public static java.util.List<org.w3c.dom.Element> elements(org.w3c.dom.Element parent,
java.lang.String name)
public static boolean isEmpty(org.w3c.dom.Element element)
public Brush readBrush(java.lang.String elementName, org.w3c.dom.Element parentElement)
Brush object with the specified name.public Brush readBrush(java.lang.String elementName, org.w3c.dom.Element parentElement, Brush defaultValue)
Brush object with the specified name.public java.awt.Color readColor(java.lang.String elementName,
org.w3c.dom.Element parentElement)
elementName - A string that identifies the element to read.parentElement - An instance of the Element class that specifies the parent element.Colors.Black if reading has failed.public java.awt.Rectangle readRectangle(java.lang.String elementName,
org.w3c.dom.Element parentElement)
elementName - A string that identifies the element to read.parentElement - An instance of the Element class that specifies the parent element.public Measure readMeasure(java.lang.String elementName, org.w3c.dom.Element parentElement)
Measure value from the element with the specified name.public java.lang.Integer readEnum(java.lang.String elementName,
org.w3c.dom.Element parentElement)
elementName - A string that identifies the element to read.parentElement - An instance of the Element class that specifies the parent element.public java.lang.String readString(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public java.lang.String readString(java.lang.String elementName,
org.w3c.dom.Element parentElement,
java.lang.String defaultValue)
public java.lang.String readStringAttribute(java.lang.String name,
org.w3c.dom.Element element)
public boolean readBool(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public boolean readBool(java.lang.String elementName,
org.w3c.dom.Element parentElement,
boolean defaultValue)
public java.lang.Boolean readBoolAttribute(java.lang.String name,
org.w3c.dom.Element element)
public int readInt(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public int readInt(java.lang.String elementName,
org.w3c.dom.Element parentElement,
int defaultValue)
public short readShort(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public short readShort(java.lang.String elementName,
org.w3c.dom.Element parentElement,
short defaultValue)
public long readLong(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public long readByte(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public byte readSByte(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public char readChar(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public float readFloat(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public float readFloat(java.lang.String elementName,
org.w3c.dom.Element parentElement,
float defaultValue)
public double readDouble(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public java.math.BigDecimal readDecimal(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public float[] readFloatArray(java.lang.String elementName,
java.lang.String subElementName,
org.w3c.dom.Element parentElement)
public java.awt.geom.Point2D readPointF(java.lang.String elementName,
org.w3c.dom.Element parentElement)
Point2D object with the specified name.public java.awt.geom.Point2D readPointF(org.w3c.dom.Element element)
Point2D object from the specified element.public java.awt.Color[] readColorArray(java.lang.String elementName,
java.lang.String subElementName,
org.w3c.dom.Element parentElement)
public java.awt.Image readImage(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public java.lang.Object readObject(java.lang.String elementName,
org.w3c.dom.Element parentElement)
public java.lang.Object readTag(Worksheet worksheet, java.lang.String elementName, org.w3c.dom.Element parentElement)
Tags are read similarly to arbitrary objects except that the client is given a chance to perform custom deserialization through event handling.
public java.lang.Object readColumnTag(Column column, java.lang.String elementName, org.w3c.dom.Element parentElement)
Tags are read similarly to arbitrary objects except that the client is given a chance to perform custom deserialization through event handling.
public java.lang.Object readRowTag(Row row, java.lang.String elementName, org.w3c.dom.Element parentElement)
Tags are read similarly to arbitrary objects except that the client is given a chance to perform custom deserialization through event handling.
public org.w3c.dom.Element writeTag(Worksheet worksheet, java.lang.Object tag, java.lang.String elementName, org.w3c.dom.Element parentElement)
Tags are written similarly to arbitrary objects except that the client is given a chance to perform custom serialization through event handling.
public org.w3c.dom.Element writeColumnTag(Column column, java.lang.Object tag, java.lang.String elementName, org.w3c.dom.Element parentElement)
Tags are written similarly to arbitrary objects except that the client is given a chance to perform custom serialization through event handling.
public org.w3c.dom.Element writeRowTag(Row row, java.lang.Object tag, java.lang.String elementName, org.w3c.dom.Element parentElement)
Tags are written similarly to arbitrary objects except that the client is given a chance to perform custom serialization through event handling.
public org.w3c.dom.Element writeMeasure(Measure measure, java.lang.String elementName, org.w3c.dom.Element parentElement)
Measure object as an XML element with the
specified name and the specified parent.measure - The Measure object to write.elementName - The name of the new XML element.parentElement - The parent of the new XML element.public org.w3c.dom.Element writeBrush(Brush brush, java.lang.String elementName, org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeImage(java.awt.Image image,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeColor(java.awt.Color color,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
color - The Color object to write.elementName - The name of the new XML element.parentElement - The parent of the new XML element.public org.w3c.dom.Element writePointF(java.awt.geom.Point2D point,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Point2D with the specified name.public org.w3c.dom.Element writePointF(float x,
float y,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
Point2D under the specified name. The x and
y components of the point are written as attributes.public org.w3c.dom.Element writeRectangle(java.awt.Rectangle rect,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
rect - The Rectangle object to write.elementName - The name of the new XML element.parentElement - The parent of the new XML element.public org.w3c.dom.Element writeEnum(java.lang.Enum<?> value,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
value - The Enumeration to write.elementName - The name of the new XML element.parentElement - The parent of the new XML element.public org.w3c.dom.Element writeDashStyle(DashStyle value, java.lang.String elementName, org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeString(java.lang.String value,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeBool(boolean boolValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeInt(int intValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeShort(short shortValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeLong(long longValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeByte(long byteValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeSByte(byte byteValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeDouble(double doubleValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeUInt(long uintValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeUShort(short ushortValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeULong(long ulongValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeChar(char charValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeDecimal(java.math.BigDecimal decimalValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeFloat(float floatValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public void writeFloatAttribute(float value,
java.lang.String name,
org.w3c.dom.Element element)
public org.w3c.dom.Element writeFloatArray(float[] array,
java.lang.String elementName,
java.lang.String subElementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeColorArray(java.awt.Color[] array,
java.lang.String elementName,
java.lang.String subElementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element writeObject(java.lang.Object objectValue,
java.lang.String elementName,
org.w3c.dom.Element parentElement)
public org.w3c.dom.Element addChildElement(java.lang.String elementName,
org.w3c.dom.Node parentNode)
public org.w3c.dom.Element addChildElement(java.lang.String elementName,
org.w3c.dom.Node parentNode,
java.lang.String innerText)
public int getVersion()